org.eclipse.webdav
Interface IContext

All Known Implementing Classes:
Context

public interface IContext

The IContext interface provides access methods for most HTTP and WebDAV message header fields. Those that are not explicitly enumerated can be accessed using Context#get(String) and Context#put(String,String) . All context keys are available with Context#keys().

Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.


Field Summary
static String DEPTH_INFINITY
          Depth constant indicating apply the method to the target resource.
static String DEPTH_ONE
          Depth constant indicating apply the method to the target resource.
static String DEPTH_ZERO
          Depth constant indicating apply the method to the target resource.
static String EXCLUSIVE_LOCK
          Lock type constant indicating an exclusive lock.
static String NO_CACHE
          Constant used in the Cache-Control header indicating that clients and proxies MUST not cache the response of a method since it has non-idempotent semantics.
static int NO_EXPIRY_LOCK
          Constant indicating an indefinite timeout period.
static String SHARED_LOCK
          Lock type constant indicating a shared lock.
static String WRITE_LOCK
          Lock type constant indicating a write lock.
 
Method Summary
 void collapse()
          Collapse teh receiver by copying all the keys and values from the default context into the receiver.
 String get(String key)
          Returns the value for the given key, or null if the given key has no value.
 String getAccept()
          Returns the media types that are acceptable for a response.
 String getAcceptCharset()
          Returns the character sets that are acceptable for a response.
 String getAcceptEncoding()
          Retruns what content-encoding values are acceptable for a response.
 String getAcceptLanguage()
          Returns the natural languages that are acceptable for a response.
 String getAcceptRanges()
          Returns the range requests acceptable to a server.
 int getAge()
          Returns the integer value of sender's estimate of the time since the response was generated, or -1 if the value is not set.
 String getAllBindings()
          Returns the string value for the ALL_BINDINGS key.
 String getAllow()
          Returns the methods allowed on a resource
 String getAuthorization()
          Returns the user's credentials for the realm of the resource being requested.
 String getCacheControl()
          Returns the cache control directives that must be obeyed.
 String getConnection()
          Returns the sender connection options.
 String getContentBase()
          Returns the URL string value for the CONTENT_BASE key.
 String getContentEncoding()
          Returns what additional content encodings have been applied to the entity body.
 String getContentLanguage()
          Returns the natural language of the intended audience for the entity body.
 long getContentLength()
          Returns the content length in bytes of the entity body.
 String getContentLocation()
          Returns the URL that locates the content.
 String getContentMD5()
          Returns the string value for the CONTENT_MD5 key.
 String getContentRange()
          Returns the string value for the CONTENT_RANGE key.
 String getContentType()
          Returns the MIME type for the response contents.
 String getDate()
          Returns the date the request was made.
 String getDAV()
          Returns the DAV level supported by the server.
 String getDepth()
          Returns the string value for the "Depth" key.
 String getDestination()
          Returns the destination URL for a copy or move operation.
 String getETag()
          Returns the entity tag for the associated entity.
 String getExpires()
          Returns the date/time after which the response should be considered stale.
 String getFrom()
          Returns the string value for the FROM key.
 String getHost()
          Returns the Internet host and port of the resource being requested.
 String getIfKey()
          Returns the string value for the IF key.
 String getIfMatch()
          Returns the string value for the IF_MATCH key.
 String getIfModifiedSince()
          Returns the string value for the IF_MODIFIED_SINCE key.
 String getIfNoneMatch()
          Returns the string value for the IF_NONE_MATCH key.
 String getIfRange()
          Returns the string value for the IF_RANGE key.
 String getIfUnmodifiedSince()
          Returns the string value for the IF_UNMODIFIED_SINCE key.
 String getLabel()
          Returns the label header value.
 String getLastModified()
          Returns when the resource was last modified.
 String getLocation()
          Returns the URI of the redirect location.
 String getLockToken()
          Returns the lock token for the resource, or null if it is not set.
 int getMaxForwards()
          Returns the integer value for the MAX_FORWARDS key.
 String getOrdered()
          Returns the string value for the ORDERED key.
 boolean getOverwrite()
          Returns the flag that indicates if copy or move should overwrite an existing destination.
 boolean getPassthrough()
          Returns the boolean value for the PASSTHROUGH key.
 String getPosition()
          Returns the string value for the POSITION key.
 String getPragma()
          Returns the string value for the PRAGMA key.
 String getProxyAuthenticate()
          Returns the string value for the PROXY_AUTHENTICATE key.
 String getProxyAuthorization()
          Returns the string value for the PROXY_AUTHORIZATION key.
 String getPublicKey()
          Returns the string value for the PUBLIC_KEY key.
 String getRange()
          Returns the string value for the RANGE key.
 String getReferer()
          Returns the URI string of the resource from which the request was obtained.
 String getRefTarget()
          Returns the URI string for the REF_TARGET key.
 String getResourceType()
          Returns the string value for the RESOURCE_TYPE key.
 String getRetryAfter()
          Returns the string value for the RETRY_AFTER key.
 String getServer()
          Returns information about the software used by the origin server to handle the request.
 String getStatusURI()
          Returns the URI string of the resource whose method is in process.
 int getTimeout()
          Returns the lock timeout value.
 String getTransferEncoding()
          Returns the string value for the TRANSFER_ENCODING key.
 String getUpgrade()
          Returns the string value for the UPGRADE key.
 String getUserAgent()
          Returns information about the user agent originating the request.
 String getVary()
          Returns the string value for the VARY key.
 String getVia()
          Returns the string value for the VIA key.
 String getWarning()
          Returns the string value for the WARNING key.
 String getWWWAuthenticate()
          Returns the string value for the WWW_AUTHENTICATE key.
 Enumeration keys()
          Returns keys of the context, as an enumeration
 void put(String key, String value)
          Adds or replaces the given key-value pair into the context.
 void removeKey(String key)
          Removes the given key from this context.
 void setAccept(String value)
          Sets what media types are acceptable for a response.
 void setAcceptCharset(String value)
          Sets which character sets are acceptable for a response.
 void setAcceptEncoding(String value)
          Sets the content-encoding values which are acceptable for a response.
 void setAcceptLanguage(String value)
          Sets which natural languages are acceptable for a response.
 void setAcceptRanges(String value)
          Sets the range requests acceptable to a server.
 void setAge(int seconds)
          Sets the sender's estimate of the time since the response was generated.
 void setAllBindings(String value)
          Sets the string value for the ALL_BINDINGS key.
 void setAllow(String value)
          Sets methods allowed on a resource Sets the string value for the ALLOW key.
 void setAuthorization(String value)
          Sets the user's credentials for the realm of the resource being requested.
 void setCacheControl(String value)
          Sets the cache control directives that must be obeyed.
 void setConnection(String value)
          Sets sender connection options.
 void setContentBase(String stringURL)
          Sets the URL string value for the CONTENT_BASE key.
 void setContentEncoding(String value)
          Sets the additional content encodings that have been applied to the entity body.
 void setContentLanguage(String value)
          Sets the natural language of the intended audience for the entity body.
 void setContentLength(long value)
          Sets the content length in bytes of the entity body.
 void setContentLocation(String stringURL)
          Sets the URL string value for the CONTENT_LOCATION key.
 void setContentMD5(String value)
          Sets the string value for the CONTENT_MD5 key.
 void setContentRange(String value)
          Sets the string value for the CONTENT_RANGE key.
 void setContentType(String value)
          Sets the MIME type for the response contents.
 void setDate(String value)
          Sets the date the request was made.
 void setDAV(String value)
          Sets the DAV level supported by the server.
 void setDepth(String depth)
          Sets the string value for the DEPTH key.
 void setDestination(String stringURL)
          Sets the destination URI for a copy or move operation.
 void setETag(String value)
          Sets the entity tag for the associated entity.
 void setExpires(String value)
          Sets the date/time after which the response should be considered stale.
 void setFrom(String value)
          Sets the string value for the FROM key.
 void setHost(String value)
          Sets the Internet host and port of the resource being requested.
 void setIfKey(String value)
          Sets the string value for the IF key.
 void setIfMatch(String value)
          Sets the string value for the IF_MATCH key.
 void setIfModifiedSince(String value)
          Sets the string value for the IF_MODIFIED_SINCE key.
 void setIfNoneMatch(String value)
          Sets the string value for the IF_NONE_MATCH key.
 void setIfRange(String value)
          Sets the string value for the IF_RANGE key.
 void setIfUnmodifiedSince(String value)
          Sets the string value for the IF_UNMODIFIED_SINCE key.
 void setLabel(String value)
          Sets when the label header value.
 void setLastModified(String value)
          Sets when the resource was last modified.
 void setLocation(String stringURL)
          Sets the redirect location.
 void setLockToken(String lockToken)
          Sets the lock token for the resource.
 void setMaxForwards(int value)
          Sets the integer value for the MAX_FORWARDS key.
 void setOrdered(String value)
          Sets the string value for the ORDERED key.
 void setOverwrite(boolean value)
          Sets if copy or move should overwrite an existing destination.
 void setPassthrough(boolean value)
          Sets the boolean value for the PASSTHROUGH key.
 void setPosition(String value)
          Sets the string value for the POSITION key.
 void setPragma(String value)
          Sets the string value for the PRAGMA key.
 void setProxyAuthenticate(String value)
          Sets the string value for the PROXY_AUTHENTICATE key.
 void setProxyAuthorization(String value)
          Sets the string value for the PROXY_AUTHORIZATION key.
 void setPublicKey(String value)
          Sets the string value for the PUBLIC_KEY key.
 void setRange(String value)
          Sets the string value for the RANGE key.
 void setReferer(String stringURL)
          Sets the URI of the resource from which the request was obtained.
 void setRefTarget(String stringURL)
          Sets the URI value for the REF_TARGET key.
 void setResourceType(String value)
          Sets the string value for the RESOURCE_TYPE key.
 void setRetryAfter(String value)
          Sets the string value for the RETRY_AFTER key.
 void setServer(String value)
          Sets information about the software used by the origin server to handle the request.
 void setStatusURI(String statusURI)
          Sets the URI of the resource whose method is in process.
 void setTimeout(int value)
          Sets the lock timeout value in seconds.
 void setTransferEncoding(String value)
          Sets the string value for the TRANSFER_ENCODING key.
 void setUpgrade(String value)
          Sets the string value for the UPGRADE key.
 void setUserAgent(String value)
          Sets information about the user agent originating the request.
 void setVary(String value)
          Sets the string value for the VARY key.
 void setVia(String value)
          Sets the string value for the VIA key.
 void setWarning(String value)
          Sets the string value for the WARNING key.
 void setWWWAuthenticate(String value)
          Sets the string value for the WWW_AUTHENTICATE key.
 

