Package org.apache.jackrabbit.webdav.header

Class TimeoutHeader

java.lang.Object

org.apache.jackrabbit.webdav.header.TimeoutHeader

All Implemented Interfaces:

DavConstants, Header

Direct Known Subclasses:

PollTimeoutHeader

public class TimeoutHeader
extends java.lang.Object
implements Header, DavConstants

TimeoutHeader...

Field Summary

Fields inherited from interface org.apache.jackrabbit.webdav.DavConstants

creationDateFormat, DEPTH_0, DEPTH_1, DEPTH_INFINITY, DEPTH_INFINITY_S, HEADER_AUTHORIZATION, HEADER_CONTENT_LANGUAGE, HEADER_CONTENT_LENGTH, HEADER_CONTENT_TYPE, HEADER_DAV, HEADER_DEPTH, HEADER_DESTINATION, HEADER_ETAG, HEADER_IF, HEADER_LAST_MODIFIED, HEADER_LOCK_TOKEN, HEADER_OVERWRITE, HEADER_TIMEOUT, INFINITE_TIMEOUT, modificationDateFormat, NAMESPACE, OPAQUE_LOCK_TOKEN_PREFIX, PROPERTY_CREATIONDATE, PROPERTY_DISPLAYNAME, PROPERTY_GETCONTENTLANGUAGE, PROPERTY_GETCONTENTLENGTH, PROPERTY_GETCONTENTTYPE, PROPERTY_GETETAG, PROPERTY_GETLASTMODIFIED, PROPERTY_LOCKDISCOVERY, PROPERTY_RESOURCETYPE, PROPERTY_SOURCE, PROPERTY_SUPPORTEDLOCK, PROPFIND_ALL_PROP, PROPFIND_ALL_PROP_INCLUDE, PROPFIND_BY_PROPERTY, PROPFIND_PROPERTY_NAMES, TIMEOUT_INFINITE, UNDEFINED_TIME, UNDEFINED_TIMEOUT, XML_ACTIVELOCK, XML_ALLPROP, XML_COLLECTION, XML_DEPTH, XML_DST, XML_EXCLUSIVE, XML_HREF, XML_INCLUDE, XML_KEEPALIVE, XML_LINK, XML_LOCKENTRY, XML_LOCKINFO, XML_LOCKROOT, XML_LOCKSCOPE, XML_LOCKTOKEN, XML_LOCKTYPE, XML_MULTISTATUS, XML_OMIT, XML_OWNER, XML_PROP, XML_PROPERTYBEHAVIOR, XML_PROPERTYUPDATE, XML_PROPFIND, XML_PROPNAME, XML_PROPSTAT, XML_REMOVE, XML_RESPONSE, XML_RESPONSEDESCRIPTION, XML_SET, XML_SHARED, XML_SOURCE, XML_STATUS, XML_TIMEOUT, XML_WRITE

Constructor Summary

Constructors

Constructor	Description
TimeoutHeader(long timeout)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getHeaderName()
java.lang.String	getHeaderValue()
long	getTimeout()
static long	parse(java.lang.String timeoutStr, long defaultValue)	Parses the given timeout String and converts the timeout value into a long indicating the number of milliseconds until expiration time is reached. NOTE: If the timeout String equals to 'infinite' Integer.MAX_VALUE is returned.
static TimeoutHeader	parse(HttpServletRequest request, long defaultValue)	Parses the request timeout header and converts it into a new TimeoutHeader object. The default value is used as fallback if the String is not parseable.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeoutHeader

public TimeoutHeader(long timeout)

Method Detail

getHeaderName

public java.lang.String getHeaderName()

Specified by:

getHeaderName in interface Header

getHeaderValue

public java.lang.String getHeaderValue()

Specified by:

getHeaderValue in interface Header

getTimeout

public long getTimeout()

parse

public static TimeoutHeader parse(HttpServletRequest request,
                                  long defaultValue)

Parses the request timeout header and converts it into a new TimeoutHeader object.
The default value is used as fallback if the String is not parseable.

Parameters:

request -

defaultValue -

Returns:

a new TimeoutHeader object.

parse

public static long parse(java.lang.String timeoutStr,
                         long defaultValue)

Parses the given timeout String and converts the timeout value into a long indicating the number of milliseconds until expiration time is reached.
NOTE: If the timeout String equals to 'infinite' Integer.MAX_VALUE is returned. If the Sting is invalid or is in an invalid format that cannot be parsed, the default value is returned.

Parameters:

timeoutStr -

defaultValue -

Returns:

long representing the timeout present in the header or the default value if the header is missing or could not be parsed.