Package org.simpleframework.http
Interface Protocol
-
public interface ProtocolThis represents the HTTP header names defined in RFC 2616. It can be used to set and get headers safely from theRequestandResponseobjects. This is used internally by the HTTP server to parse the incoming requests and also to submit response values for each conversation.In addition to the header names this also contains some common HTTP header value tokens. These are provided for convenience and can be used to ensure that response values comply with RFC 2616.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringACCEPTSpecifies media types which are acceptable for the response.static java.lang.StringACCEPT_CHARSETIndicates what character sets are acceptable for the response.static java.lang.StringACCEPT_ENCODINGRestricts the content codings that are acceptable in the response.static java.lang.StringACCEPT_LANGUAGERestricts the set of languages that are preferred as a response.static java.lang.StringACCEPT_RANGESIndicates a servers acceptance of range requests for a resource.static java.lang.StringAGEEstimates the amount of time since the response was generated.static java.lang.StringALLOWLists the set of methods supported by the resource identified.static java.lang.StringAPPLICATIONRepresents a class of data representing an executable application.static java.lang.StringAUTHORIZATIONSent by a client that wishes to authenticate itself with a server.static java.lang.StringBOUNDARYRepresents the token used to identify a multipart boundary.static java.lang.StringCACHE_CONTROLSpecifies directives that must be obeyed by all caching mechanisms.static java.lang.StringCHARSETRepresents the token used to identify the encoding of a message.static java.lang.StringCHUNKEDRepresents the name of a self delimiting transfer encoding.static java.lang.StringCLOSESpecifies that the server will terminate the connection.static java.lang.StringCONNECTIONSpecifies options that are desired for that particular connection.static java.lang.StringCONTENT_DISPOSITIONSpecifies a tag indicating of its desired presentation semantics.static java.lang.StringCONTENT_ENCODINGIndicates additional content codings have been applied to the body.static java.lang.StringCONTENT_LANGUAGEDescribes the languages of the intended audience for the body.static java.lang.StringCONTENT_LENGTHIndicates the size of the entity body in decimal number of octets.static java.lang.StringCONTENT_LOCATIONUsed to supply the resource location for the entity enclosed.static java.lang.StringCONTENT_MD5An MD5 digest of the body for the purpose of checking integrity.static java.lang.StringCONTENT_RANGESpecifies where in the full body a partial body should be applied.static java.lang.StringCONTENT_TYPEIndicates the media type of the body sent to the recipient.static java.lang.StringCOOKIERepresents a cookie that contains some information from the client.static java.lang.StringDATERepresents the date and time at which the message was originated.static java.lang.StringETAGProvides the value of the entity tag for the requested variant.static java.lang.StringEXPECTIndicate that particular server behaviors are required by the client.static java.lang.StringEXPIRESGives the time after which the response is considered stale.static java.lang.StringFROMAddress for the human user who controls the requesting user agent.static java.lang.StringHOSTSpecifies the host and port number of the resource being requested.static java.lang.StringIF_MATCHSpecifies the entity tag for a request to make it conditional.static java.lang.StringIF_MODIFIED_SINCEIf variant has not been modified since the time specified.static java.lang.StringIF_NONE_MATCHVerify that none of those entities is current by including a list.static java.lang.StringIF_RANGEIf the entity is unchanged send me the part that I am missing.static java.lang.StringIF_UNMODIFIED_SINCEIf the requested resource has not been modified since this time.static java.lang.StringIMAGERepresents a message type for an image such as a PNG or JPEG.static java.lang.StringKEEP_ALIVESpecifies that the server wishes to keep the connection open.static java.lang.StringLAST_MODIFIEDIndicates the date and time at which the variant was last modified.static java.lang.StringLOCATIONUsed to redirect the recipient to a location other than the URI.static java.lang.StringMAX_FORWARDSLimit the number of proxies or gateways that can forward the request.static java.lang.StringMULTIPARTRepresents a message type that contains multiple parts.static java.lang.StringNO_CACHESpecifies that the message should not be cached by anything.static java.lang.StringOCTET_STREAMRepresents the default content type if none is specified.static java.lang.StringPRAGMAInclude implementation specific directives that might apply.static java.lang.StringPROXY_AUTHENTICATEChallenge indicating the authentication applicable to the proxy.static java.lang.StringPROXY_AUTHORIZATIONAllows client identification for a proxy requiring authentication.static java.lang.StringRANGESpecifies a range of bytes within a resource to be sent by a server.static java.lang.StringREFERERAllows the client to specify the source address to the server.static java.lang.StringRETRY_AFTERResponse to indicate how long the service will be unavailable.static java.lang.StringSEC_WEBSOCKET_ACCEPTRepresents the SHA-1 digest of the clients globally unique identifier.static java.lang.StringSEC_WEBSOCKET_KEYRepresents the globally unique identifier sent by the client.static java.lang.StringSEC_WEBSOCKET_PROTOCOLSpecifies the protocol that should be used by the connected parties.static java.lang.StringSEC_WEBSOCKET_VERSIONRepresents the version of the protocol that should be used.static java.lang.StringSERVERContains information about the software used by the origin server.static java.lang.StringSET_COOKIERepresents some value from the server that the client should keep.static java.lang.StringTEIndicates what extension transfer codings it is willing to accept.static java.lang.StringTEXTRepresents a message type containing human readable text.static java.lang.StringTRAILERIndicates that these header fields is present in the trailer.static java.lang.StringTRANSFER_ENCODINGIndicates the transformation has been applied to the message body.static java.lang.StringUPGRADESpecifies additional communication protocols the client supports.static java.lang.StringURL_ENCODEDRepresents a message type that contains HTML form posted data.static java.lang.StringUSER_AGENTContains information about the user agent originating the request.static java.lang.StringVARYIndicates the headers that can make a cached resource stale.static java.lang.StringVIAUsed by gateways and proxies to indicate the intermediate protocols.static java.lang.StringWARNINGUsed to carry additional information about the status or body.static java.lang.StringWEBSOCKETThis is the protocol token that is used when upgrading.static java.lang.StringWWW_AUTHENTICATEUses to challenge a client for authentication for a resource.
-
-
-
Field Detail
-
ACCEPT
static final java.lang.String ACCEPT
Specifies media types which are acceptable for the response.- See Also:
- Constant Field Values
-
ACCEPT_CHARSET
static final java.lang.String ACCEPT_CHARSET
Indicates what character sets are acceptable for the response.- See Also:
- Constant Field Values
-
ACCEPT_ENCODING
static final java.lang.String ACCEPT_ENCODING
Restricts the content codings that are acceptable in the response.- See Also:
- Constant Field Values
-
ACCEPT_LANGUAGE
static final java.lang.String ACCEPT_LANGUAGE
Restricts the set of languages that are preferred as a response.- See Also:
- Constant Field Values
-
ACCEPT_RANGES
static final java.lang.String ACCEPT_RANGES
Indicates a servers acceptance of range requests for a resource.- See Also:
- Constant Field Values
-
AGE
static final java.lang.String AGE
Estimates the amount of time since the response was generated.- See Also:
- Constant Field Values
-
ALLOW
static final java.lang.String ALLOW
Lists the set of methods supported by the resource identified.- See Also:
- Constant Field Values
-
AUTHORIZATION
static final java.lang.String AUTHORIZATION
Sent by a client that wishes to authenticate itself with a server.- See Also:
- Constant Field Values
-
CACHE_CONTROL
static final java.lang.String CACHE_CONTROL
Specifies directives that must be obeyed by all caching mechanisms.- See Also:
- Constant Field Values
-
CONNECTION
static final java.lang.String CONNECTION
Specifies options that are desired for that particular connection.- See Also:
- Constant Field Values
-
CONTENT_DISPOSITION
static final java.lang.String CONTENT_DISPOSITION
Specifies a tag indicating of its desired presentation semantics.- See Also:
- Constant Field Values
-
CONTENT_ENCODING
static final java.lang.String CONTENT_ENCODING
Indicates additional content codings have been applied to the body.- See Also:
- Constant Field Values
-
CONTENT_LANGUAGE
static final java.lang.String CONTENT_LANGUAGE
Describes the languages of the intended audience for the body.- See Also:
- Constant Field Values
-
CONTENT_LENGTH
static final java.lang.String CONTENT_LENGTH
Indicates the size of the entity body in decimal number of octets.- See Also:
- Constant Field Values
-
CONTENT_LOCATION
static final java.lang.String CONTENT_LOCATION
Used to supply the resource location for the entity enclosed.- See Also:
- Constant Field Values
-
CONTENT_MD5
static final java.lang.String CONTENT_MD5
An MD5 digest of the body for the purpose of checking integrity.- See Also:
- Constant Field Values
-
CONTENT_RANGE
static final java.lang.String CONTENT_RANGE
Specifies where in the full body a partial body should be applied.- See Also:
- Constant Field Values
-
CONTENT_TYPE
static final java.lang.String CONTENT_TYPE
Indicates the media type of the body sent to the recipient.- See Also:
- Constant Field Values
-
COOKIE
static final java.lang.String COOKIE
Represents a cookie that contains some information from the client.- See Also:
- Constant Field Values
-
DATE
static final java.lang.String DATE
Represents the date and time at which the message was originated.- See Also:
- Constant Field Values
-
ETAG
static final java.lang.String ETAG
Provides the value of the entity tag for the requested variant.- See Also:
- Constant Field Values
-
EXPECT
static final java.lang.String EXPECT
Indicate that particular server behaviors are required by the client.- See Also:
- Constant Field Values
-
EXPIRES
static final java.lang.String EXPIRES
Gives the time after which the response is considered stale.- See Also:
- Constant Field Values
-
FROM
static final java.lang.String FROM
Address for the human user who controls the requesting user agent.- See Also:
- Constant Field Values
-
HOST
static final java.lang.String HOST
Specifies the host and port number of the resource being requested.- See Also:
- Constant Field Values
-
IF_MATCH
static final java.lang.String IF_MATCH
Specifies the entity tag for a request to make it conditional.- See Also:
- Constant Field Values
-
IF_MODIFIED_SINCE
static final java.lang.String IF_MODIFIED_SINCE
If variant has not been modified since the time specified.- See Also:
- Constant Field Values
-
IF_NONE_MATCH
static final java.lang.String IF_NONE_MATCH
Verify that none of those entities is current by including a list.- See Also:
- Constant Field Values
-
IF_RANGE
static final java.lang.String IF_RANGE
If the entity is unchanged send me the part that I am missing.- See Also:
- Constant Field Values
-
IF_UNMODIFIED_SINCE
static final java.lang.String IF_UNMODIFIED_SINCE
If the requested resource has not been modified since this time.- See Also:
- Constant Field Values
-
LAST_MODIFIED
static final java.lang.String LAST_MODIFIED
Indicates the date and time at which the variant was last modified.- See Also:
- Constant Field Values
-
LOCATION
static final java.lang.String LOCATION
Used to redirect the recipient to a location other than the URI.- See Also:
- Constant Field Values
-
MAX_FORWARDS
static final java.lang.String MAX_FORWARDS
Limit the number of proxies or gateways that can forward the request.- See Also:
- Constant Field Values
-
PRAGMA
static final java.lang.String PRAGMA
Include implementation specific directives that might apply.- See Also:
- Constant Field Values
-
PROXY_AUTHENTICATE
static final java.lang.String PROXY_AUTHENTICATE
Challenge indicating the authentication applicable to the proxy.- See Also:
- Constant Field Values
-
PROXY_AUTHORIZATION
static final java.lang.String PROXY_AUTHORIZATION
Allows client identification for a proxy requiring authentication.- See Also:
- Constant Field Values
-
RANGE
static final java.lang.String RANGE
Specifies a range of bytes within a resource to be sent by a server.- See Also:
- Constant Field Values
-
REFERER
static final java.lang.String REFERER
Allows the client to specify the source address to the server.- See Also:
- Constant Field Values
-
RETRY_AFTER
static final java.lang.String RETRY_AFTER
Response to indicate how long the service will be unavailable.- See Also:
- Constant Field Values
-
SEC_WEBSOCKET_KEY
static final java.lang.String SEC_WEBSOCKET_KEY
Represents the globally unique identifier sent by the client.- See Also:
- Constant Field Values
-
SEC_WEBSOCKET_ACCEPT
static final java.lang.String SEC_WEBSOCKET_ACCEPT
Represents the SHA-1 digest of the clients globally unique identifier.- See Also:
- Constant Field Values
-
SEC_WEBSOCKET_PROTOCOL
static final java.lang.String SEC_WEBSOCKET_PROTOCOL
Specifies the protocol that should be used by the connected parties.- See Also:
- Constant Field Values
-
SEC_WEBSOCKET_VERSION
static final java.lang.String SEC_WEBSOCKET_VERSION
Represents the version of the protocol that should be used.- See Also:
- Constant Field Values
-
SERVER
static final java.lang.String SERVER
Contains information about the software used by the origin server.- See Also:
- Constant Field Values
-
SET_COOKIE
static final java.lang.String SET_COOKIE
Represents some value from the server that the client should keep.- See Also:
- Constant Field Values
-
TE
static final java.lang.String TE
Indicates what extension transfer codings it is willing to accept.- See Also:
- Constant Field Values
-
TRAILER
static final java.lang.String TRAILER
Indicates that these header fields is present in the trailer.- See Also:
- Constant Field Values
-
TRANSFER_ENCODING
static final java.lang.String TRANSFER_ENCODING
Indicates the transformation has been applied to the message body.- See Also:
- Constant Field Values
-
UPGRADE
static final java.lang.String UPGRADE
Specifies additional communication protocols the client supports.- See Also:
- Constant Field Values
-
USER_AGENT
static final java.lang.String USER_AGENT
Contains information about the user agent originating the request.- See Also:
- Constant Field Values
-
VARY
static final java.lang.String VARY
Indicates the headers that can make a cached resource stale.- See Also:
- Constant Field Values
-
VIA
static final java.lang.String VIA
Used by gateways and proxies to indicate the intermediate protocols.- See Also:
- Constant Field Values
-
WARNING
static final java.lang.String WARNING
Used to carry additional information about the status or body.- See Also:
- Constant Field Values
-
WWW_AUTHENTICATE
static final java.lang.String WWW_AUTHENTICATE
Uses to challenge a client for authentication for a resource.- See Also:
- Constant Field Values
-
APPLICATION
static final java.lang.String APPLICATION
Represents a class of data representing an executable application.- See Also:
- Constant Field Values
-
BOUNDARY
static final java.lang.String BOUNDARY
Represents the token used to identify a multipart boundary.- See Also:
- Constant Field Values
-
CHARSET
static final java.lang.String CHARSET
Represents the token used to identify the encoding of a message.- See Also:
- Constant Field Values
-
CHUNKED
static final java.lang.String CHUNKED
Represents the name of a self delimiting transfer encoding.- See Also:
- Constant Field Values
-
CLOSE
static final java.lang.String CLOSE
Specifies that the server will terminate the connection.- See Also:
- Constant Field Values
-
IMAGE
static final java.lang.String IMAGE
Represents a message type for an image such as a PNG or JPEG.- See Also:
- Constant Field Values
-
KEEP_ALIVE
static final java.lang.String KEEP_ALIVE
Specifies that the server wishes to keep the connection open.- See Also:
- Constant Field Values
-
MULTIPART
static final java.lang.String MULTIPART
Represents a message type that contains multiple parts.- See Also:
- Constant Field Values
-
NO_CACHE
static final java.lang.String NO_CACHE
Specifies that the message should not be cached by anything.- See Also:
- Constant Field Values
-
OCTET_STREAM
static final java.lang.String OCTET_STREAM
Represents the default content type if none is specified.- See Also:
- Constant Field Values
-
TEXT
static final java.lang.String TEXT
Represents a message type containing human readable text.- See Also:
- Constant Field Values
-
URL_ENCODED
static final java.lang.String URL_ENCODED
Represents a message type that contains HTML form posted data.- See Also:
- Constant Field Values
-
WEBSOCKET
static final java.lang.String WEBSOCKET
This is the protocol token that is used when upgrading.- See Also:
- Constant Field Values
-
-