Field Detail

DEPTH_ZERO

static final String DEPTH_ZERO
Depth constant indicating apply the method to the target resource.

See Also:
getDepth(), Constant Field Values

DEPTH_ONE

static final String DEPTH_ONE
Depth constant indicating apply the method to the target resource. and (where the resource is a collection) its immediate members.

See Also:
getDepth(), Constant Field Values

DEPTH_INFINITY

static final String DEPTH_INFINITY
Depth constant indicating apply the method to the target resource. and (where the resource is a collection) recursively to all its members.

See Also:
getDepth(), Constant Field Values

EXCLUSIVE_LOCK

static final String EXCLUSIVE_LOCK
Lock type constant indicating an exclusive lock. Only one exclusive lock can be granted at any time on a resource.

See Also:
Constant Field Values

SHARED_LOCK

static final String SHARED_LOCK
Lock type constant indicating a shared lock. A resource may have many concurrent shared locks which indicate an intention to change the resource in some way. It is the responsibilty of the shared lock owners to coordinate their updates appropriately through other means.

See Also:
Constant Field Values

WRITE_LOCK

static final String WRITE_LOCK
Lock type constant indicating a write lock. Write locks allow a resource to be updated or deleted.

See Also:
Constant Field Values

NO_EXPIRY_LOCK

