com.bradmcevoy.http
Class AbstractRequest

java.lang.Object
  com.bradmcevoy.http.AbstractRequest

All Implemented Interfaces:

Request

Direct Known Subclasses:

DebugFilter.DebugRequest

public abstract class AbstractRequest
extends java.lang.Object
implements Request

Nested Class Summary

Nested classes/interfaces inherited from interface com.bradmcevoy.http.Request

Request.CacheControlRequest, Request.Depth, Request.Header, Request.Method

Field Summary

static int

INFINITY

Constructor Summary

AbstractRequest()

Method Summary

java.lang.String	getAbsolutePath() Return the path portion of the url.
java.lang.String	getAcceptEncodingHeader()
java.lang.String	getAcceptHeader()
java.util.Map<java.lang.String,java.lang.Object>	getAttributes() Return a writable map of arbitrary values to be associated with the request
java.lang.Long	getContentLengthHeader()
java.lang.String	getContentRangeHeader() Used for partial PUTs
java.lang.String	getContentTypeHeader()
int	getDepthHeader()
java.lang.String	getDestinationHeader()
java.lang.String	getExpectHeader()
java.util.Map<java.lang.String,FileItem>	getFiles() Note to implementors: the parameters will be created by the core handler classes and added to the attributes map.
java.lang.String	getHostHeader()
java.lang.String	getIfHeader()
java.util.Date	getIfModifiedHeader()
java.lang.String	getLockTokenHeader()
java.lang.Boolean	getOverwriteHeader() Used for MOVE and COPY methods.
java.util.Map<java.lang.String,java.lang.String>	getParams() Note to implementors: the parameters will be created by the core handler classes and added to the attributes map.
java.lang.String	getRangeHeader()
java.lang.String	getRefererHeader()
abstract java.lang.String	getRequestHeader(Request.Header header)
java.lang.String	getTimeoutHeader()
java.lang.String	getUserAgentHeader()
static java.lang.String	stripToPath(java.lang.String url)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bradmcevoy.http.Request

getAbsoluteUrl, getAuthorization, getCookie, getCookies, getFromAddress, getHeaders, getInputStream, getMethod, getRemoteAddr, parseRequestParameters, setAuthorization

Field Detail

INFINITY

public static final int INFINITY

See Also:

Constant Field Values

Constructor Detail

AbstractRequest

public AbstractRequest()

Method Detail

getRequestHeader

public abstract java.lang.String getRequestHeader(Request.Header header)

Specified by:

getRequestHeader in interface Request

getIfModifiedHeader

public java.util.Date getIfModifiedHeader()

Specified by:

getIfModifiedHeader in interface Request

getExpectHeader

public java.lang.String getExpectHeader()

Specified by:

getExpectHeader in interface Request

getAcceptHeader

public java.lang.String getAcceptHeader()

Specified by:

getAcceptHeader in interface Request

getRefererHeader

public java.lang.String getRefererHeader()

Specified by:

getRefererHeader in interface Request

getContentTypeHeader

public java.lang.String getContentTypeHeader()

Specified by:

getContentTypeHeader in interface Request

getAcceptEncodingHeader

public java.lang.String getAcceptEncodingHeader()

Specified by:

getAcceptEncodingHeader in interface Request

getUserAgentHeader

public java.lang.String getUserAgentHeader()

Specified by:

getUserAgentHeader in interface Request

Returns:

- the user agent header field

getDepthHeader

public int getDepthHeader()

Specified by:

getDepthHeader in interface Request

getHostHeader

public java.lang.String getHostHeader()

Specified by:

getHostHeader in interface Request

getDestinationHeader

public java.lang.String getDestinationHeader()

Specified by:

getDestinationHeader in interface Request

getContentLengthHeader

public java.lang.Long getContentLengthHeader()

Specified by:

getContentLengthHeader in interface Request

getTimeoutHeader

public java.lang.String getTimeoutHeader()

Specified by:

getTimeoutHeader in interface Request

getIfHeader

public java.lang.String getIfHeader()

Specified by:

getIfHeader in interface Request

getLockTokenHeader

public java.lang.String getLockTokenHeader()

Specified by:

getLockTokenHeader in interface Request

getRangeHeader

public java.lang.String getRangeHeader()

Specified by:

getRangeHeader in interface Request

Returns:

a range header, for partial gets

getContentRangeHeader

public java.lang.String getContentRangeHeader()

Description copied from interface: Request

Used for partial PUTs

Specified by:

getContentRangeHeader in interface Request

Returns:

getOverwriteHeader

public java.lang.Boolean getOverwriteHeader()

Description copied from interface: Request

Used for MOVE and COPY methods. If true it indicates that any existing resource should be deleted before the move.

Specified by:

getOverwriteHeader in interface Request

Returns:

- null if no value, true indicates that any existing resource should be deleted

getAbsolutePath

public java.lang.String getAbsolutePath()

Description copied from interface: Request

Return the path portion of the url. This is everything following the host and port. Will always begin with a leading slash

Specified by:

getAbsolutePath in interface Request

stripToPath

public static java.lang.String stripToPath(java.lang.String url)

getAttributes

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

Description copied from interface: Request

Return a writable map of arbitrary values to be associated with the request

Specified by:

getAttributes in interface Request

Returns:

a writable map of arbitrary values to be associated with the request

getParams

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

Description copied from interface: Request

Note to implementors: the parameters will be created by the core handler classes and added to the attributes map. If you're extending AbstractRequest this method will already be implemented for you by returning that attribute If you are not extending AbstractRequest you should implement this as: return attributes.get( "_params");

Specified by:

getParams in interface Request

Returns:

- map of querystring or POST parameters, keyed by name

getFiles

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

Description copied from interface: Request

Note to implementors: the parameters will be created by the core handler classes and added to the attributes map. If you're extending AbstractRequest this method will already be implemented for you by returning that attribute If you are not extending AbstractRequest you should return implement this as: return attributes.get( "_files");

Specified by:

getFiles in interface Request

Returns:

- a map of files from an upload request, keyed by file name