com.screenscraper.common

Class HTTPParameter

java.lang.Object

com.screenscraper.common.HTTPParameter

public class HTTPParameter
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.
static java.lang.String	TYPE_COOKIE
static java.lang.String	TYPE_FILE
static java.lang.String	TYPE_GET The possible parameter types.
static java.lang.String	TYPE_HEADER
static java.lang.String	TYPE_POST

Constructor Summary

Constructors

Constructor and Description
HTTPParameter() Required by castor.
HTTPParameter(HTTPParameter httpParameter) Generates a new HTTP parameter as a clone of the given parameter.
HTTPParameter(int scrapeableFileID, java.lang.String key, java.lang.String value, int sequence, java.lang.String type) Generates a new HTTP parameter with all of its information.
HTTPParameter(java.lang.String key, java.lang.String value, int sequence) Generates a new HTTP parameter.
HTTPParameter(java.lang.String key, java.lang.String value, int sequence, java.lang.String type) Generates a new HTTP parameter with most of its information.

Method Summary

Modifier and Type	Method and Description
void	dumpToLog() Dumps the parameter to the log.
boolean	equals(java.lang.Object obj) Override equals.
int	getID() Gets the ID of the HTTP parameter.
java.lang.String	getKey() Gets the key portion of the parameter.
int	getScrapeableFileID() Gets the ID of the HTTP parameter.
int	getSequence() Gets the sequence with which the parameter should be sent.
java.lang.String	getType() Gets the type of the parameter, as defined by one of the constants in this class.
java.lang.String	getValue() Gets the value portion of the parameter.
java.lang.String	getValueShort() Gets the value, potentially truncating it if it's too long.
void	save() Saves the HTTP parameter to the database.
void	setID(int httpParameterID) Sets the ID of the HTTP parameter.
void	setKey(java.lang.String key) Sets the key portion of the parameter.
void	setScrapeableFileID(int scrapeableFileID) Sets the scrapeable file ID of the scrapeable file associated with thi HTTP parameter.
void	setSequence(int sequence) Sets the sequence with which the parameter should be sent.
void	setType(java.lang.String type) Sets the type of the parameter, as defined by one of the constants in this class.
void	setValue(java.lang.String value) Sets the value portion of the parameter.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

TYPE_GET

public static final java.lang.String TYPE_GET

The possible parameter types.

See Also:

Constant Field Values

TYPE_POST

public static final java.lang.String TYPE_POST

See Also:

Constant Field Values

TYPE_FILE

public static final java.lang.String TYPE_FILE

See Also:

Constant Field Values

TYPE_COOKIE

public static final java.lang.String TYPE_COOKIE

See Also:

Constant Field Values

TYPE_HEADER

public static final java.lang.String TYPE_HEADER

See Also:

Constant Field Values

Constructor Detail

HTTPParameter

public HTTPParameter()

Required by castor.

HTTPParameter

public HTTPParameter(@NotNull
                     HTTPParameter httpParameter)

Generates a new HTTP parameter as a clone of the given parameter.

Parameters:

httpParameter - The HTTP parameter to clone.

HTTPParameter

public HTTPParameter(java.lang.String key,
                     java.lang.String value,
                     int sequence)

Generates a new HTTP parameter.

Parameters:

key - The key portion of the parameter.

value - The value portion of the parameter.

sequence - The sequence with which the parameter should be sent.

HTTPParameter

public HTTPParameter(java.lang.String key,
                     java.lang.String value,
                     int sequence,
                     java.lang.String type)

Generates a new HTTP parameter with most of its information.

Parameters:

key - The key portion of the parameter.

value - The value portion of the parameter.

sequence - The sequence with which the parameter should be sent.

type - The type of the parameter.

HTTPParameter

public HTTPParameter(int scrapeableFileID,
                     java.lang.String key,
                     java.lang.String value,
                     int sequence,
                     java.lang.String type)

Generates a new HTTP parameter with all of its information.

Parameters:

scrapeableFileID - The ID of the scrapeable file associated with this parameter.

key - The key portion of the parameter.

value - The value portion of the parameter.

sequence - The sequence with which the parameter should be sent.

type - The type of the parameter.

Method Detail

setID

public void setID(int httpParameterID)

Sets the ID of the HTTP parameter.

getID

public int getID()

Gets the ID of the HTTP parameter.

setScrapeableFileID

public void setScrapeableFileID(int scrapeableFileID)

Sets the scrapeable file ID of the scrapeable file associated with thi HTTP parameter.

getScrapeableFileID

public int getScrapeableFileID()

Gets the ID of the HTTP parameter.

getKey

@Nullable
public java.lang.String getKey()

Gets the key portion of the parameter.

Returns:

The key.

setKey

public void setKey(java.lang.String key)

Sets the key portion of the parameter.

Parameters:

key - The key.

getValue

@Nullable
public java.lang.String getValue()

Gets the value portion of the parameter.

Returns:

The value.

getValueShort

@Nullable
public java.lang.String getValueShort()

Gets the value, potentially truncating it if it's too long.

Returns:

The value.

setValue

public void setValue(java.lang.String value)

Sets the value portion of the parameter.

Parameters:

value - The value.

getSequence

public int getSequence()

Gets the sequence with which the parameter should be sent.

Returns:

The sequence.

setSequence

public void setSequence(int sequence)

Sets the sequence with which the parameter should be sent.

Parameters:

sequence - The sequence.

getType

public java.lang.String getType()

Gets the type of the parameter, as defined by one of the constants in this class.

Returns:

The type.

setType

public void setType(java.lang.String type)

Sets the type of the parameter, as defined by one of the constants in this class.

Parameters:

type - The type.

save

public void save()

Saves the HTTP parameter to the database.

equals

public boolean equals(java.lang.Object obj)

Override equals.

Overrides:

equals in class java.lang.Object

dumpToLog

public void dumpToLog()

Dumps the parameter to the log.