static final int NO_EXPIRY_LOCK
Constant indicating an indefinite timeout period.

See Also:
Constant Field Values

NO_CACHE

static final String NO_CACHE
Constant used in the Cache-Control header indicating that clients and proxies MUST not cache the response of a method since it has non-idempotent semantics.

See Also:
Constant Field Values
Method Detail

collapse

void collapse()
Collapse teh receiver by copying all the keys and values from the default context into the receiver. This effectively makes the Context stand-alone so that subsequent changes to shared contexts are no longer seen by the receiver.


get

String get(String key)
Returns the value for the given key, or null if the given key has no value.

Parameters:
key - the key to look up
Returns:
the value for the key

getAccept

String getAccept()
Returns the media types that are acceptable for a response.

Returns:
the value for "Accept" key, or null if that key has no value.

getAcceptCharset

String getAcceptCharset()
Returns the character sets that are acceptable for a response.

Returns:
the value for "Accept-Charset" key, or null if that key has no value.

getAcceptEncoding

String getAcceptEncoding()
Retruns what content-encoding values are acceptable for a response.

Returns:
the value for "Accept-Encoding" key, or null if that key has no value.

getAcceptLanguage

String getAcceptLanguage()
Returns the natural languages that are acceptable for a response.

Returns:
the value for "Accept-Language" key, or null if that key has no value.

