com.asprise.imaging.core

Class RequestOutputItem.UploadSetting

java.lang.Object

com.asprise.imaging.core.RequestOutputItem.UploadSetting

All Implemented Interfaces:

java.lang.Cloneable

Enclosing class:

RequestOutputItem

public static class RequestOutputItem.UploadSetting
extends java.lang.Object
implements java.lang.Cloneable

Upload settings. url is the only mandatory parameter.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_OPERATION_TIME
static int	DEFAULT_MAX_RETRIES
static java.lang.String	DEFAULT_POST_FILE_FIELD_NAME

Constructor Summary

Constructors

Constructor and Description
UploadSetting()
UploadSetting(java.lang.String url) Constructor

Method Summary

Modifier and Type	Method and Description
RequestOutputItem.UploadSetting	addHeaders(java.lang.String header) e.g., "Referer: http://asprise.com"
RequestOutputItem.UploadSetting	addPostField(java.lang.String name, java.lang.String value) Any additional post fields
RequestOutputItem.UploadSetting	addPostFiles(java.lang.String postFile) Additional files to be posted along
java.lang.Object	clone()
static RequestOutputItem.UploadSetting	fromJsonMap(java.util.Map json)
java.lang.String	getAuth() Authentication, e.g., "user:pass"
java.lang.String	getCookies() e.g., "name=Asprise; domain=asprise.com"
java.util.List<java.lang.String>	getHeaders() e.g., "Referer: http://asprise.com"
java.lang.String	getLogToFile() Log file to record HTTP operations.
int	getMaxOperationTime() Max HTTP operation time in seconds; default: 1200 (20 mins).
int	getMaxRetries() Max number of retries.
java.util.Map<java.lang.String,java.lang.String>	getPostFields() Any additional post fields
java.lang.String	getPostFileFieldName() Field name for files.
java.util.List<java.lang.String>	getPostFiles() Additional files to be posted along
java.io.File	getSaveResponseToFile() Saves response to the given file instead of returning response.
java.lang.String	getUrl() Target URL
RequestOutputItem.UploadSetting	setAuth(java.lang.String auth) Authentication, e.g., "user:pass"
RequestOutputItem.UploadSetting	setCookies(java.lang.String cookies) e.g., "name=Asprise; domain=asprise.com"
RequestOutputItem.UploadSetting	setLogToFile(java.lang.String httpLogFile) Log file to record HTTP operations.
RequestOutputItem.UploadSetting	setMaxOperationTime(int maxOperationTime) Max HTTP operation time in seconds; default: 1200 (20 mins).
RequestOutputItem.UploadSetting	setMaxRetries(int maxRetries) Max number of retries.
RequestOutputItem.UploadSetting	setPostFileFieldName(java.lang.String postFileFieldName) Field name for files.
RequestOutputItem.UploadSetting	setSaveResponseToFile(java.io.File saveResponseToFile) Saves response to the given file instead of returning response.
RequestOutputItem.UploadSetting	setUrl(java.lang.String url) Target URL
java.util.Map<java.lang.String,java.lang.Object>	toJsonObject()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_MAX_RETRIES

public static final int DEFAULT_MAX_RETRIES

See Also:

Constant Field Values

DEFAULT_MAX_OPERATION_TIME

public static final int DEFAULT_MAX_OPERATION_TIME

See Also:

Constant Field Values

DEFAULT_POST_FILE_FIELD_NAME

public static final java.lang.String DEFAULT_POST_FILE_FIELD_NAME

See Also:

Constant Field Values

Constructor Detail

UploadSetting

public UploadSetting(java.lang.String url)

Constructor

Parameters:

url - target URL to post files.

UploadSetting

public UploadSetting()

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getUrl

public java.lang.String getUrl()

Target URL

setUrl

public RequestOutputItem.UploadSetting setUrl(java.lang.String url)

Target URL

getMaxRetries

public int getMaxRetries()

Max number of retries. Default is 2.

setMaxRetries

public RequestOutputItem.UploadSetting setMaxRetries(int maxRetries)

Max number of retries. Default is 2.

getMaxOperationTime

public int getMaxOperationTime()

Max HTTP operation time in seconds; default: 1200 (20 mins).

setMaxOperationTime

public RequestOutputItem.UploadSetting setMaxOperationTime(int maxOperationTime)

Max HTTP operation time in seconds; default: 1200 (20 mins).

getPostFileFieldName

public java.lang.String getPostFileFieldName()

Field name for files.

setPostFileFieldName

public RequestOutputItem.UploadSetting setPostFileFieldName(java.lang.String postFileFieldName)

Field name for files.

getPostFiles

public java.util.List<java.lang.String> getPostFiles()

Additional files to be posted along

addPostFiles

public RequestOutputItem.UploadSetting addPostFiles(java.lang.String postFile)

Additional files to be posted along

getPostFields

public java.util.Map<java.lang.String,java.lang.String> getPostFields()

Any additional post fields

addPostField

public RequestOutputItem.UploadSetting addPostField(java.lang.String name,
                                                    java.lang.String value)

Any additional post fields

getCookies

public java.lang.String getCookies()

e.g., "name=Asprise; domain=asprise.com"

setCookies

public RequestOutputItem.UploadSetting setCookies(java.lang.String cookies)

e.g., "name=Asprise; domain=asprise.com"

getAuth

public java.lang.String getAuth()

Authentication, e.g., "user:pass"

setAuth

public RequestOutputItem.UploadSetting setAuth(java.lang.String auth)

Authentication, e.g., "user:pass"

getHeaders

public java.util.List<java.lang.String> getHeaders()

e.g., "Referer: http://asprise.com"

addHeaders

public RequestOutputItem.UploadSetting addHeaders(java.lang.String header)

e.g., "Referer: http://asprise.com"

getSaveResponseToFile

public java.io.File getSaveResponseToFile()

Saves response to the given file instead of returning response.

setSaveResponseToFile

public RequestOutputItem.UploadSetting setSaveResponseToFile(java.io.File saveResponseToFile)

Saves response to the given file instead of returning response.

getLogToFile

public java.lang.String getLogToFile()

Log file to record HTTP operations.

setLogToFile

public RequestOutputItem.UploadSetting setLogToFile(java.lang.String httpLogFile)

Log file to record HTTP operations.

fromJsonMap

public static RequestOutputItem.UploadSetting fromJsonMap(java.util.Map json)
                                                   throws java.io.IOException

Throws:

java.io.IOException

toJsonObject

public java.util.Map<java.lang.String,java.lang.Object> toJsonObject()