getAcceptRanges

String getAcceptRanges()
Returns the range requests acceptable to a server.

Returns:
the value for "Accept-Ranges" key, or null if that key has no value.

getAge

int getAge()
Returns the integer value of sender's estimate of the time since the response was generated, or -1 if the value is not set.

Returns:
the integer value for "Age" key, or -1 if not set.

getAllBindings

String getAllBindings()
Returns the string value for the ALL_BINDINGS key.

Returns:
the value for "All-Bindings" key, or null if that key has no value.

getAllow

String getAllow()
Returns the methods allowed on a resource

Returns:
the value for "Allow" key, or null if that key has no value.

getAuthorization

String getAuthorization()
Returns the user's credentials for the realm of the resource being requested.

Returns:
the value for "Authorization" key, or null if that key has no value.

getCacheControl

String getCacheControl()
Returns the cache control directives that must be obeyed.

Returns:
the value for "Cache-Control" key, or null if that key has no value.

getConnection

String getConnection()
Returns the sender connection options.

Returns:
the value for "Connection" key, or null if that key has no value.

getContentBase

String getContentBase()
Returns the URL string value for the CONTENT_BASE key.

Returns:
the value for "Content-Base" key, or null if that key has no value.

getContentEncoding

String getContentEncoding()
Returns what additional content encodings have been applied to the entity body.

Returns:
the value for "Content-Encoding" key, or null if that key has no value.

getContentLanguage

String getContentLanguage()
Returns the natural language of the intended audience for the entity body.

Returns:
the value for "Content-Language" key, or null if that key has no value.

getContentLength

long getContentLength()
Returns the content length in bytes of the entity body.

Returns:
the value for "Content-Length" key, or -1 if that key has no value.

getContentLocation

String getContentLocation()
Returns the URL that locates the content.

Returns:
the value for "Content-Location" key, or null if that key has no value.

getContentMD5

String getContentMD5()
Returns the string value for the CONTENT_MD5 key.

Returns:
the value for "Content-MD5" key, or null if that key has no value.

getContentRange

String getContentRange()
Returns the string value for the CONTENT_RANGE key.

Returns:
the value for "Content-Range" key, or null if that key has no value.

getContentType

String getContentType()
Returns the MIME type for the response contents.

Returns:
the value for "Content-Type" key, or null if that key has no value.

getDate

String getDate()
Returns the date the request was made.

Returns:
the value for "Date" key, or null if that key has no value.

getDAV

String getDAV()
Returns the DAV level supported by the server. [missing: what are these values]


getDepth

String getDepth()
Returns the string value for the "Depth" key.

Returns:
one of DEPTH_ZERO, DEPTH_ONE, or DEPTH_INFINITY
See Also:
DEPTH_ZERO, DEPTH_ONE, DEPTH_INFINITY

getDestination

String getDestination()
Returns the destination URL for a copy or move operation.

Returns:
the value for "Destination" key, or null if that key has no value.

getETag

String getETag()
Returns the entity tag for the associated entity.

Returns:
the value for "ETag" key, or null if that key has no value.

getExpires

String getExpires()
Returns the date/time after which the response should be considered stale.

Returns:
the value for "Expires" key, or null if that key has no value.

getFrom

String getFrom()
Returns the string value for the FROM key.

Returns:
the value for "From" key, or null if that key has no value.

getHost

String getHost()
Returns the Internet host and port of the resource being requested.

Returns:
the value for "Host" key, or null if that key has no value.

getIfKey

String getIfKey()
Returns the string value for the IF key.

Returns:
the value for "If" key, or null if that key has no value.

getIfMatch

String getIfMatch()
Returns the string value for the IF_MATCH key.

Returns:
the value for "If-Match" key, or null if that key has no value.

getIfModifiedSince

String getIfModifiedSince()
Returns the string value for the IF_MODIFIED_SINCE key.

Returns:
the value for "If-Modified-Since" key, or null if that key has no value.

getIfNoneMatch

String getIfNoneMatch()
Returns the string value for the IF_NONE_MATCH key.

Returns:
the value for "If-None-Match" key, or null if that key has no value.

getIfRange

String getIfRange()
Returns the string value for the IF_RANGE key.

Returns:
the value for "If-Range" key, or null if that key has no value.

getIfUnmodifiedSince

String getIfUnmodifiedSince()
Returns the string value for the IF_UNMODIFIED_SINCE key.

Returns:
the value for "If-Unmodified-Since" key, or null if that key has no value.

getLabel

String getLabel()
Returns the label header value.

Returns:
the value for "Label" key, or null if that key has no value.

getLastModified

String getLastModified()
Returns when the resource was last modified.

Returns:
the value for "Last-Modified" key, or null if that key has no value.

getLocation

String getLocation()
Returns the URI of the redirect location.

Returns:
the value for "Location" key, or null if that key has no value.

getLockToken

String getLockToken()
Returns the lock token for the resource, or null if it is not set.

Returns:
the value for "Lock-Token" key, or null if that key has no value.

getMaxForwards

int getMaxForwards()
Returns the integer value for the MAX_FORWARDS key.

Returns:
the value for "Max-Forwards" key, or null if that key has no value.

getOrdered

String getOrdered()
Returns the string value for the ORDERED key.

Returns:
the value for "Ordered" key, or null if that key has no value.

getOverwrite

boolean getOverwrite()
Returns the flag that indicates if copy or move should overwrite an existing destination.

Returns:
the value for "Overwrite" key, or false if that key has no value.

getPassthrough

boolean getPassthrough()
Returns the boolean value for the PASSTHROUGH key.

Returns:
the value for "Passthrough" key, or null if that key has no value.

getPosition

String getPosition()
Returns the string value for the POSITION key.

Returns:
the value for "Position" key, or null if that key has no value.

getPragma

String getPragma()
Returns the string value for the PRAGMA key.

Returns:
the value for "Pragma" key, or null if that key has no value.

getProxyAuthenticate

String getProxyAuthenticate()
Returns the string value for the PROXY_AUTHENTICATE key.

Returns:
the value for "Proxy-Authenticate" key, or null if that key has no value.

getProxyAuthorization

String getProxyAuthorization()
Returns the string value for the PROXY_AUTHORIZATION key.

Returns:
the value for "Proxy-Authorization" key, or null if that key has no value.

getPublicKey

String getPublicKey()
Returns the string value for the PUBLIC_KEY key.

Returns:
the value for "Public-Key" key, or null if that key has no value.

getRange

String getRange()
Returns the string value for the RANGE key.

Returns:
the value for "Range" key, or null if that key has no value.

getReferer

String getReferer()
Returns the URI string of the resource from which the request was obtained.

Returns:
the value for "Referer" key, or null if that key has no value.

getRefTarget

String getRefTarget()
Returns the URI string for the REF_TARGET key.

Returns:
the value for "Ref-Target" key, or null if that key has no value.

getResourceType

String getResourceType()
Returns the string value for the RESOURCE_TYPE key.

Returns:
the value for "Resource-Type" key, or null if that key has no value.

getRetryAfter

String getRetryAfter()
Returns the string value for the RETRY_AFTER key.

Returns:
the value for "Retry-After" key, or null if that key has no value.

getServer

String getServer()
Returns information about the software used by the origin server to handle the request.

Returns:
the value for "Server" key, or null if that key has no value.

getStatusURI

String getStatusURI()
Returns the URI string of the resource whose method is in process.

Returns:
the value for "Status-URI" key, or null if that key has no value.

getTimeout

int getTimeout()
Returns the lock timeout value.

Returns:
the integer value for "Timeout" key, where -1 means that the value was not set, and -2 means that the value was infinity.

getTransferEncoding

String getTransferEncoding()
Returns the string value for the TRANSFER_ENCODING key.

Returns:
the value for "Transfer-Encoding" key, or null if that key has no value.

getUpgrade

String getUpgrade()
Returns the string value for the UPGRADE key.

Returns:
the value for "Upgrade" key, or null if that key has no value.

getUserAgent

String getUserAgent()
Returns information about the user agent originating the request.

Returns:
the value for "User-Agent" key, or null if that key has no value.

getVary

String getVary()
Returns the string value for the VARY key.

Returns:
the value for "Vary" key, or null if that key has no value.

getVia

String getVia()
Returns the string value for the VIA key.

Returns:
the value for "Via" key, or null if that key has no value.

getWarning

String getWarning()
Returns the string value for the WARNING key.

Returns:
the value for "Warning" key, or null if that key has no value.

getWWWAuthenticate

String getWWWAuthenticate()
Returns the string value for the WWW_AUTHENTICATE key.

Returns:
the value for "WWW-Authenticate" key, or null if that key has no value.

keys

Enumeration keys()
Returns keys of the context, as an enumeration

Returns:
an enumeration over the context keys (Strings).

put

void put(String key,
         String value)
Adds or replaces the given key-value pair into the context.

Parameters:
key - the key
value - its associated value

removeKey

void removeKey(String key)
Removes the given key from this context. Does nothing if the given key is not set.

Parameters:
key - the key to remove

setAccept

void setAccept(String value)
Sets what media types are acceptable for a response. Sets the string value for the ACCEPT key.

Parameters:
value - the value for ACCEPT

setAcceptCharset

void setAcceptCharset(String value)
Sets which character sets are acceptable for a response. Sets the string value for the ACCEPT_CHARSET key.

Parameters:
value - the value for ACCEPT_CHARSET

setAcceptEncoding

void setAcceptEncoding(String value)
Sets the content-encoding values which are acceptable for a response. Sets the string value for the ACCEPT_ENCODING key.

Parameters:
value - the value for ACCEPT_ENCODING

setAcceptLanguage

void setAcceptLanguage(String value)
Sets which natural languages are acceptable for a response. Sets the string value for the ACCEPT_LANGUAGE key.

Parameters:
value - the value for ACCEPT_LANGUAGE

setAcceptRanges

void setAcceptRanges(String value)
Sets the range requests acceptable to a server. Sets the string value for the ACCEPT_RANGES key.

Parameters:
value - the value for ACCEPT_RANGES

setAge

void setAge(int seconds)
Sets the sender's estimate of the time since the response was generated. Sets the int value for the AGE key. Set the value to -1 to remove the key.

Parameters:
seconds - the value for AGE

setAllBindings

void setAllBindings(String value)
Sets the string value for the ALL_BINDINGS key.

Parameters:
value - the value for ALL_BINDINGS

setAllow

void setAllow(String value)
Sets methods allowed on a resource Sets the string value for the ALLOW key.

Parameters:
value - the value for ALLOW

setAuthorization

void setAuthorization(String value)
Sets the user's credentials for the realm of the resource being requested. Sets the string value for the AUTHORIZATION key.

Parameters:
value - the value for AUTHORIZATION

setCacheControl

void setCacheControl(String value)
Sets the cache control directives that must be obeyed. Sets the string value for the CACHE_CONTROL key.

Parameters:
value - the value for CACHE_CONTROL

setConnection

void setConnection(String value)
Sets sender connection options. Sets the string value for the CONNECTION key.

Parameters:
value - the value for CONNECTION

setContentBase

void setContentBase(String stringURL)
Sets the URL string value for the CONTENT_BASE key.

Parameters:
stringURL - the value for CONTENT_BASE

setContentEncoding

void setContentEncoding(String value)
Sets the additional content encodings that have been applied to the entity body. Sets the string value for the CONTENT_ENCODING key.

Parameters:
value - the value for CONTENT_ENCODING

setContentLanguage

void setContentLanguage(String value)
Sets the natural language of the intended audience for the entity body. Sets the string value for the CONTENT_LANGUAGE key.

Parameters:
value - the value for CONTENT_LANGUAGE

setContentLength

void setContentLength(long value)
Sets the content length in bytes of the entity body. Sets the value for the CONTENT_LENGTH key. Passes the value -1 to remove the key.

Parameters:
value - the value for CONTENT_LENGTH

setContentLocation

void setContentLocation(String stringURL)
Sets the URL string value for the CONTENT_LOCATION key.

Parameters:
stringURL - the value for CONTENT_LOCATION

setContentMD5

void setContentMD5(String value)
Sets the string value for the CONTENT_MD5 key.

Parameters:
value - the value for CONTENT_MD5

setContentRange

void setContentRange(String value)
Sets the string value for the CONTENT_RANGE key.

Parameters:
value - the value for CONTENT_RANGE

setContentType

void setContentType(String value)
Sets the MIME type for the response contents. Sets the string value for the CONTENT_TYPE key.

Parameters:
value - the value for CONTENT_TYPE

setDate

void setDate(String value)
Sets the date the request was made. Sets the string value for the DATE key.

Parameters:
value - the value for DATE

setDAV

void setDAV(String value)
Sets the DAV level supported by the server. Sets the string value for the DAV key.

Parameters:
value - the value for DAV

setDepth

void setDepth(String depth)
Sets the string value for the DEPTH key.

Parameters:
depth - one of DEPTH_ZERO, DEPTH_ONE, or DEPTH_INFINITY
See Also:
DEPTH_ZERO, DEPTH_ONE, DEPTH_INFINITY

setDestination

void setDestination(String stringURL)
Sets the destination URI for a copy or move operation. Sets the URI value for the DESTINATION key.

Parameters:
stringURL - the value for DESTINATION

setETag

void setETag(String value)
Sets the entity tag for the associated entity. Sets the string value for the ETAG key.

Parameters:
value - the value for ETAG

setExpires

void setExpires(String value)
Sets the date/time after which the response should be considered stale. Sets the string value for the EXPIRES key.

Parameters:
value - the value for EXPIRES

setFrom

void setFrom(String value)
Sets the string value for the FROM key.

Parameters:
value - the value for FROM

setHost

void setHost(String value)
Sets the Internet host and port of the resource being requested. Sets the string value for the HOST key.

Parameters:
value - the value for HOST

setIfKey

void setIfKey(String value)
Sets the string value for the IF key.

Parameters:
value - the value for IF

setIfMatch

void setIfMatch(String value)
Sets the string value for the IF_MATCH key.

Parameters:
value - the value for IF_MATCH

setIfModifiedSince

void setIfModifiedSince(String value)
Sets the string value for the IF_MODIFIED_SINCE key.

Parameters:
value - the value for IF_MODIFIED_SINCE

setIfNoneMatch

void setIfNoneMatch(String value)
Sets the string value for the IF_NONE_MATCH key.

Parameters:
value - the value for IF_NONE_MATCH

setIfRange

void setIfRange(String value)
Sets the string value for the IF_RANGE key.

Parameters:
value - the value for IF_RANGE

setIfUnmodifiedSince

void setIfUnmodifiedSince(String value)
Sets the string value for the IF_UNMODIFIED_SINCE key.

Parameters:
value - the value for IF_UNMODIFIED_SINCE

setLabel

void setLabel(String value)
Sets when the label header value. Sets the string value for the LABEL key.

Parameters:
value - the value for LABEL

setLastModified

void setLastModified(String value)
Sets when the resource was last modified. Sets the string value for the LAST_MODIFIED key.

Parameters:
value - the value for LAST_MODIFIED

setLocation

void setLocation(String stringURL)
Sets the redirect location. Sets the URI value for the LOCATION key.

Parameters:
stringURL - the value for LOCATION

setLockToken

void setLockToken(String lockToken)
Sets the lock token for the resource. Sets the lock token value for the LOCK_TOKEN key.

Parameters:
lockToken - the value for LOCK_TOKEN

setMaxForwards

void setMaxForwards(int value)
Sets the integer value for the MAX_FORWARDS key.

Parameters:
value - the value for MAX_FORWARDS

setOrdered

void setOrdered(String value)
Sets the string value for the ORDERED key.

Parameters:
value - the value for ORDERED

setOverwrite

void setOverwrite(boolean value)
Sets if copy or move should overwrite an existing destination. Sets the boolean value for the OVERWRITE key.

Parameters:
value - the value for OVERWRITE

setPassthrough

void setPassthrough(boolean value)
Sets the boolean value for the PASSTHROUGH key.

Parameters:
value - the value for PASSTHROUGH

setPosition

void setPosition(String value)
Sets the string value for the POSITION key.

Parameters:
value - the value for POSITION

setPragma

void setPragma(String value)
Sets the string value for the PRAGMA key.

Parameters:
value - the value for PRAGMA

setProxyAuthenticate

void setProxyAuthenticate(String value)
Sets the string value for the PROXY_AUTHENTICATE key.

Parameters:
value - the value for PROXY_AUTHENTICATE

setProxyAuthorization

void setProxyAuthorization(String value)
Sets the string value for the PROXY_AUTHORIZATION key.

Parameters:
value - the value for PROXY_AUTHORIZATION

setPublicKey

void setPublicKey(String value)
Sets the string value for the PUBLIC_KEY key.

Parameters:
value - the value for PUBLIC_KEY

setRange

void setRange(String value)
Sets the string value for the RANGE key.

Parameters:
value - the value for RANGE

setReferer

void setReferer(String stringURL)
Sets the URI of the resource from which the request was obtained. Sets the URI value for the REFERER key.

Parameters:
stringURL - the value for REFERER

setRefTarget

void setRefTarget(String stringURL)
Sets the URI value for the REF_TARGET key.

Parameters:
stringURL - the value for REF_TARGET

setResourceType

void setResourceType(String value)
Sets the string value for the RESOURCE_TYPE key.

Parameters:
value - the value for RESOURCE_TYPE

setRetryAfter

void setRetryAfter(String value)
Sets the string value for the RETRY_AFTER key.

Parameters:
value - the value for RETRY_AFTER

setServer

void setServer(String value)
Sets information about the software used by the origin server to handle the request. Sets the string value for the SERVER key.

Parameters:
value - the value for SERVER

setStatusURI

void setStatusURI(String statusURI)
Sets the URI of the resource whose method is in process. Sets the URI value for the STATUS_URI key.

Parameters:
statusURI - the value for STATUS_URI

setTimeout

void setTimeout(int value)
Sets the lock timeout value in seconds. Pass -1 to clear the value, pass -2 to set "Infinity". Sets the integer value for the TIMEOUT key.

Parameters:
value - the value for TIMEOUT

setTransferEncoding

void setTransferEncoding(String value)
Sets the string value for the TRANSFER_ENCODING key.

Parameters:
value - the value for TRANSFER_ENCODING

setUpgrade

void setUpgrade(String value)
Sets the string value for the UPGRADE key.

Parameters:
value - the value for UPGRADE

setUserAgent

void setUserAgent(String value)
Sets information about the user agent originating the request. Sets the string value for the USER_AGENT key.

Parameters:
value - the value for USER_AGENT

setVary

void setVary(String value)
Sets the string value for the VARY key.

Parameters:
value - the value for VARY

setVia

void setVia(String value)
Sets the string value for the VIA key.

Parameters:
value - the value for VIA

setWarning

void setWarning(String value)
Sets the string value for the WARNING key.

Parameters:
value - the value for WARNING

setWWWAuthenticate

void setWWWAuthenticate(String value)
Sets the string value for the WWW_AUTHENTICATE key.

Parameters:
value - the value for WWW_AUTHENTICATE


Copyright © 2001-2014 JBoss by Red Hat. All Rights Reserved.