A B C D E F G H I K L M N O P Q R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- ABNORMAL_CLOSURE - org.simpleframework.http.socket.CloseCode
-
Indicates an abnormal closure and should not be used.
- ACCEPT - Static variable in interface org.simpleframework.http.Protocol
-
Specifies media types which are acceptable for the response.
- ACCEPT_CHARSET - Static variable in interface org.simpleframework.http.Protocol
-
Indicates what character sets are acceptable for the response.
- ACCEPT_ENCODING - Static variable in interface org.simpleframework.http.Protocol
-
Restricts the content codings that are acceptable in the response.
- ACCEPT_LANGUAGE - Static variable in interface org.simpleframework.http.Protocol
-
Restricts the set of languages that are preferred as a response.
- ACCEPT_RANGES - Static variable in interface org.simpleframework.http.Protocol
-
Indicates a servers acceptance of range requests for a resource.
- ACCEPTED - org.simpleframework.http.Status
-
This is used to signify that the request has been accepted.
- add(String, String) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is used to add the name and value specified as a special header within the segment.
- addDate(String, long) - Method in interface org.simpleframework.http.message.Message
-
This is used as a convenience method for adding a header that needs to be parsed into a HTTPdate string.
- addDate(String, long) - Method in class org.simpleframework.http.message.MessageHeader
-
This is used as a convenience method for adding a header that needs to be parsed into a HTTPdate string.
- addDate(String, long) - Method in interface org.simpleframework.http.ResponseHeader
-
This is used as a convenience method for adding a header that needs to be parsed into a HTTPdate string.
- addDate(String, long) - Method in class org.simpleframework.http.ResponseWrapper
-
This is used as a convenience method for adding a header that needs to be parsed into a HTTPdate string.
- addInteger(String, int) - Method in interface org.simpleframework.http.message.Message
-
This can be used to add a HTTP message header to this object.
- addInteger(String, int) - Method in class org.simpleframework.http.message.MessageHeader
-
This can be used to add a HTTP message header to this object.
- addInteger(String, int) - Method in interface org.simpleframework.http.ResponseHeader
-
This can be used to add a HTTP message header to this object.
- addInteger(String, int) - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to add a HTTP message header to this object.
- Address - Interface in org.simpleframework.http
-
The
Address
interface is used to represent a generic uniform resource identifier. - AddressParser - Class in org.simpleframework.http.parse
-
This parser is used to parse uniform resource identifiers.
- AddressParser() - Constructor for class org.simpleframework.http.parse.AddressParser
-
Default constructor will create a
AddressParser
that contains no specifics. - AddressParser(String) - Constructor for class org.simpleframework.http.parse.AddressParser
-
This is primarily a convenience constructor.
- addValue(String, String) - Method in interface org.simpleframework.http.message.Message
-
This can be used to add a HTTP message header to this object.
- addValue(String, String) - Method in class org.simpleframework.http.message.MessageHeader
-
This can be used to add a HTTP message header to this object.
- addValue(String, String) - Method in interface org.simpleframework.http.ResponseHeader
-
This can be used to add a HTTP message header to this object.
- addValue(String, String) - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to add a HTTP message header to this object.
- adjust() - Method in class org.simpleframework.http.message.SegmentConsumer
-
This will update the offset variable so that the next read will be of a non whitespace character.
- AGE - Static variable in interface org.simpleframework.http.Protocol
-
Estimates the amount of time since the response was generated.
- ALLOW - Static variable in interface org.simpleframework.http.Protocol
-
Lists the set of methods supported by the resource identified.
- APPLICATION - Static variable in interface org.simpleframework.http.Protocol
-
Represents a class of data representing an executable application.
- array - Variable in class org.simpleframework.http.message.ArrayConsumer
-
This is the array that is used to contain the read bytes.
- array - Variable in class org.simpleframework.http.message.UpdateConsumer
-
This is an external array used to copy data between buffers.
- ArrayConsumer - Class in org.simpleframework.http.message
-
The
ArrayConsumer
object is a consumer that consumes bytes in to an internal array before processing. - ArrayConsumer() - Constructor for class org.simpleframework.http.message.ArrayConsumer
-
Constructor for the
ArrayConsumer
object. - ArrayConsumer(int) - Constructor for class org.simpleframework.http.message.ArrayConsumer
-
Constructor for the
ArrayConsumer
object. - ArrayConsumer(int, int) - Constructor for class org.simpleframework.http.message.ArrayConsumer
-
Constructor for the
ArrayConsumer
object. - AUTHORIZATION - Static variable in interface org.simpleframework.http.Protocol
-
Sent by a client that wishes to authenticate itself with a server.
B
- BAD_GATEWAY - org.simpleframework.http.Status
-
This is used to tell the client that the gateway is invalid.
- BAD_REQUEST - org.simpleframework.http.Status
-
This is used to tell the client they have send an invalid request.
- BINARY - org.simpleframework.http.socket.FrameType
-
A binary frame identifies a message that contains binary data.
- BinaryData - Class in org.simpleframework.http.socket
-
The
BinaryData
object represents a binary payload for a WebScoket frame. - BinaryData(byte[]) - Constructor for class org.simpleframework.http.socket.BinaryData
-
Constructor for the
BinaryData
object. - body - Variable in class org.simpleframework.http.message.EntityConsumer
-
This is used to consume the body for the request entity.
- Body - Interface in org.simpleframework.http.message
-
The
Body
interface is used to represent the body of a HTTP entity. - BODY_FINISHED - org.simpleframework.http.core.ContainerEvent
-
This indicates that the server has fully read the request body.
- BodyConsumer - Interface in org.simpleframework.http.message
-
The
BodyConsumer
is used to consume the body of an HTTP message. - BOUNDARY - Static variable in interface org.simpleframework.http.Protocol
-
Represents the token used to identify a multipart boundary.
- ByteConsumer - Interface in org.simpleframework.http.message
-
The
ByteConsumer
object is used to consume and process bytes from a cursor.
C
- CACHE_CONTROL - Static variable in interface org.simpleframework.http.Protocol
-
Specifies directives that must be obeyed by all caching mechanisms.
- CHARSET - Static variable in interface org.simpleframework.http.Protocol
-
Represents the token used to identify the encoding of a message.
- chunk - Variable in class org.simpleframework.http.message.ArrayConsumer
-
This is the size of the chunk of bytes to read each time.
- CHUNKED - Static variable in interface org.simpleframework.http.Protocol
-
Represents the name of a self delimiting transfer encoding.
- ChunkedConsumer - Class in org.simpleframework.http.message
-
The
ChunkedConsumer
is reads an decodes a stream using the chunked transfer coding. - ChunkedConsumer(Allocator) - Constructor for class org.simpleframework.http.message.ChunkedConsumer
-
Constructor for the
ChunkedConsumer
object. - clear() - Method in class org.simpleframework.http.parse.ContentDispositionParser
-
This is used to clear all previously collected tokens.
- close() - Method in interface org.simpleframework.http.Response
-
This is used to close the connection and commit the request.
- close() - Method in class org.simpleframework.http.ResponseWrapper
-
This is used to close the connection and commit the request.
- close() - Method in interface org.simpleframework.http.socket.FrameChannel
-
This is used to close the connection without a specific reason.
- close(Reason) - Method in interface org.simpleframework.http.socket.FrameChannel
-
This is used to close the connection with a specific reason.
- CLOSE - org.simpleframework.http.socket.FrameType
-
A close frame identifies a frame used to terminate a connection.
- CLOSE - Static variable in interface org.simpleframework.http.Protocol
-
Specifies that the server will terminate the connection.
- CloseCode - Enum in org.simpleframework.http.socket
-
The
CloseCode
enumerates the closure codes specified in RFC 6455. - code - Variable in enum org.simpleframework.http.socket.CloseCode
-
This is the actual integer value representing the code.
- code - Variable in enum org.simpleframework.http.socket.FrameType
-
This is the integer value for the opcode.
- code - Variable in enum org.simpleframework.http.Status
-
This is the code for the status that this instance represents.
- commit() - Method in interface org.simpleframework.http.Response
-
This is used to write the headers that where given to the
Response
. - commit() - Method in class org.simpleframework.http.ResponseWrapper
-
This is used to write the headers that where given to the
Response
. - commit(ByteCursor) - Method in class org.simpleframework.http.message.UpdateConsumer
-
This method can be used to commit the consumer when all data has been consumed.
- CONFLICT - org.simpleframework.http.Status
-
This is used to tell the client that there has been a conflict.
- connect(Session) - Method in interface org.simpleframework.http.socket.service.Service
-
This method connects a new session with a service implementation.
- CONNECT - Static variable in interface org.simpleframework.http.Method
-
For use with a proxy that can dynamically switch to being a tunnel.
- CONNECTION - Static variable in interface org.simpleframework.http.Protocol
-
Specifies options that are desired for that particular connection.
- consume(ByteCursor) - Method in class org.simpleframework.http.message.ArrayConsumer
-
This method is used to consume bytes from the provided cursor.
- consume(ByteCursor) - Method in interface org.simpleframework.http.message.ByteConsumer
-
This method is used to consume bytes from the provided cursor.
- consume(ByteCursor) - Method in class org.simpleframework.http.message.EmptyConsumer
-
This method will not consume any bytes from the cursor.
- consume(ByteCursor) - Method in class org.simpleframework.http.message.EntityConsumer
-
This consumes the header and body from the cursor.
- consume(ByteCursor) - Method in class org.simpleframework.http.message.FileUploadConsumer
-
This method is used to consume bytes from the provided cursor.
- consume(ByteCursor) - Method in class org.simpleframework.http.message.UpdateConsumer
-
This method is used to consume bytes from the provided cursor.
- Container - Interface in org.simpleframework.http.core
-
The
Container
object is used to process HTTP requests and compose HTTP responses. - ContainerEvent - Enum in org.simpleframework.http.core
-
The
ContainerEvent
enum represents events that occur when processing a HTTP transaction. - ContainerSocketProcessor - Class in org.simpleframework.http.core
-
The
ContainerSocketProcessor
object is a connector that dispatch requests from a connected pipeline. - ContainerSocketProcessor(Container) - Constructor for class org.simpleframework.http.core.ContainerSocketProcessor
-
Constructor for the
ContainerSocketProcessor
object. - ContainerSocketProcessor(Container, int) - Constructor for class org.simpleframework.http.core.ContainerSocketProcessor
-
Constructor for the
ContainerSocketProcessor
object. - ContainerSocketProcessor(Container, int, int) - Constructor for class org.simpleframework.http.core.ContainerSocketProcessor
-
Constructor for the
ContainerSocketProcessor
object. - ContainerSocketProcessor(Container, Allocator) - Constructor for class org.simpleframework.http.core.ContainerSocketProcessor
-
Constructor for the
ContainerSocketProcessor
object. - ContainerSocketProcessor(Container, Allocator, int) - Constructor for class org.simpleframework.http.core.ContainerSocketProcessor
-
Constructor for the
ContainerSocketProcessor
object. - ContainerSocketProcessor(Container, Allocator, int, int) - Constructor for class org.simpleframework.http.core.ContainerSocketProcessor
-
Constructor for the
ContainerSocketProcessor
object. - ContainerTransportProcessor - Class in org.simpleframework.http.core
-
The
ContainerProcessor
object is used to create channels which can be used to consume and process requests. - ContainerTransportProcessor(Container, Allocator, int) - Constructor for class org.simpleframework.http.core.ContainerTransportProcessor
-
Constructor for the
ContainerProcessor
object. - ContainerTransportProcessor(Container, Allocator, int, int) - Constructor for class org.simpleframework.http.core.ContainerTransportProcessor
-
Constructor for the
ContainerProcessor
object. - CONTENT_DISPOSITION - Static variable in interface org.simpleframework.http.Protocol
-
Specifies a tag indicating of its desired presentation semantics.
- CONTENT_ENCODING - Static variable in interface org.simpleframework.http.Protocol
-
Indicates additional content codings have been applied to the body.
- CONTENT_LANGUAGE - Static variable in interface org.simpleframework.http.Protocol
-
Describes the languages of the intended audience for the body.
- CONTENT_LENGTH - Static variable in interface org.simpleframework.http.Protocol
-
Indicates the size of the entity body in decimal number of octets.
- CONTENT_LOCATION - Static variable in interface org.simpleframework.http.Protocol
-
Used to supply the resource location for the entity enclosed.
- CONTENT_MD5 - Static variable in interface org.simpleframework.http.Protocol
-
An MD5 digest of the body for the purpose of checking integrity.
- CONTENT_RANGE - Static variable in interface org.simpleframework.http.Protocol
-
Specifies where in the full body a partial body should be applied.
- CONTENT_TYPE - Static variable in interface org.simpleframework.http.Protocol
-
Indicates the media type of the body sent to the recipient.
- ContentDisposition - Interface in org.simpleframework.http
-
The
ContentDisposition
object represents the HTTP Content-Disposition header of a request. - ContentDispositionParser - Class in org.simpleframework.http.parse
-
The
ContentDispositionParser
object is used to represent a parser used to parse the Content-Disposition header. - ContentDispositionParser() - Constructor for class org.simpleframework.http.parse.ContentDispositionParser
-
Constructor for the
ContentDispositionParser
object. - ContentDispositionParser(String) - Constructor for class org.simpleframework.http.parse.ContentDispositionParser
-
Constructor for the
ContentDispositionParser
object. - ContentType - Interface in org.simpleframework.http
-
This provides access to the MIME type parts, that is the primary type, the secondary type and an optional character set parameter.
- ContentTypeParser - Class in org.simpleframework.http.parse
-
This provides access to the MIME type parts, that is the primary type, the secondary type and an optional character set parameter.
- ContentTypeParser() - Constructor for class org.simpleframework.http.parse.ContentTypeParser
-
The default constructor will create a
ContentParser
that contains no charset, primary or secondary. - ContentTypeParser(String) - Constructor for class org.simpleframework.http.parse.ContentTypeParser
-
This is primarily a convenience constructor.
- CONTINUATION - org.simpleframework.http.socket.FrameType
-
A continuation frame identifies a fragment from a larger message.
- CONTINUE - org.simpleframework.http.Status
-
This is used as an intermediate response to a request.
- Conversation - Class in org.simpleframework.http.core
-
The
Conversation
object is used to set and interpret the semantics of the HTTP headers with regard to the encoding used for the response. - Conversation(RequestHeader, ResponseHeader) - Constructor for class org.simpleframework.http.core.Conversation
-
Constructor for the
Conversation
object. - convert(byte[]) - Method in class org.simpleframework.http.socket.DataConverter
-
This method is used to convert data using the character encoding specified when constructing the converter.
- convert(byte[], int, int) - Method in class org.simpleframework.http.socket.DataConverter
-
This method is used to convert data using the character encoding specified when constructing the converter.
- convert(long) - Method in class org.simpleframework.http.parse.DateParser
-
Convenience method used to convert the specified long date in to a HTTP date format.
- convert(String) - Method in class org.simpleframework.http.parse.DateParser
-
Convenience method used to convert the specified HTTP date in to a long representing the time.
- convert(String) - Method in class org.simpleframework.http.socket.DataConverter
-
This method is used to convert text using the character encoding specified when constructing the converter.
- cookie(String) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This will accept any cookie header and parse it such that all cookies within it are converted to
Cookie
objects and made available as typed objects. - Cookie - Class in org.simpleframework.http
-
This class is used to represent a generic cookie.
- Cookie(String, String) - Constructor for class org.simpleframework.http.Cookie
-
Constructor of the
Cookie
that uses a default version of 1, which is used by RFC 2109. - Cookie(String, String, boolean) - Constructor for class org.simpleframework.http.Cookie
-
Constructor of the
Cookie
that uses a default version of 1, which is used by RFC 2109. - Cookie(String, String, String) - Constructor for class org.simpleframework.http.Cookie
-
Constructor of the
Cookie
that uses a default version of 1, which is used by RFC 2109. - Cookie(String, String, String, boolean) - Constructor for class org.simpleframework.http.Cookie
-
Constructor of the
Cookie
that uses a default version of 1, which is used by RFC 2109. - COOKIE - Static variable in interface org.simpleframework.http.Protocol
-
Represents a cookie that contains some information from the client.
- CookieParser - Class in org.simpleframework.http.parse
-
CookieParser is used to parse the cookie header.
- CookieParser() - Constructor for class org.simpleframework.http.parse.CookieParser
-
Create a
CookieParser
that contains no cookies. - CookieParser(String) - Constructor for class org.simpleframework.http.parse.CookieParser
-
This is primarily a convineance constructor.
- cookies - Variable in class org.simpleframework.http.message.SegmentConsumer
-
This is used to parse the cookie headers that are consumed.
- count - Variable in class org.simpleframework.http.message.ArrayConsumer
-
This is the number of bytes that have been consumed so far.
- create(char[], int, int) - Method in class org.simpleframework.http.parse.LanguageParser
-
This creates a locale object using an offset and a length.
- create(char[], int, int) - Method in class org.simpleframework.http.parse.ListParser
-
This creates an value object using the range of characters that have been parsed as an item within the list of values.
- create(char[], int, int) - Method in class org.simpleframework.http.parse.ValueParser
-
This creates a string object using an offset and a length.
- CREATED - org.simpleframework.http.Status
-
This is used to signify that a resource was created successfully.
D
- Data - Interface in org.simpleframework.http.socket
-
The
Data
interface represents a payload for a WebScoket frame. - DataConverter - Class in org.simpleframework.http.socket
-
The
DataConverter
object is used to convert binary data to text data and vice versa. - DataConverter() - Constructor for class org.simpleframework.http.socket.DataConverter
-
Constructor for the
DataConverter
object. - DataConverter(String) - Constructor for class org.simpleframework.http.socket.DataConverter
-
Constructor for the
DataConverter
object. - DataFrame - Class in org.simpleframework.http.socket
-
The
DataFrame
object represents a frame as defined in RFC 6455. - DataFrame(FrameType) - Constructor for class org.simpleframework.http.socket.DataFrame
-
Constructor for the
DataFrame
object. - DataFrame(FrameType, byte[]) - Constructor for class org.simpleframework.http.socket.DataFrame
-
Constructor for the
DataFrame
object. - DataFrame(FrameType, byte[], boolean) - Constructor for class org.simpleframework.http.socket.DataFrame
-
Constructor for the
DataFrame
object. - DataFrame(FrameType, String) - Constructor for class org.simpleframework.http.socket.DataFrame
-
Constructor for the
DataFrame
object. - DataFrame(FrameType, String, boolean) - Constructor for class org.simpleframework.http.socket.DataFrame
-
Constructor for the
DataFrame
object. - DataFrame(FrameType, Data) - Constructor for class org.simpleframework.http.socket.DataFrame
-
Constructor for the
DataFrame
object. - DataFrame(FrameType, Data, boolean) - Constructor for class org.simpleframework.http.socket.DataFrame
-
Constructor for the
DataFrame
object. - DATE - Static variable in interface org.simpleframework.http.Protocol
-
Represents the date and time at which the message was originated.
- DateParser - Class in org.simpleframework.http.parse
-
This is used to create a
Parser
for the HTTP date format. - DateParser() - Constructor for class org.simpleframework.http.parse.DateParser
-
The default constructor will create a parser that can parse
String
s that contain dates in the form of RFC 1123, RFC 850 or asctime. - DateParser(long) - Constructor for class org.simpleframework.http.parse.DateParser
-
This constructor will conveniently parse the
long
argument in the constructor. - DateParser(String) - Constructor for class org.simpleframework.http.parse.DateParser
-
This constructor will conveniently parse the
String
argument in the constructor. - DELETE - Static variable in interface org.simpleframework.http.Method
-
Requests that the origin server delete the resource identified.
- description - Variable in enum org.simpleframework.http.Status
-
This is the description of the status this instance represents.
- digit(byte) - Method in class org.simpleframework.http.message.RequestConsumer
-
This is used to determine if a given ISO-8859-1 byte is a digit character, between an ISO-8859-1 0 and 9.
- DirectRouter - Class in org.simpleframework.http.socket.service
-
The
DirectRouter
object is used to create a router that uses a single service. - DirectRouter(Service) - Constructor for class org.simpleframework.http.socket.service.DirectRouter
-
Constructor for the
DirectRouter
object. - DirectRouter(Service, String) - Constructor for class org.simpleframework.http.socket.service.DirectRouter
-
Constructor for the
DirectRouter
object. - DISPATCH_CONTINUE - org.simpleframework.http.core.ContainerEvent
-
This event indicates that the server sent a HTTP continue reply.
- DISPATCH_FINISHED - org.simpleframework.http.core.ContainerEvent
-
This indicates that the dispatch thread has completed the dispatch.
- DISPATCH_REQUEST - org.simpleframework.http.core.ContainerEvent
-
This indicates that the request has been dispatched for processing.
- DISPATCH_SOCKET - org.simpleframework.http.socket.service.ServiceEvent
-
This event is dispatched when a WebSocket is dispatched.
- dispatcher - Variable in class org.simpleframework.http.message.EntityConsumer
-
This is used to determine if there a continue is expected.
- disposition - Variable in class org.simpleframework.http.message.SegmentConsumer
-
This is used to represent the content disposition header.
- disposition(String) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is used to parse the content disposition header header so that the MIME type is available to the segment.
- done - Variable in class org.simpleframework.http.message.ArrayConsumer
-
This determines whether the terminal token has been read.
E
- EmptyConsumer - Class in org.simpleframework.http.message
-
The
EmptyConsumer
object is used to represent a body of zero length. - EmptyConsumer() - Constructor for class org.simpleframework.http.message.EmptyConsumer
- encoding - Variable in class org.simpleframework.http.message.SegmentConsumer
-
This represents the transfer encoding value of the body.
- encoding(String) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is used to store the transfer encoding header value.
- end() - Method in class org.simpleframework.http.message.SegmentConsumer
-
This will update the offset variable so that the next read will be a non whitespace character or terminal character.
- Entity - Interface in org.simpleframework.http.message
-
The
Entity
object is used to represent the HTTP entity received from the client. - EntityConsumer - Class in org.simpleframework.http.message
-
The
EntityConsumer
object is used to consume data from a cursor and build a request entity. - EntityConsumer(Allocator, Channel) - Constructor for class org.simpleframework.http.message.EntityConsumer
-
Constructor for the
EntityConsumer
object. - equal(String, String) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is used to determine if two header names are equal, this is done to ensure that the case insensitivity of HTTP header names is observed.
- ERROR - org.simpleframework.http.core.ContainerEvent
-
This indicates that there was some error event with the request.
- ERROR - org.simpleframework.http.socket.service.ServiceEvent
-
This event is dispatched when an error occurs with a WebSocket.
- ETAG - Static variable in interface org.simpleframework.http.Protocol
-
Provides the value of the entity tag for the requested variant.
- expect - Variable in class org.simpleframework.http.message.SegmentConsumer
-
This is used to determine if there is a continue expected.
- expect(String) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is used to determine if the expect continue header is present and thus there is a requirement to send the continue status before the client sends the request body.
- EXPECT - Static variable in interface org.simpleframework.http.Protocol
-
Indicate that particular server behaviors are required by the client.
- EXPECTATION_FAILED - org.simpleframework.http.Status
-
This is used to tell the client that the expectation has failed.
- EXPIRES - Static variable in interface org.simpleframework.http.Protocol
-
Gives the time after which the response is considered stale.
F
- factory - Variable in class org.simpleframework.http.message.EntityConsumer
-
This is used to create a body consumer for the entity.
- FileUploadConsumer - Class in org.simpleframework.http.message
-
The
FileUploadConsumer
object is used to consume a list of parts encoded in the multipart format. - FileUploadConsumer(Allocator, byte[], long) - Constructor for class org.simpleframework.http.message.FileUploadConsumer
-
Constructor for the
FileUploadConsumer
object. - finished - Variable in class org.simpleframework.http.message.UpdateConsumer
-
This is used to determine whether the consumer has finished.
- FixedLengthConsumer - Class in org.simpleframework.http.message
-
The
FixedLengthConsumer
object reads a fixed number of bytes from a cursor. - FixedLengthConsumer(Allocator, long) - Constructor for class org.simpleframework.http.message.FixedLengthConsumer
-
Constructor for the
FixedLengthConsumer
object. - FORBIDDEN - org.simpleframework.http.Status
-
This is used to tell the client that the resource is forbidden.
- FOUND - org.simpleframework.http.Status
-
This is used to represent a resource that has been found.
- Frame - Interface in org.simpleframework.http.socket
-
The
Frame
interface represents a frame as defined in RFC 6455. - FrameChannel - Interface in org.simpleframework.http.socket
-
The
FrameChannel
represents a full duplex communication channel as defined by RFC 6455. - FrameListener - Interface in org.simpleframework.http.socket
-
The
FrameListener
is used to listen for incoming frames on aWebSocket
. - FrameType - Enum in org.simpleframework.http.socket
-
The
FrameType
represents the set of opcodes defined in RFC 6455. - FROM - Static variable in interface org.simpleframework.http.Protocol
-
Address for the human user who controls the requesting user agent.
G
- GATEWAY_TIMEOUT - org.simpleframework.http.Status
-
This is used to tell the client there was a gateway timeout.
- GET - Static variable in interface org.simpleframework.http.Method
-
Retrieve whatever information is identified by the request.
- getAddress() - Method in interface org.simpleframework.http.message.Header
-
This is used to acquire the address from the request line.
- getAddress() - Method in class org.simpleframework.http.message.RequestConsumer
-
This is used to acquire the address from the request line.
- getAddress() - Method in interface org.simpleframework.http.RequestLine
-
This is used to acquire the address from the request line.
- getAddress() - Method in class org.simpleframework.http.RequestWrapper
-
This is used to acquire the address from the request line.
- getAll(Object) - Method in interface org.simpleframework.http.Query
-
This method is used to acquire a
List
for all of the parameter values associated with the specified name. - getAll(String) - Method in interface org.simpleframework.http.message.Message
-
This is used to acquire all the individual header values from the message.
- getAll(String) - Method in class org.simpleframework.http.message.MessageHeader
-
This is used to acquire all the individual header values from the message.
- getAttribute(Object) - Method in interface org.simpleframework.http.Request
-
This is used as a shortcut for acquiring attributes for the response.
- getAttribute(Object) - Method in class org.simpleframework.http.RequestWrapper
-
This is used as a shortcut for acquiring attributes for the response.
- getAttribute(Object) - Method in interface org.simpleframework.http.socket.Session
-
This is used as a shortcut for acquiring attributes for the response.
- getAttributes() - Method in interface org.simpleframework.http.Request
-
This can be used to retrieve the response attributes.
- getAttributes() - Method in class org.simpleframework.http.RequestWrapper
-
This can be used to retrieve the response attributes.
- getAttributes() - Method in interface org.simpleframework.http.socket.Session
-
This can be used to retrieve the response attributes.
- getBinary() - Method in class org.simpleframework.http.socket.BinaryData
-
This returns the binary payload that is to be sent with a frame.
- getBinary() - Method in interface org.simpleframework.http.socket.Data
-
This returns the binary payload that is to be sent with a frame.
- getBinary() - Method in class org.simpleframework.http.socket.DataFrame
-
This returns the binary payload that is to be sent with the frame.
- getBinary() - Method in interface org.simpleframework.http.socket.Frame
-
This returns the binary payload that is to be sent with the frame.
- getBinary() - Method in class org.simpleframework.http.socket.TextData
-
This returns the binary payload that is to be sent with a frame.
- getBody() - Method in interface org.simpleframework.http.message.BodyConsumer
-
This is used to acquire the body that has been consumed.
- getBody() - Method in class org.simpleframework.http.message.ChunkedConsumer
-
This is used to acquire the body that has been consumed.
- getBody() - Method in class org.simpleframework.http.message.EmptyConsumer
-
This is used to acquire the body that has been consumed.
- getBody() - Method in interface org.simpleframework.http.message.Entity
-
This is used to acquire the body for this HTTP entity.
- getBody() - Method in class org.simpleframework.http.message.EntityConsumer
-
This is used to acquire the body for this HTTP entity.
- getBody() - Method in class org.simpleframework.http.message.FileUploadConsumer
-
This is used to acquire the body that has been consumed.
- getBody() - Method in class org.simpleframework.http.message.FixedLengthConsumer
-
This is used to acquire the body that has been consumed.
- getBoolean(Object) - Method in class org.simpleframework.http.parse.QueryParser
-
This extracts a boolean parameter for the named value.
- getBoolean(Object) - Method in interface org.simpleframework.http.Query
-
This extracts a boolean parameter for the named value.
- getByteChannel() - Method in interface org.simpleframework.http.Request
-
This is used to read the content body.
- getByteChannel() - Method in class org.simpleframework.http.RequestWrapper
-
This is used to read the content body.
- getByteChannel() - Method in interface org.simpleframework.http.Response
-
Used to write a message body with the
Response
. - getByteChannel() - Method in class org.simpleframework.http.ResponseWrapper
-
Used to write a message body with the
Response
. - getByteChannel(int) - Method in interface org.simpleframework.http.Response
-
Used to write a message body with the
Response
. - getByteChannel(int) - Method in class org.simpleframework.http.ResponseWrapper
-
Used to write a message body with the
Response
. - getChannel() - Method in interface org.simpleframework.http.message.Entity
-
This provides the connected channel for the client.
- getChannel() - Method in interface org.simpleframework.http.Request
-
This provides the underlying channel for the request.
- getChannel() - Method in class org.simpleframework.http.RequestWrapper
-
This provides the underlying channel for the request.
- getChannel() - Method in interface org.simpleframework.http.socket.Session
-
Provides a
FrameChannel
that can be used to communicate with the connected client. - getCharset() - Method in interface org.simpleframework.http.ContentType
-
This is used to retrieve the
charset
of this MIME type. - getCharset() - Method in class org.simpleframework.http.parse.ContentTypeParser
-
This is used to retrieve the
charset
of this MIME type. - getClientAddress() - Method in interface org.simpleframework.http.Request
-
This is used to acquire the remote client address.
- getClientAddress() - Method in class org.simpleframework.http.RequestWrapper
-
This is used to acquire the remote client address.
- getClientCertificate() - Method in interface org.simpleframework.http.Request
-
This is used to acquire the SSL certificate used when the server is using a HTTPS connection.
- getClientCertificate() - Method in class org.simpleframework.http.RequestWrapper
-
This is used to acquire the SSL certificate used when the server is using a HTTPS connection.
- getCode() - Method in class org.simpleframework.http.ResponseWrapper
-
This represents the status code of the HTTP response.
- getCode() - Method in class org.simpleframework.http.socket.Reason
-
This is used to get the RFC 6455 code describing the type of close event.
- getCode() - Method in enum org.simpleframework.http.Status
-
This is used to acquire the code of the status object.
- getCode() - Method in interface org.simpleframework.http.StatusLine
-
This represents the status code of the HTTP response.
- getContent() - Method in interface org.simpleframework.http.message.Body
-
This will acquire the contents of the body in UTF-8.
- getContent() - Method in interface org.simpleframework.http.Part
-
This is used to acquire the content of the part as a string.
- getContent() - Method in interface org.simpleframework.http.Request
-
This is used to get the content body.
- getContent() - Method in class org.simpleframework.http.RequestWrapper
-
This is used to get the content body.
- getContent(String) - Method in interface org.simpleframework.http.message.Body
-
This will acquire the contents of the body in the specified charset.
- getContentLength() - Method in class org.simpleframework.http.core.Conversation
-
This is used to acquire the content length for the response.
- getContentLength() - Method in interface org.simpleframework.http.message.Segment
-
This is a convenience method that can be used to determine the length of the message body.
- getContentLength() - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is a convenience method that can be used to determine the length of the message body.
- getContentLength() - Method in interface org.simpleframework.http.RequestHeader
-
This is a convenience method that can be used to determine the length of the message body.
- getContentLength() - Method in class org.simpleframework.http.RequestWrapper
-
This is a convenience method that can be used to determine the length of the message body.
- getContentLength() - Method in interface org.simpleframework.http.ResponseHeader
-
This is a convenience method that can be used to determine the length of the message body.
- getContentLength() - Method in class org.simpleframework.http.ResponseWrapper
-
This is a convenience method that can be used to determine the length of the message body.
- getContentType() - Method in interface org.simpleframework.http.message.Segment
-
This is a convenience method that can be used to determine the content type of the message body.
- getContentType() - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is a convenience method that can be used to determine the content type of the message body.
- getContentType() - Method in interface org.simpleframework.http.Part
-
This is used to acquire the content type for this part.
- getContentType() - Method in interface org.simpleframework.http.RequestHeader
-
This is a convenience method that can be used to determine the content type of the message body.
- getContentType() - Method in class org.simpleframework.http.RequestWrapper
-
This is a convenience method that can be used to determine the content type of the message body.
- getContentType() - Method in interface org.simpleframework.http.ResponseHeader
-
This is a convenience method that can be used to determine the content type of the message body.
- getContentType() - Method in class org.simpleframework.http.ResponseWrapper
-
This is a convenience method that can be used to determine the content type of the message body.
- getCookie(String) - Method in interface org.simpleframework.http.message.Header
-
This is used to acquire a cookie usiing the name of that cookie.
- getCookie(String) - Method in class org.simpleframework.http.message.HeaderConsumer
-
This is used to acquire a cookie using the name of that cookie.
- getCookie(String) - Method in interface org.simpleframework.http.message.Message
-
This returns the
Cookie
object stored under the specified name. - getCookie(String) - Method in class org.simpleframework.http.message.MessageHeader
-
This returns the
Cookie
object stored under the specified name. - getCookie(String) - Method in interface org.simpleframework.http.RequestHeader
-
This is used to acquire a cookie using the name of that cookie.
- getCookie(String) - Method in class org.simpleframework.http.RequestWrapper
-
This is used to acquire a cookie usiing the name of that cookie.
- getCookie(String) - Method in interface org.simpleframework.http.ResponseHeader
-
This returns the
Cookie
object stored under the specified name. - getCookie(String) - Method in class org.simpleframework.http.ResponseWrapper
-
This returns the
Cookie
object stored under the specified name. - getCookies() - Method in interface org.simpleframework.http.message.Header
-
This is used to acquire all cookies that were sent in the header.
- getCookies() - Method in class org.simpleframework.http.message.HeaderConsumer
-
This is used to acquire all cookies that were sent in the header.
- getCookies() - Method in interface org.simpleframework.http.message.Message
-
This returns all
Cookie
objects stored under the specified name. - getCookies() - Method in class org.simpleframework.http.message.MessageHeader
-
This returns all
Cookie
objects stored under the specified name. - getCookies() - Method in interface org.simpleframework.http.RequestHeader
-
This is used to acquire all cookies that were sent in the header.
- getCookies() - Method in class org.simpleframework.http.RequestWrapper
-
This is used to acquire all cookies that were sent in the header.
- getCookies() - Method in interface org.simpleframework.http.ResponseHeader
-
This returns all
Cookie
objects stored under the specified name. - getCookies() - Method in class org.simpleframework.http.ResponseWrapper
-
This returns all
Cookie
objects stored under the specified name. - getData() - Method in enum org.simpleframework.http.socket.CloseCode
-
This is the data that represents the closure code.
- getDate(String) - Method in interface org.simpleframework.http.message.Header
-
This can be used to get the date of the first message header that has the specified name.
- getDate(String) - Method in class org.simpleframework.http.message.HeaderConsumer
-
This can be used to get the date of the first message header that has the specified name.
- getDate(String) - Method in interface org.simpleframework.http.message.Message
-
This can be used to get the value of the first message header that has the specified name.
- getDate(String) - Method in class org.simpleframework.http.message.MessageHeader
-
This can be used to get the value of the first message header that has the specified name.
- getDate(String) - Method in class org.simpleframework.http.message.RequestConsumer
-
This can be used to get the date of the first message header that has the specified name.
- getDate(String) - Method in interface org.simpleframework.http.RequestHeader
-
This can be used to get the date of the first message header that has the specified name.
- getDate(String) - Method in class org.simpleframework.http.RequestWrapper
-
This can be used to get the date of the first message header that has the specified name.
- getDate(String) - Method in interface org.simpleframework.http.ResponseHeader
-
This can be used to get the value of the first message header that has the specified name.
- getDate(String) - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to get the value of the first message header that has the specified name.
- getDescription() - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to retrieve the text of a HTTP status line.
- getDescription() - Method in enum org.simpleframework.http.Status
-
This is used to provide the status description.
- getDescription() - Method in interface org.simpleframework.http.StatusLine
-
This can be used to retrieve the text of a HTTP status line.
- getDescription(int) - Static method in enum org.simpleframework.http.Status
-
This is used to provide the status description.
- getDirectory() - Method in class org.simpleframework.http.parse.PathParser
-
This will return the highest directory that exists within the path.
- getDirectory() - Method in interface org.simpleframework.http.Path
-
This will return the highest directory that exists within the path.
- getDisposition() - Method in interface org.simpleframework.http.message.Segment
-
This is a convenience method that can be used to determine the content type of the message body.
- getDisposition() - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is a convenience method that can be used to determine the content type of the message body.
- getDomain() - Method in interface org.simpleframework.http.Address
-
This is used to retrieve the domain of this URI.
- getDomain() - Method in class org.simpleframework.http.Cookie
-
This returns the domain for this cookie.
- getDomain() - Method in class org.simpleframework.http.parse.AddressParser
-
This is used to retrieve the domain of this URI.
- getExpiry() - Method in class org.simpleframework.http.Cookie
-
This returns the number of seconds a cookie lives for.
- getExtension() - Method in class org.simpleframework.http.parse.PathParser
-
This will return the extension that the file name contains.
- getExtension() - Method in interface org.simpleframework.http.Path
-
This will return the extension that the file name contains.
- getFileName() - Method in interface org.simpleframework.http.ContentDisposition
-
This method is used to acquire the file name of the part.
- getFileName() - Method in interface org.simpleframework.http.message.Segment
-
This method is used to acquire the file name of the part.
- getFileName() - Method in class org.simpleframework.http.message.SegmentConsumer
-
This method is used to acquire the file name of the part.
- getFileName() - Method in class org.simpleframework.http.parse.ContentDispositionParser
-
This method is used to acquire the file name of the part.
- getFileName() - Method in interface org.simpleframework.http.Part
-
This method is used to acquire the file name of the part.
- getFloat(Object) - Method in class org.simpleframework.http.parse.QueryParser
-
This extracts a float parameter for the named value.
- getFloat(Object) - Method in interface org.simpleframework.http.Query
-
This extracts a float parameter for the named value.
- getFrame(FrameType) - Method in class org.simpleframework.http.socket.DataFrame
-
This method is used to convert from one frame type to another.
- getFrame(FrameType) - Method in interface org.simpleframework.http.socket.Frame
-
This method is used to convert from one frame type to another.
- getHeader() - Method in interface org.simpleframework.http.message.Entity
-
This provides the HTTP request header for the entity.
- getHeader() - Method in class org.simpleframework.http.message.EntityConsumer
-
This provides the HTTP request header for the entity.
- getHeader() - Method in interface org.simpleframework.http.message.Header
-
This method returns a
CharSequence
holding the data consumed for the request. - getHeader() - Method in class org.simpleframework.http.message.RequestConsumer
-
This method returns a
CharSequence
holding the data consumed for the request. - getHeader() - Method in interface org.simpleframework.http.RequestHeader
-
This method returns a
CharSequence
holding the header consumed for the request. - getHeader() - Method in class org.simpleframework.http.RequestWrapper
-
This method returns a
CharSequence
holding the header consumed for the request. - getHeader() - Method in interface org.simpleframework.http.ResponseHeader
-
This method returns a
CharSequence
holding the header created for the request. - getHeader() - Method in class org.simpleframework.http.ResponseWrapper
-
This method returns a
CharSequence
holding the header created for the request. - getHeader(String) - Method in interface org.simpleframework.http.Part
-
This is used to acquire the header value for the specified header name.
- getInputStream() - Method in interface org.simpleframework.http.message.Body
-
This is used to acquire the contents of the body as a stream.
- getInputStream() - Method in interface org.simpleframework.http.Part
-
This is used to acquire an
InputStream
for the part. - getInputStream() - Method in interface org.simpleframework.http.Request
-
This is used to read the content body.
- getInputStream() - Method in class org.simpleframework.http.RequestWrapper
-
This is used to read the content body.
- getInteger(Object) - Method in class org.simpleframework.http.parse.QueryParser
-
This extracts an integer parameter for the named value.
- getInteger(Object) - Method in interface org.simpleframework.http.Query
-
This extracts an integer parameter for the named value.
- getInteger(String) - Method in interface org.simpleframework.http.message.Header
-
This can be used to get the integer of the first message header that has the specified name.
- getInteger(String) - Method in class org.simpleframework.http.message.HeaderConsumer
-
This can be used to get the integer of the first message header that has the specified name.
- getInteger(String) - Method in interface org.simpleframework.http.message.Message
-
This can be used to get the value of the first message header that has the specified name.
- getInteger(String) - Method in class org.simpleframework.http.message.MessageHeader
-
This can be used to get the value of the first message header that has the specified name.
- getInteger(String) - Method in class org.simpleframework.http.message.RequestConsumer
-
This can be used to get the integer of the first message header that has the specified name.
- getInteger(String) - Method in interface org.simpleframework.http.RequestHeader
-
This can be used to get the integer of the first message header that has the specified name.
- getInteger(String) - Method in class org.simpleframework.http.RequestWrapper
-
This can be used to get the integer of the first message header that has the specified name.
- getInteger(String) - Method in interface org.simpleframework.http.ResponseHeader
-
This can be used to get the value of the first message header that has the specified name.
- getInteger(String) - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to get the value of the first message header that has the specified name.
- getLocales() - Method in interface org.simpleframework.http.message.Header
-
This is used to acquire the locales from the request header.
- getLocales() - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is used to acquire the locales from the request header.
- getLocales() - Method in interface org.simpleframework.http.RequestHeader
-
This is used to acquire the locales from the request header.
- getLocales() - Method in class org.simpleframework.http.RequestWrapper
-
This is used to acquire the locales from the request header.
- getLong(String) - Method in class org.simpleframework.http.message.MessageHeader
-
This can be used to get the value of the first message header that has the specified name.
- getMajor() - Method in interface org.simpleframework.http.message.Header
-
This can be used to get the major number from a HTTP version.
- getMajor() - Method in class org.simpleframework.http.message.RequestConsumer
-
This can be used to get the major number from a HTTP version.
- getMajor() - Method in interface org.simpleframework.http.RequestLine
-
This can be used to get the major number from a HTTP version.
- getMajor() - Method in class org.simpleframework.http.RequestWrapper
-
This can be used to get the major number from a HTTP version.
- getMajor() - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to get the major number from a HTTP version.
- getMajor() - Method in interface org.simpleframework.http.StatusLine
-
This can be used to get the major number from a HTTP version.
- getMethod() - Method in interface org.simpleframework.http.message.Header
-
This can be used to get the HTTP method for this request.
- getMethod() - Method in class org.simpleframework.http.message.RequestConsumer
-
This can be used to get the HTTP method for this request.
- getMethod() - Method in interface org.simpleframework.http.RequestLine
-
This can be used to get the HTTP method for this request.
- getMethod() - Method in class org.simpleframework.http.RequestWrapper
-
This can be used to get the HTTP method for this request.
- getMinor() - Method in interface org.simpleframework.http.message.Header
-
This can be used to get the minor number from a HTTP version.
- getMinor() - Method in class org.simpleframework.http.message.RequestConsumer
-
This can be used to get the minor number from a HTTP version.
- getMinor() - Method in interface org.simpleframework.http.RequestLine
-
This can be used to get the major number from a HTTP version.
- getMinor() - Method in class org.simpleframework.http.RequestWrapper
-
This can be used to get the major number from a HTTP version.
- getMinor() - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to get the minor number from a HTTP version.
- getMinor() - Method in interface org.simpleframework.http.StatusLine
-
This can be used to get the minor number from a HTTP version.
- getName() - Method in interface org.simpleframework.http.ContentDisposition
-
This method is used to acquire the name of the part.
- getName() - Method in class org.simpleframework.http.Cookie
-
This returns the name for this cookie.
- getName() - Method in interface org.simpleframework.http.message.Segment
-
This method is used to acquire the name of the part.
- getName() - Method in class org.simpleframework.http.message.SegmentConsumer
-
This method is used to acquire the name of the part.
- getName() - Method in class org.simpleframework.http.parse.ContentDispositionParser
-
This method is used to acquire the name of the part.
- getName() - Method in class org.simpleframework.http.parse.PathParser
-
This will return the full name of the file without the path.
- getName() - Method in class org.simpleframework.http.parse.PrincipalParser
-
Gets the users name from the Authorization header value.
- getName() - Method in interface org.simpleframework.http.Part
-
This method is used to acquire the name of the part.
- getName() - Method in interface org.simpleframework.http.Path
-
This will return the full name of the file without the path.
- getName() - Method in interface org.simpleframework.http.Principal
-
The
getName
method is used to retreive the name of the principal. - getNames() - Method in interface org.simpleframework.http.message.Header
-
This method is used to get a
List
of the names for the headers. - getNames() - Method in class org.simpleframework.http.message.HeaderConsumer
-
This method is used to get a
List
of the names for the headers. - getNames() - Method in interface org.simpleframework.http.message.Message
-
This is used to acquire the names of the of the headers that have been set in the response.
- getNames() - Method in class org.simpleframework.http.message.MessageHeader
-
This is used to acquire the names of the of the headers that have been set in the response.
- getNames() - Method in class org.simpleframework.http.message.RequestConsumer
-
This method is used to get a
List
of the names for the headers. - getNames() - Method in interface org.simpleframework.http.RequestHeader
-
This method is used to get a
List
of the names for the headers. - getNames() - Method in class org.simpleframework.http.RequestWrapper
-
This method is used to get a
List
of the names for the headers. - getNames() - Method in interface org.simpleframework.http.ResponseHeader
-
This is used to acquire the names of the of the headers that have been set in the response.
- getNames() - Method in class org.simpleframework.http.ResponseWrapper
-
This is used to acquire the names of the of the headers that have been set in the response.
- getOutputStream() - Method in interface org.simpleframework.http.Response
-
Used to write a message body with the
Response
. - getOutputStream() - Method in class org.simpleframework.http.ResponseWrapper
-
Used to write a message body with the
Response
. - getOutputStream(int) - Method in interface org.simpleframework.http.Response
-
Used to write a message body with the
Response
. - getOutputStream(int) - Method in class org.simpleframework.http.ResponseWrapper
-
Used to write a message body with the
Response
. - getParameter(String) - Method in interface org.simpleframework.http.ContentType
-
This is used to retrieve an arbitrary parameter from the MIME type header.
- getParameter(String) - Method in class org.simpleframework.http.parse.ContentTypeParser
-
This is used to retrieve an arbitrary parameter from the MIME type header.
- getParameter(String) - Method in interface org.simpleframework.http.Request
-
This is used to provide quick access to the parameters.
- getParameter(String) - Method in class org.simpleframework.http.RequestWrapper
-
This is used to provide quick access to the parameters.
- getParameters() - Method in interface org.simpleframework.http.Address
-
This extracts the parameter values from the uniform resource identifier represented by this object.
- getParameters() - Method in class org.simpleframework.http.parse.AddressParser
-
This extracts the parameter values from the uniform resource identifier represented by this object.
- getPart(String) - Method in interface org.simpleframework.http.message.Body
-
This method is used to acquire a
Part
from the HTTP request using a known name for the part. - getPart(String) - Method in interface org.simpleframework.http.Request
-
This method is used to acquire a
Part
from the HTTP request using a known name for the part. - getPart(String) - Method in class org.simpleframework.http.RequestWrapper
-
This method is used to acquire a
Part
from the HTTP request using a known name for the part. - getParts() - Method in interface org.simpleframework.http.message.Body
-
This method is used to get all
Part
objects that are associated with the request. - getParts() - Method in interface org.simpleframework.http.Request
-
This method is used to get all
Part
objects that are associated with the request. - getParts() - Method in class org.simpleframework.http.RequestWrapper
-
This method is used to get all
Part
objects that are associated with the request. - getPassword() - Method in class org.simpleframework.http.parse.PrincipalParser
-
Gets the users password parsed from the Authorization header value.
- getPassword() - Method in interface org.simpleframework.http.Principal
-
The
getPassword
method is used to retrieve the password of the principal. - getPath() - Method in interface org.simpleframework.http.Address
-
This is used to retrieve the path of this URI.
- getPath() - Method in class org.simpleframework.http.Cookie
-
This returns the path for this cookie.
- getPath() - Method in interface org.simpleframework.http.message.Header
-
This is used to acquire the path as extracted from the the HTTP request URI.
- getPath() - Method in class org.simpleframework.http.message.RequestConsumer
-
This is used to acquire the path as extracted from the the HTTP request URI.
- getPath() - Method in class org.simpleframework.http.parse.AddressParser
-
This is used to retrieve the path of this URI.
- getPath() - Method in class org.simpleframework.http.parse.PathParser
-
This will return the normalized path.
- getPath() - Method in interface org.simpleframework.http.Path
-
This will return the normalized path.
- getPath() - Method in interface org.simpleframework.http.RequestLine
-
This is used to acquire the path as extracted from the HTTP request URI.
- getPath() - Method in class org.simpleframework.http.RequestWrapper
-
This is used to acquire the path as extracted from the HTTP request URI.
- getPath(int) - Method in class org.simpleframework.http.parse.PathParser
-
This will return the normalized path from the specified path segment.
- getPath(int) - Method in interface org.simpleframework.http.Path
-
This will return the normalized path from the specified path segment.
- getPath(int, int) - Method in class org.simpleframework.http.parse.PathParser
-
This will return the normalized path from the specified path segment.
- getPath(int, int) - Method in interface org.simpleframework.http.Path
-
This will return the normalized path from the specified path segment.
- getPort() - Method in interface org.simpleframework.http.Address
-
This is used to retrieve the port of the uniform resource identifier.
- getPort() - Method in class org.simpleframework.http.parse.AddressParser
-
This is used to retrieve the port of the uniform resource identifier.
- getPrimary() - Method in interface org.simpleframework.http.ContentType
-
This is used to retrieve the primary type of this MIME type.
- getPrimary() - Method in class org.simpleframework.http.parse.ContentTypeParser
-
This is used to retrieve the primary type of this MIME type.
- getPrintStream() - Method in interface org.simpleframework.http.Response
-
This method is provided for convenience so that the HTTP content can be written using the
print
methods provided by thePrintStream
. - getPrintStream() - Method in class org.simpleframework.http.ResponseWrapper
-
This method is provided for convenience so that the HTTP content can be written using the
print
methods provided by thePrintStream
. - getPrintStream(int) - Method in interface org.simpleframework.http.Response
-
This method is provided for convenience so that the HTTP content can be written using the
print
methods provided by thePrintStream
. - getPrintStream(int) - Method in class org.simpleframework.http.ResponseWrapper
-
This method is provided for convenience so that the HTTP content can be written using the
print
methods provided by thePrintStream
. - getQuery() - Method in interface org.simpleframework.http.Address
-
This is used to retrieve the query of this URI.
- getQuery() - Method in interface org.simpleframework.http.message.Header
-
This method is used to acquire the query part from the HTTP request URI target.
- getQuery() - Method in class org.simpleframework.http.message.RequestConsumer
-
This method is used to acquire the query part from the HTTP request URI target.
- getQuery() - Method in class org.simpleframework.http.parse.AddressParser
-
This is used to retrieve the query of this URI.
- getQuery() - Method in interface org.simpleframework.http.RequestLine
-
This method is used to acquire the query part from the HTTP request URI target.
- getQuery() - Method in class org.simpleframework.http.RequestWrapper
-
This method is used to acquire the query part from the HTTP request URI target and a form post if it exists.
- getRelative(String) - Method in class org.simpleframework.http.parse.PathParser
-
This will return the path as it is relative to the issued path.
- getRelative(String) - Method in interface org.simpleframework.http.Path
-
This will return the path as it is relative to the issued path.
- getRequest() - Method in class org.simpleframework.http.core.Conversation
-
This provides the
Request
object. - getRequest() - Method in interface org.simpleframework.http.socket.Session
-
Provides the
Request
used to initiate the session. - getRequestTime() - Method in interface org.simpleframework.http.Request
-
This is the time in milliseconds when the request was first read from the underlying socket.
- getRequestTime() - Method in class org.simpleframework.http.RequestWrapper
-
This is the time in milliseconds when the request was first read from the underlying socket.
- getResponse() - Method in class org.simpleframework.http.core.Conversation
-
This provides the
Response
object. - getResponse() - Method in interface org.simpleframework.http.socket.Session
-
Provides the
Response
used to establish the session with the remote client. - getResponseTime() - Method in interface org.simpleframework.http.Response
-
This represents the time at which the response has fully written.
- getResponseTime() - Method in class org.simpleframework.http.ResponseWrapper
-
This represents the time at which the response has fully written.
- getScheme() - Method in interface org.simpleframework.http.Address
-
This allows the scheme of the URL given to be returned.
- getScheme() - Method in class org.simpleframework.http.parse.AddressParser
-
This allows the scheme of the URL given to be returned.
- getScheme() - Method in enum org.simpleframework.http.Scheme
-
This is used to acquire the scheme token for this.
- getSecondary() - Method in interface org.simpleframework.http.ContentType
-
This is used to retrieve the secondary type of this MIME type.
- getSecondary() - Method in class org.simpleframework.http.parse.ContentTypeParser
-
This is used to retrieve the secondary type of this MIME type.
- getSegments() - Method in class org.simpleframework.http.parse.PathParser
-
This method is used to break the path into individual parts called segments, see RFC 2396.
- getSegments() - Method in interface org.simpleframework.http.Path
-
This method is used to break the path into individual parts called segments, see RFC 2396.
- getStatus() - Method in class org.simpleframework.http.ResponseWrapper
-
This is used to acquire the status from the response.
- getStatus() - Method in interface org.simpleframework.http.StatusLine
-
This is used to acquire the status from the response.
- getStatus(int) - Static method in enum org.simpleframework.http.Status
-
This is used to provide the status value.
- getTarget() - Method in interface org.simpleframework.http.message.Header
-
This can be used to get the target specified for this HTTP request.
- getTarget() - Method in class org.simpleframework.http.message.RequestConsumer
-
This can be used to get the target specified for this HTTP request.
- getTarget() - Method in interface org.simpleframework.http.RequestLine
-
This can be used to get the URI specified for this HTTP request.
- getTarget() - Method in class org.simpleframework.http.RequestWrapper
-
This can be used to get the URI specified for this HTTP request.
- getText() - Method in class org.simpleframework.http.socket.BinaryData
-
This returns the text payload that is to be sent with a frame.
- getText() - Method in interface org.simpleframework.http.socket.Data
-
This returns the text payload that is to be sent with a frame.
- getText() - Method in class org.simpleframework.http.socket.DataFrame
-
This returns the text payload that is to be sent with the frame.
- getText() - Method in interface org.simpleframework.http.socket.Frame
-
This returns the text payload that is to be sent with the frame.
- getText() - Method in class org.simpleframework.http.socket.Reason
-
This is used to get the textual description for the closure.
- getText() - Method in class org.simpleframework.http.socket.TextData
-
This returns the text payload that is to be sent with a frame.
- getTime() - Method in interface org.simpleframework.http.message.Entity
-
This is the time in milliseconds when the request was first read from the underlying channel.
- getTransferEncoding() - Method in interface org.simpleframework.http.message.Segment
-
This is a convenience method that can be used to determine the content type of the message body.
- getTransferEncoding() - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is a convenience method that can be used to determine the content type of the message body.
- getTransferEncoding() - Method in interface org.simpleframework.http.ResponseHeader
-
This is a convenience method that can be used to determine the content type of the message body.
- getTransferEncoding() - Method in class org.simpleframework.http.ResponseWrapper
-
This is a convenience method that can be used to determine the content type of the message body.
- getType() - Method in interface org.simpleframework.http.ContentType
-
This method is used to get the primary and secondary parts joined together with a "/".
- getType() - Method in class org.simpleframework.http.parse.ContentTypeParser
-
This method is used to get the primary and secondary parts joined together with a "/".
- getType() - Method in class org.simpleframework.http.socket.DataFrame
-
This is used to determine the type of frame.
- getType() - Method in interface org.simpleframework.http.socket.Frame
-
This is used to determine the type of frame.
- getValue() - Method in class org.simpleframework.http.Cookie
-
This returns the value for this cookie.
- getValue(String) - Method in interface org.simpleframework.http.message.Message
-
This can be used to get the value of the first message header that has the specified name.
- getValue(String) - Method in class org.simpleframework.http.message.MessageHeader
-
This can be used to get the value of the first message header that has the specified name.
- getValue(String) - Method in interface org.simpleframework.http.message.Segment
-
This can be used to get the value of the first message header that has the specified name.
- getValue(String) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This can be used to get the value of the first message header that has the specified name.
- getValue(String) - Method in interface org.simpleframework.http.RequestHeader
-
This can be used to get the value of the first message header that has the specified name.
- getValue(String) - Method in class org.simpleframework.http.RequestWrapper
-
This can be used to get the value of the first message header that has the specified name.
- getValue(String) - Method in interface org.simpleframework.http.ResponseHeader
-
This can be used to get the value of the first message header that has the specified name.
- getValue(String) - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to get the value of the first message header that has the specified name.
- getValue(String, int) - Method in interface org.simpleframework.http.message.Message
-
This can be used to get the value of the first message header that has the specified name.
- getValue(String, int) - Method in class org.simpleframework.http.message.MessageHeader
-
This can be used to get the value of the first message header that has the specified name.
- getValue(String, int) - Method in interface org.simpleframework.http.message.Segment
-
This can be used to get the value of the first message header that has the specified name.
- getValue(String, int) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This can be used to get the value of the first message header that has the specified name.
- getValue(String, int) - Method in interface org.simpleframework.http.RequestHeader
-
This can be used to get the value of the first message header that has the specified name.
- getValue(String, int) - Method in class org.simpleframework.http.RequestWrapper
-
This can be used to get the value of the first message header that has the specified name.
- getValue(String, int) - Method in interface org.simpleframework.http.ResponseHeader
-
This can be used to get the value of the first message header that has the specified name.
- getValue(String, int) - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to get the value of the first message header that has the specified name.
- getValues(String) - Method in interface org.simpleframework.http.message.Message
-
This can be used to get the values of HTTP message headers that have the specified name.
- getValues(String) - Method in class org.simpleframework.http.message.MessageHeader
-
This can be used to get the values of HTTP message headers that have the specified name.
- getValues(String) - Method in interface org.simpleframework.http.message.Segment
-
This can be used to get the values of HTTP message headers that have the specified name.
- getValues(String) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This can be used to get the values of HTTP message headers that have the specified name.
- getValues(String) - Method in interface org.simpleframework.http.RequestHeader
-
This can be used to get the values of HTTP message headers that have the specified name.
- getValues(String) - Method in class org.simpleframework.http.RequestWrapper
-
This can be used to get the values of HTTP message headers that have the specified name.
- getValues(String) - Method in interface org.simpleframework.http.ResponseHeader
-
This can be used to get the values of HTTP message headers that have the specified name.
- getValues(String) - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to get the values of HTTP message headers that have the specified name.
- getValues(List<String>) - Method in interface org.simpleframework.http.message.Message
-
This can be used to get the values of HTTP message headers that have the specified name.
- getValues(List<String>) - Method in class org.simpleframework.http.message.MessageHeader
-
This can be used to get the values of HTTP message headers that have the specified name.
- getVersion() - Method in class org.simpleframework.http.Cookie
-
This returns the version for this cookie.
- GOING_AWAY - org.simpleframework.http.socket.CloseCode
-
Indicates that the server is going down or the client browsed away.
- GONE - org.simpleframework.http.Status
-
This is used to tell the client that the resource has gone.
H
- handle(Request, Response) - Method in interface org.simpleframework.http.core.Container
-
Used to pass the
Request
andResponse
to the container for processing. - handle(Request, Response) - Method in class org.simpleframework.http.socket.service.RouterContainer
-
This method is used to create a dispatch a
Session
to a specific service selected by a router. - HEAD - Static variable in interface org.simpleframework.http.Method
-
Retrieve only the headers for the resource that is requested.
- header - Variable in class org.simpleframework.http.message.EntityConsumer
-
This is used to consume the header for the request entity.
- header - Variable in class org.simpleframework.http.message.SegmentConsumer
-
This is used to store all consumed headers by the header name.
- Header - Interface in org.simpleframework.http.message
-
This is a
Header
object that is used to represent a basic form for the HTTP request message. - HEADER_FINISHED - org.simpleframework.http.core.ContainerEvent
-
This indicates that the server has fully read the request header.
- HeaderConsumer - Class in org.simpleframework.http.message
-
The
HeaderConsumer
object is used to consume a HTTP header from the cursor. - HeaderConsumer() - Constructor for class org.simpleframework.http.message.HeaderConsumer
-
Constructor for the
HeaderConsumer
object. - headers() - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is used to parse the headers from the consumed HTTP header and add them to the segment.
- high - Variable in enum org.simpleframework.http.socket.CloseCode
-
This is the high order byte for the closure code.
- HOST - Static variable in interface org.simpleframework.http.Protocol
-
Specifies the host and port number of the resource being requested.
- HTTP - org.simpleframework.http.Scheme
-
This represents the scheme for a plaintext HTTP connection.
- HTTPS - org.simpleframework.http.Scheme
-
This represents the scheme for a HTTP over TLS connection.
I
- IF_MATCH - Static variable in interface org.simpleframework.http.Protocol
-
Specifies the entity tag for a request to make it conditional.
- IF_MODIFIED_SINCE - Static variable in interface org.simpleframework.http.Protocol
-
If variant has not been modified since the time specified.
- IF_NONE_MATCH - Static variable in interface org.simpleframework.http.Protocol
-
Verify that none of those entities is current by including a list.
- IF_RANGE - Static variable in interface org.simpleframework.http.Protocol
-
If the entity is unchanged send me the part that I am missing.
- IF_UNMODIFIED_SINCE - Static variable in interface org.simpleframework.http.Protocol
-
If the requested resource has not been modified since this time.
- IMAGE - Static variable in interface org.simpleframework.http.Protocol
-
Represents a message type for an image such as a PNG or JPEG.
- init() - Method in class org.simpleframework.http.parse.AddressParser
-
This will empty each tokens cache.
- init() - Method in class org.simpleframework.http.parse.ContentDispositionParser
-
This will initialize the
Parser
when it is ready to parse a newString
. - init() - Method in class org.simpleframework.http.parse.ContentTypeParser
-
This will initialize the parser when it is ready to parse a new
String
. - init() - Method in class org.simpleframework.http.parse.CookieParser
-
Resets the cookie and the buffer variables for this
CookieParser
. - init() - Method in class org.simpleframework.http.parse.DateParser
-
This is used to reset the date and the buffer variables for this
DateParser
. - init() - Method in class org.simpleframework.http.parse.ListParser
-
Initializes the parser so that tokens can be extracted from the list.
- init() - Method in class org.simpleframework.http.parse.PathParser
-
This will initialize the parser so that it is in a ready state.
- init() - Method in class org.simpleframework.http.parse.PrincipalParser
-
This will initialize the
Parser
when it is ready to parse a newString
. - init() - Method in class org.simpleframework.http.parse.QueryParser
-
This initializes the parser so that it can be used several times.
- INTERNAL_SERVER_ERROR - org.simpleframework.http.socket.CloseCode
-
Indicates an unexpected error within the server.
- INTERNAL_SERVER_ERROR - org.simpleframework.http.Status
-
This is sent when the request has caused an internal server error.
- INVALID_FRAME_DATA - org.simpleframework.http.socket.CloseCode
-
Indicates that a payload was not consistent with the message type.
- isChunkable() - Method in class org.simpleframework.http.core.Conversation
-
The
isChunkable
method is used to determine if the client supports chunked encoding. - isChunkedEncoded() - Method in class org.simpleframework.http.core.Conversation
-
The
isChunkedEncoded
is used to determine whether the chunked encoding scheme is desired. - isClose() - Method in enum org.simpleframework.http.socket.FrameType
-
This is used to determine if a frame is a close frame.
- isCommitted() - Method in interface org.simpleframework.http.Response
-
This can be used to determine whether the
Response
has been committed. - isCommitted() - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to determine whether the
Response
has been committed. - isConnect() - Method in class org.simpleframework.http.core.Conversation
-
This is used to determine if the method was a CONNECT.
- isEmpty() - Method in class org.simpleframework.http.core.Conversation
-
This is used to determine if the
Response
has a message body. - isExpectContinue() - Method in interface org.simpleframework.http.message.Header
-
This is used to determine if the header represents one that requires the HTTP/1.1 continue expectation.
- isExpectContinue() - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is used to determine if the header represents one that requires the HTTP/1.1 continue expectation.
- isFile() - Method in interface org.simpleframework.http.ContentDisposition
-
This method is used to determine the type of a part.
- isFile() - Method in interface org.simpleframework.http.message.Segment
-
This method is used to determine the type of a part.
- isFile() - Method in class org.simpleframework.http.message.SegmentConsumer
-
This method is used to determine the type of a part.
- isFile() - Method in class org.simpleframework.http.parse.ContentDispositionParser
-
This method is used to determine the type of a part.
- isFile() - Method in interface org.simpleframework.http.Part
-
This method is used to determine the type of a part.
- isFinal() - Method in class org.simpleframework.http.socket.DataFrame
-
This is used to determine if the frame is the final frame in a sequence of fragments or a whole frame.
- isFinal() - Method in interface org.simpleframework.http.socket.Frame
-
This is used to determine if the frame is the final frame in a sequence of fragments or a whole frame.
- isFinished() - Method in class org.simpleframework.http.message.ArrayConsumer
-
When the terminal token is read from the cursor this will be true.
- isFinished() - Method in interface org.simpleframework.http.message.ByteConsumer
-
This is used to determine whether the consumer has finished reading.
- isFinished() - Method in class org.simpleframework.http.message.EmptyConsumer
-
This will return true immediately.
- isFinished() - Method in class org.simpleframework.http.message.EntityConsumer
-
This is determined finished when the body has been consumed.
- isFinished() - Method in class org.simpleframework.http.message.FileUploadConsumer
-
This is used to determine whether the consumer has finished reading.
- isFinished() - Method in class org.simpleframework.http.message.UpdateConsumer
-
This is used to determine whether the consumer has finished reading.
- isHead() - Method in class org.simpleframework.http.core.Conversation
-
This is used to determine if the request method was HEAD.
- isHeaderFinished() - Method in class org.simpleframework.http.message.EntityConsumer
-
This is used to determine if the header has finished.
- isKeepAlive() - Method in class org.simpleframework.http.core.Conversation
-
The
isKeepAlive
method is used to determine if the connection semantics are set to maintain the connection. - isKeepAlive() - Method in interface org.simpleframework.http.Request
-
This is a convenience method that is used to determine whether or not this message has the
Connection: close
header. - isKeepAlive() - Method in class org.simpleframework.http.RequestWrapper
-
This is a convenience method that is used to determine whether or not this message has the
Connection: close
header. - isKeepAlive() - Method in interface org.simpleframework.http.Response
-
This is used to determine if the HTTP response message is a keep alive message or if the underlying socket was closed.
- isKeepAlive() - Method in class org.simpleframework.http.ResponseWrapper
-
This is used to determine if the HTTP response message is a keep alive message or if the underlying socket was closed.
- isNew() - Method in class org.simpleframework.http.Cookie
-
This is used to determine if the cookie is new.
- isPersistent() - Method in class org.simpleframework.http.core.Conversation
-
This checks the protocol version used in the request to check whether it supports persistent HTTP connections.
- isPing() - Method in enum org.simpleframework.http.socket.FrameType
-
This is used to determine if a frame is a ping frame.
- isPong() - Method in enum org.simpleframework.http.socket.FrameType
-
This is used to determine if a frame is a pong frame.
- isProtected() - Method in class org.simpleframework.http.Cookie
-
This is used to determine if the cookie is protected against cross site scripting.
- isSecure() - Method in class org.simpleframework.http.Cookie
-
This determines whether the cookie is secure.
- isSecure() - Method in interface org.simpleframework.http.Request
-
This is used to determine if the request has been transferred over a secure connection.
- isSecure() - Method in class org.simpleframework.http.RequestWrapper
-
This is used to determine if the request has been transferred over a secure connection.
- isSecure() - Method in enum org.simpleframework.http.Scheme
-
This is used to determine if the scheme is secure or not.
- isText() - Method in enum org.simpleframework.http.socket.FrameType
-
This is used to determine if a frame is a text frame.
- isTunnel() - Method in class org.simpleframework.http.core.Conversation
-
This is used to determine if a tunnel should be established.
- isWebSocket() - Method in class org.simpleframework.http.core.Conversation
-
This is used to determine if a WebSocket upgrade was requested and established.
- iterator() - Method in class org.simpleframework.http.parse.CookieParser
-
This is used to acquire the cookie values from the provided the provided source text.
K
- KEEP_ALIVE - Static variable in interface org.simpleframework.http.Protocol
-
Specifies that the server wishes to keep the connection open.
L
- language - Variable in class org.simpleframework.http.message.SegmentConsumer
-
This is used to parse the languages accepted in the request.
- language(String) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is used to parse the
Accept-Language
header value. - LanguageParser - Class in org.simpleframework.http.parse
-
LanguageParser is used to parse the HTTP
Accept-Language
header. - LanguageParser() - Constructor for class org.simpleframework.http.parse.LanguageParser
-
This is used to create a
LanguageParser
for theAccept-Language
HTTP header value. - LanguageParser(String) - Constructor for class org.simpleframework.http.parse.LanguageParser
-
This is used to create a
LanguageParser
for theAccept-Language
HTTP header value. - LanguageParser(List<String>) - Constructor for class org.simpleframework.http.parse.LanguageParser
-
This is used to create a
LanguageParser
for theAccept-Language
HTTP header value. - LAST_MODIFIED - Static variable in interface org.simpleframework.http.Protocol
-
Indicates the date and time at which the variant was last modified.
- length - Variable in class org.simpleframework.http.message.SegmentConsumer
-
Represents the length of the body from the content length.
- length(String) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is used to parse a provided header value for the content length.
- LENGTH_REQUIRED - org.simpleframework.http.Status
-
This is used to tell the client that a request length is needed.
- limit - Variable in class org.simpleframework.http.message.SegmentConsumer
-
This represents the length limit of the HTTP header cosumed.
- list() - Method in class org.simpleframework.http.parse.ListParser
-
This will build an ordered list of values extracted from the comma separated header value.
- ListParser<T> - Class in org.simpleframework.http.parse
-
The
ListParser
is used to extract a comma separated list of HTTP header values. - ListParser() - Constructor for class org.simpleframework.http.parse.ListParser
-
Constructor for the
ListParser
. - ListParser(String) - Constructor for class org.simpleframework.http.parse.ListParser
-
Constructor for the
ListParser
. - ListParser(List<String>) - Constructor for class org.simpleframework.http.parse.ListParser
-
Constructor for the
ListParser
. - LOCATION - Static variable in interface org.simpleframework.http.Protocol
-
Used to redirect the recipient to a location other than the URI.
- low - Variable in enum org.simpleframework.http.socket.CloseCode
-
This is the low order byte for the closure code.
M
- major - Variable in class org.simpleframework.http.message.RequestConsumer
-
This is the major version number of the HTTP request header.
- MAX_FORWARDS - Static variable in interface org.simpleframework.http.Protocol
-
Limit the number of proxies or gateways that can forward the request.
- Message - Interface in org.simpleframework.http.message
-
The
Message
object is used to store an retrieve the headers for both a request and response. - MessageHeader - Class in org.simpleframework.http.message
-
The
Message
object is used to store an retrieve the headers for both a request and response. - MessageHeader() - Constructor for class org.simpleframework.http.message.MessageHeader
-
Constructor for the
Message
object. - method - Variable in class org.simpleframework.http.message.RequestConsumer
-
This is the method token send with the HTTP request header.
- Method - Interface in org.simpleframework.http
-
The
Method
interface contains the common HTTP methods that are sent with a request. - METHOD_NOT_ALLOWED - org.simpleframework.http.Status
-
This is used to tell the client that the method is not allowed.
- minor - Variable in class org.simpleframework.http.message.RequestConsumer
-
This is the minor version number of the HTTP request header.
- MOVED_PERMANENTLY - org.simpleframework.http.Status
-
This is used to represent a target resource that has moved.
- MULTIPART - Static variable in interface org.simpleframework.http.Protocol
-
Represents a message type that contains multiple parts.
- MULTIPLE_CHOICES - org.simpleframework.http.Status
-
This is used to represent a response where there are choices.
N
- name - Variable in class org.simpleframework.http.message.SegmentConsumer
-
During parsing this is used to store the parsed header name,
- NO_CACHE - Static variable in interface org.simpleframework.http.Protocol
-
Specifies that the message should not be cached by anything.
- NO_CONTENT - org.simpleframework.http.Status
-
This represents a response that contains no response content.
- NO_EXTENSION - org.simpleframework.http.socket.CloseCode
-
Indicates that the server did not negotiate an extension properly.
- NO_STATUS_CODE - org.simpleframework.http.socket.CloseCode
-
Indicates that no status code was present and should not be used.
- NORMAL_CLOSURE - org.simpleframework.http.socket.CloseCode
-
Indicates the purpose for the connection has been fulfilled.
- NOT_ACCEPTABLE - org.simpleframework.http.Status
-
This is used to tell the client the request is not acceptable.
- NOT_FOUND - org.simpleframework.http.Status
-
This is used to tell the client that the resource is not found.
- NOT_IMPLEMENTED - org.simpleframework.http.Status
-
This is used to tell the client the resource is not implemented.
- NOT_MODIFIED - org.simpleframework.http.Status
-
This is used in response to a target that has not been modified.
O
- OCTET_STREAM - Static variable in interface org.simpleframework.http.Protocol
-
Represents the default content type if none is specified.
- OK - org.simpleframework.http.Status
-
This represents a successful response of a targeted request.
- onClose(Session, Reason) - Method in interface org.simpleframework.http.socket.FrameListener
-
This is called when the connection is closed from the other side.
- onError(Session, Exception) - Method in interface org.simpleframework.http.socket.FrameListener
-
This is called when an error occurs on the WebSocket.
- onFrame(Session, Frame) - Method in interface org.simpleframework.http.socket.FrameListener
-
This is called when a new frame arrives on the WebSocket.
- OPEN_SOCKET - org.simpleframework.http.socket.service.ServiceEvent
-
This event is dispatched when a WebSocket is connected.
- OPTIONS - Static variable in interface org.simpleframework.http.Method
-
Represents a request for the communication options available.
- org.simpleframework.http - package org.simpleframework.http
- org.simpleframework.http.core - package org.simpleframework.http.core
- org.simpleframework.http.message - package org.simpleframework.http.message
- org.simpleframework.http.parse - package org.simpleframework.http.parse
- org.simpleframework.http.socket - package org.simpleframework.http.socket
- org.simpleframework.http.socket.service - package org.simpleframework.http.socket.service
P
- parse() - Method in class org.simpleframework.http.parse.AddressParser
-
This will check to see what type of URI this is if it is an
absoluteURI
or arelativeURI
. - parse() - Method in class org.simpleframework.http.parse.ContentDispositionParser
-
This is the method that should be implemented to read the buffer.
- parse() - Method in class org.simpleframework.http.parse.ContentTypeParser
-
Reads and parses the MIME type from the given
String
object. - parse() - Method in class org.simpleframework.http.parse.CookieParser
-
This will extract the next
Cookie
from the buffer. - parse() - Method in class org.simpleframework.http.parse.DateParser
-
This is used to parse the contents of the
buf
. - parse() - Method in class org.simpleframework.http.parse.ListParser
-
This ensures that tokens are taken from the comma separated list as long as there bytes left to be examined within the source text.
- parse() - Method in class org.simpleframework.http.parse.PathParser
-
This will parse the path in such a way that it ensures that at no stage there are trailing back references, using path normalization.
- parse() - Method in class org.simpleframework.http.parse.PrincipalParser
-
Used to parse the actual header data.
- parse() - Method in class org.simpleframework.http.parse.QueryParser
-
This performs the actual parsing of the parameter text.
- parse(long) - Method in class org.simpleframework.http.parse.DateParser
-
This is used to extract the date from a
long
. - parse(List<String>) - Method in class org.simpleframework.http.parse.ListParser
-
This allows multiple header values to be represented as one single comma separated list.
- parser - Variable in class org.simpleframework.http.message.RequestConsumer
-
This is the address parser used to parse the request URI.
- Part - Interface in org.simpleframework.http
-
The
Part
object is used to represent a part within a request message. - PARTIAL_CONTENT - org.simpleframework.http.Status
-
This is used to represent a response that has partial content.
- Path - Interface in org.simpleframework.http
-
The
Path
represents the path part of a URI. - PathParser - Class in org.simpleframework.http.parse
-
This is used to parse a path given as part of a URI.
- PathParser() - Constructor for class org.simpleframework.http.parse.PathParser
-
The default constructor will create a
PathParser
that contains no specifics. - PathParser(String) - Constructor for class org.simpleframework.http.parse.PathParser
-
This is primarily a convineance constructor.
- PathRouter - Class in org.simpleframework.http.socket.service
-
The
PathRouter
is used when there are multiple services that can be used. - PathRouter(Map<String, Service>, Service) - Constructor for class org.simpleframework.http.socket.service.PathRouter
-
Constructor for the
PathRouter
object. - PAYMENT_REQUIRED - org.simpleframework.http.Status
-
This is used to tell the client that payment is required.
- PING - org.simpleframework.http.socket.FrameType
-
A ping frame is a heartbeat used to determine connection health.
- PING_EXPIRED - org.simpleframework.http.socket.service.ServiceEvent
-
This indicates that there has been no response to a ping.
- POLICY_VIOLATION - org.simpleframework.http.socket.CloseCode
-
Indicates an endpoint received a message that violates its policy.
- PONG - org.simpleframework.http.socket.FrameType
-
A pong frame is sent is sent in response to a ping frame.
- PONG_RECEIVED - org.simpleframework.http.socket.service.ServiceEvent
-
This indicates that there has been no response to a ping.
- pos - Variable in class org.simpleframework.http.message.SegmentConsumer
-
This is used to track the read offset within the header.
- POST - Static variable in interface org.simpleframework.http.Method
-
Request that the origin server accept the entity in the request.
- PRAGMA - Static variable in interface org.simpleframework.http.Protocol
-
Include implementation specific directives that might apply.
- PRECONDITION_FAILED - org.simpleframework.http.Status
-
This is used to tell the client that a precondition has failed.
- Principal - Interface in org.simpleframework.http
-
The
Principal
interface is used to describe a user that has a name and password. - PrincipalParser - Class in org.simpleframework.http.parse
-
PrincipalParser is a parser class for the HTTP basic authorization header.
- PrincipalParser() - Constructor for class org.simpleframework.http.parse.PrincipalParser
-
Creates a
Parser
for the basic authorization scheme. - PrincipalParser(String) - Constructor for class org.simpleframework.http.parse.PrincipalParser
-
Creates a
Parser
for the basic authorization scheme. - process() - Method in class org.simpleframework.http.message.ArrayConsumer
-
This method is invoked after the terminal token has been read.
- process() - Method in class org.simpleframework.http.message.RequestConsumer
-
This method is invoked after the terminal token has been read.
- process() - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is used to process the headers when the terminal token has been fully read from the consumed bytes.
- process(Socket) - Method in class org.simpleframework.http.core.ContainerSocketProcessor
-
This is used to consume HTTP messages that arrive on the socket and dispatch them to the internal container.
- process(Transport) - Method in class org.simpleframework.http.core.ContainerTransportProcessor
-
This is used to consume HTTP messages that arrive on the given transport.
- Protocol - Interface in org.simpleframework.http
-
This represents the HTTP header names defined in RFC 2616.
- PROTOCOL_ERROR - org.simpleframework.http.socket.CloseCode
-
Indicates the connection is terminating due to a protocol error.
- ProtocolRouter - Class in org.simpleframework.http.socket.service
-
The
ProtocolRouter
is used when there are multiple services that can be used. - ProtocolRouter(Map<String, Service>, Service) - Constructor for class org.simpleframework.http.socket.service.ProtocolRouter
-
Constructor for the
ProtocolRouter
object. - PROXY_AUTHENTICATE - Static variable in interface org.simpleframework.http.Protocol
-
Challenge indicating the authentication applicable to the proxy.
- PROXY_AUTHENTICATION_REQUIRED - org.simpleframework.http.Status
-
This is used to tell the client that authentication is required.
- PROXY_AUTHORIZATION - Static variable in interface org.simpleframework.http.Protocol
-
Allows client identification for a proxy requiring authentication.
- PUT - Static variable in interface org.simpleframework.http.Method
-
Requests that the entity be stored as the resource specified
Q
- Query - Interface in org.simpleframework.http
-
The
Query
object is used to represent HTTP query parameters. - QueryParser - Class in org.simpleframework.http.parse
-
The
ParameterParser
is used to parse data encoded in theapplication/x-www-form-urlencoded
MIME type. - QueryParser() - Constructor for class org.simpleframework.http.parse.QueryParser
-
Constructor for the
ParameterParser
. - QueryParser(String) - Constructor for class org.simpleframework.http.parse.QueryParser
-
Constructor for the
ParameterParser
.
R
- RANGE - Static variable in interface org.simpleframework.http.Protocol
-
Specifies a range of bytes within a resource to be sent by a server.
- READ_BODY - org.simpleframework.http.core.ContainerEvent
-
This event indicates that the server is reading the request body.
- READ_FRAME - org.simpleframework.http.socket.service.ServiceEvent
-
This event is dispatched when a frame is read from a WebSocket.
- READ_HEADER - org.simpleframework.http.core.ContainerEvent
-
This event indicates that the server is reading the request header.
- READ_PING - org.simpleframework.http.socket.service.ServiceEvent
-
This event is dispatched when the WebSocket receives a ping.
- READ_PONG - org.simpleframework.http.socket.service.ServiceEvent
-
This event is dispatched when the WebSocket receives a pong.
- Reason - Class in org.simpleframework.http.socket
-
The
Reason
object is used to hold a textual reason for connection closure and an RFC 6455 defined code. - Reason(CloseCode) - Constructor for class org.simpleframework.http.socket.Reason
-
Constructor for the
Reason
object. - Reason(CloseCode, String) - Constructor for class org.simpleframework.http.socket.Reason
-
Constructor for the
Reason
object. - REFERER - Static variable in interface org.simpleframework.http.Protocol
-
Allows the client to specify the source address to the server.
- register(FrameListener) - Method in interface org.simpleframework.http.socket.FrameChannel
-
This is used to register a
FrameListener
to this instance. - remove(FrameListener) - Method in interface org.simpleframework.http.socket.FrameChannel
-
This is used to remove a
FrameListener
from this instance. - request - Variable in class org.simpleframework.http.RequestWrapper
-
This is the request instance that is being wrapped.
- Request - Interface in org.simpleframework.http
-
The
Request
is used to provide an interface to the HTTP entity body and message header. - REQUEST_ENTITY_TOO_LARGE - org.simpleframework.http.Status
-
This is used to tell the client that the request body is too big.
- REQUEST_READY - org.simpleframework.http.core.ContainerEvent
-
This event indicates that the request is ready for processing.
- REQUEST_TIMEOUT - org.simpleframework.http.Status
-
This is used to tell the client that the request has timed out.
- REQUEST_URI_TOO_LONG - org.simpleframework.http.Status
-
This is used to tell the client that the request URI is too long.
- RequestConsumer - Class in org.simpleframework.http.message
-
The
RequestConsumer
object is used to parse the HTTP request line followed by the HTTP message headers. - RequestConsumer() - Constructor for class org.simpleframework.http.message.RequestConsumer
-
Constructor for the
RequestConsumer
object. - REQUESTED_RANGE_NOT_SATISFIABLE - org.simpleframework.http.Status
-
This is used to tell the client that the range is invalid.
- RequestHeader - Interface in org.simpleframework.http
-
This is a
Header
object that is used to represent a basic form for the HTTP request message. - RequestLine - Interface in org.simpleframework.http
-
The
RequestLine
is used to represent a HTTP request line. - RequestWrapper - Class in org.simpleframework.http
-
The
RequestWrapper
object is used so that the originalRequest
object can be wrapped in a filtering proxy object. - RequestWrapper(Request) - Constructor for class org.simpleframework.http.RequestWrapper
-
Constructor for
RequestWrapper
object. - RESERVED - org.simpleframework.http.socket.CloseCode
-
According to RFC 6455 this has been reserved for future use.
- reset() - Method in class org.simpleframework.http.parse.CookieParser
-
This is used so that the collection of
Cookies
can be reiterated. - reset() - Method in interface org.simpleframework.http.Response
-
This can be used to determine whether the
Response
has been committed. - reset() - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to determine whether the
Response
has been committed. - RESET_CONTENT - org.simpleframework.http.Status
-
This is used to represent a response that resets the content.
- resize(int) - Method in class org.simpleframework.http.message.ArrayConsumer
-
This method is used to add an additional chunk size to the internal array.
- resize(int) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This method is used to add an additional chunk size to the internal array.
- resolveCode(int, int) - Static method in enum org.simpleframework.http.socket.CloseCode
- resolveScheme(String) - Static method in enum org.simpleframework.http.Scheme
-
This is used to resolve the scheme given a token.
- resolveScheme(URI) - Static method in enum org.simpleframework.http.Scheme
-
This is used to resolve the scheme given a
URI
. - resolveType(int) - Static method in enum org.simpleframework.http.socket.FrameType
-
This is used to acquire the frame type given an opcode.
- response - Variable in class org.simpleframework.http.ResponseWrapper
-
This is the response instance that is being wrapped.
- Response - Interface in org.simpleframework.http
-
This is used to represent the HTTP response.
- RESPONSE_FINISHED - org.simpleframework.http.core.ContainerEvent
-
This indicates that all the bytes within the response are sent.
- ResponseHeader - Interface in org.simpleframework.http
-
The
ResponseHeader
object is used to manipulate the header information for a given response. - ResponseWrapper - Class in org.simpleframework.http
-
The
ResponseWrapper
object is used so that the originalResponse
object can be wrapped in a filtering proxy object. - ResponseWrapper(Response) - Constructor for class org.simpleframework.http.ResponseWrapper
-
Constructor for
ResponseWrapper
object. - RETRY_AFTER - Static variable in interface org.simpleframework.http.Protocol
-
Response to indicate how long the service will be unavailable.
- route(Request, Response) - Method in class org.simpleframework.http.socket.service.DirectRouter
-
This is used to route an incoming request to a service if the request represents a WebSocket handshake as defined by RFC 6455.
- route(Request, Response) - Method in class org.simpleframework.http.socket.service.PathRouter
-
This is used to route an incoming request to a service if the request represents a WebSocket handshake as defined by RFC 6455.
- route(Request, Response) - Method in class org.simpleframework.http.socket.service.ProtocolRouter
-
This is used to route an incoming request to a service if the request represents a WebSocket handshake as defined by RFC 6455.
- route(Request, Response) - Method in interface org.simpleframework.http.socket.service.Router
-
This is used to route an incoming request to a service if the request represents a WebSocket handshake as defined by RFC 6455.
- Router - Interface in org.simpleframework.http.socket.service
-
The
Router
interface represents a means of routing a session initiating request to the correct service. - RouterContainer - Class in org.simpleframework.http.socket.service
-
The
RouterContainer
is used to route requests that satisfy a WebSocket opening handshake to a specific service. - RouterContainer(Container, Router, int) - Constructor for class org.simpleframework.http.socket.service.RouterContainer
-
Constructor for the
RouterContainer
object. - RouterContainer(Container, Router, int, long) - Constructor for class org.simpleframework.http.socket.service.RouterContainer
-
Constructor for the
RouterContainer
object.
S
- scan - Variable in class org.simpleframework.http.message.SegmentConsumer
-
This is used to track how much of the terminal is read.
- scan() - Method in class org.simpleframework.http.message.ArrayConsumer
-
This method is used to scan for the terminal token.
- scan() - Method in class org.simpleframework.http.message.SegmentConsumer
-
This method is used to scan for the terminal token.
- scheme - Variable in enum org.simpleframework.http.Scheme
-
This is the actual scheme token that is to be used in the URI.
- Scheme - Enum in org.simpleframework.http
-
The
Scheme
represents a scheme used for a URI. - SEC_WEBSOCKET_ACCEPT - Static variable in interface org.simpleframework.http.Protocol
-
Represents the SHA-1 digest of the clients globally unique identifier.
- SEC_WEBSOCKET_KEY - Static variable in interface org.simpleframework.http.Protocol
-
Represents the globally unique identifier sent by the client.
- SEC_WEBSOCKET_PROTOCOL - Static variable in interface org.simpleframework.http.Protocol
-
Specifies the protocol that should be used by the connected parties.
- SEC_WEBSOCKET_VERSION - Static variable in interface org.simpleframework.http.Protocol
-
Represents the version of the protocol that should be used.
- secure - Variable in enum org.simpleframework.http.Scheme
-
This is used to determine if the connection is secure or not.
- SEE_OTHER - org.simpleframework.http.Status
-
This is used to tell the client to see another HTTP resource.
- Segment - Interface in org.simpleframework.http.message
-
The
Segment
object represents a collection of header values that is followed by a body. - SegmentConsumer - Class in org.simpleframework.http.message
-
The
SegmentConsumer
object provides a consumer that is used to consume a HTTP header. - SegmentConsumer() - Constructor for class org.simpleframework.http.message.SegmentConsumer
-
Constructor for the
SegmentConsumer
object. - SegmentConsumer(int) - Constructor for class org.simpleframework.http.message.SegmentConsumer
-
Constructor for the
SegmentConsumer
object. - send(byte[]) - Method in interface org.simpleframework.http.socket.FrameChannel
-
This is used to send data to the connected client.
- send(String) - Method in interface org.simpleframework.http.socket.FrameChannel
-
This is used to send text to the connected client.
- send(Frame) - Method in interface org.simpleframework.http.socket.FrameChannel
-
This is used to send data to the connected client.
- SERVER - Static variable in interface org.simpleframework.http.Protocol
-
Contains information about the software used by the origin server.
- Service - Interface in org.simpleframework.http.socket.service
-
The
Service
interface represents a service that can be used to communicate with the WebSocket protocol defined in RFC 6455. - SERVICE_UNAVAILABLE - org.simpleframework.http.Status
-
This is used to tell the client the resource is unavailable.
- ServiceEvent - Enum in org.simpleframework.http.socket.service
-
The
ServiceEvent
enumeration contains the events that are dispatched processing a WebSocket. - Session - Interface in org.simpleframework.http.socket
-
The
Session
object represents a simple WebSocket session that contains the connection handshake details and the actual socket. - SET_COOKIE - Static variable in interface org.simpleframework.http.Protocol
-
Represents some value from the server that the client should keep.
- setCharset(String) - Method in interface org.simpleframework.http.ContentType
-
This will set the
charset
to whatever value the string contains. - setCharset(String) - Method in class org.simpleframework.http.parse.ContentTypeParser
-
This will set the
charset
to whatever value the string contains. - setChunkedEncoded() - Method in class org.simpleframework.http.core.Conversation
-
This is used when the output is encoded in the chunked encoding.
- setCode(int) - Method in class org.simpleframework.http.ResponseWrapper
-
This method allows the status for the response to be changed.
- setCode(int) - Method in interface org.simpleframework.http.StatusLine
-
This method allows the status for the response to be changed.
- setConnectionUpgrade() - Method in class org.simpleframework.http.core.Conversation
-
This is used to set the response to a connection upgrade.
- setContentLength(long) - Method in class org.simpleframework.http.core.Conversation
-
This is used to set the content length for the response.
- setContentLength(long) - Method in interface org.simpleframework.http.Response
-
This should be used when the size of the message body is known.
- setContentLength(long) - Method in class org.simpleframework.http.ResponseWrapper
-
This should be used when the size of the message body is known.
- setContentType(String) - Method in interface org.simpleframework.http.Response
-
This is used to set the content type for the response.
- setContentType(String) - Method in class org.simpleframework.http.ResponseWrapper
-
This is used to set the content type for the response.
- setCookie(String, String) - Method in interface org.simpleframework.http.message.Message
-
The
setCookie
method is used to set a cookie value with the cookie name. - setCookie(String, String) - Method in class org.simpleframework.http.message.MessageHeader
-
The
setCookie
method is used to set a cookie value with the cookie name. - setCookie(String, String) - Method in interface org.simpleframework.http.ResponseHeader
-
The
setCookie
method is used to set a cookie value with the cookie name. - setCookie(String, String) - Method in class org.simpleframework.http.ResponseWrapper
-
The
setCookie
method is used to set a cookie value with the cookie name. - setCookie(Cookie) - Method in interface org.simpleframework.http.message.Message
-
The
setCookie
method is used to set a cookie value with the cookie name. - setCookie(Cookie) - Method in class org.simpleframework.http.message.MessageHeader
-
The
setCookie
method is used to set a cookie value with the cookie name. - setCookie(Cookie) - Method in interface org.simpleframework.http.ResponseHeader
-
The
setCookie
method is used to set a cookie value with the cookie name. - setCookie(Cookie) - Method in class org.simpleframework.http.ResponseWrapper
-
The
setCookie
method is used to set a cookie value with the cookie name. - setDate(String, long) - Method in interface org.simpleframework.http.message.Message
-
This is used as a convenience method for adding a header that needs to be parsed into a HTTP date string.
- setDate(String, long) - Method in class org.simpleframework.http.message.MessageHeader
-
This is used as a convenience method for adding a header that needs to be parsed into a HTTP date string.
- setDate(String, long) - Method in interface org.simpleframework.http.ResponseHeader
-
This is used as a convenience method for adding a header that needs to be parsed into a HTTP date string.
- setDate(String, long) - Method in class org.simpleframework.http.ResponseWrapper
-
This is used as a convenience method for adding a header that needs to be parsed into a HTTP date string.
- setDescription(String) - Method in class org.simpleframework.http.ResponseWrapper
-
This is used to set the text of the HTTP status line.
- setDescription(String) - Method in interface org.simpleframework.http.StatusLine
-
This is used to set the text of the HTTP status line.
- setDomain(String) - Method in class org.simpleframework.http.Cookie
-
This enables the domain for this
Cookie
to be set. - setDomain(String) - Method in class org.simpleframework.http.parse.AddressParser
-
This will set the domain to whatever value is in the string parameter.
- setExpiry(int) - Method in class org.simpleframework.http.Cookie
-
This allows a lifetime to be specified for the cookie.
- setIdentityEncoded() - Method in class org.simpleframework.http.core.Conversation
-
This will remove all explicit transfer encoding headers from the response header.
- setInteger(String, int) - Method in interface org.simpleframework.http.message.Message
-
This can be used to set a HTTP message header to this object.
- setInteger(String, int) - Method in class org.simpleframework.http.message.MessageHeader
-
This can be used to set a HTTP message header to this object.
- setInteger(String, int) - Method in interface org.simpleframework.http.ResponseHeader
-
This can be used to set a HTTP message header to this object.
- setInteger(String, int) - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to set a HTTP message header to this object.
- setLong(String, long) - Method in class org.simpleframework.http.message.MessageHeader
-
This can be used to set a HTTP message header to this object.
- setLong(String, long) - Method in interface org.simpleframework.http.ResponseHeader
-
This can be used to set a HTTP message header to this object.
- setLong(String, long) - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to set a HTTP message header to this object.
- setMajor(int) - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to set the major number from a HTTP version.
- setMajor(int) - Method in interface org.simpleframework.http.StatusLine
-
This can be used to specify the major version.
- setMinor(int) - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to get the minor number from a HTTP version.
- setMinor(int) - Method in interface org.simpleframework.http.StatusLine
-
This can be used to specify the minor version.
- setParameter(String, String) - Method in interface org.simpleframework.http.ContentType
-
This will add a named parameter to the content type header.
- setParameter(String, String) - Method in class org.simpleframework.http.parse.ContentTypeParser
-
This will add a named parameter to the content type header.
- setPath(String) - Method in class org.simpleframework.http.Cookie
-
This is used to set the cookie path for this cookie.
- setPath(String) - Method in class org.simpleframework.http.parse.AddressParser
-
This will set the path to whatever value it is given.
- setPath(Path) - Method in class org.simpleframework.http.parse.AddressParser
-
This will set the path to whatever value it is given.
- setPort(int) - Method in class org.simpleframework.http.parse.AddressParser
-
This will set the port to whatever value it is given.
- setPrimary(String) - Method in interface org.simpleframework.http.ContentType
-
This sets the primary type to whatever value is in the string provided is.
- setPrimary(String) - Method in class org.simpleframework.http.parse.ContentTypeParser
-
This sets the primary type to whatever value is in the string provided is.
- setProtected(boolean) - Method in class org.simpleframework.http.Cookie
-
This is used to protect the cookie from cross site scripting vulnerabilities.
- setQuery(String) - Method in class org.simpleframework.http.parse.AddressParser
-
This will set the query to whatever value it is given.
- setQuery(Query) - Method in class org.simpleframework.http.parse.AddressParser
-
This will set the query to whatever value it is given.
- setScheme(String) - Method in class org.simpleframework.http.parse.AddressParser
-
This allows the scheme for the URI to be specified.
- setSecondary(String) - Method in interface org.simpleframework.http.ContentType
-
This sets the secondary type to whatever value is in the string provided is.
- setSecondary(String) - Method in class org.simpleframework.http.parse.ContentTypeParser
-
This sets the secondary type to whatever value is in the string provided is.
- setSecure(boolean) - Method in class org.simpleframework.http.Cookie
-
This is used to determine if the client browser should send this cookie over a secure protocol.
- setStatus(Status) - Method in class org.simpleframework.http.ResponseWrapper
-
This is used to set the status code and description for this response.
- setStatus(Status) - Method in interface org.simpleframework.http.StatusLine
-
This is used to set the status code and description for this response.
- setValue(String) - Method in class org.simpleframework.http.Cookie
-
This enables the value of the cookie to be changed.
- setValue(String, String) - Method in interface org.simpleframework.http.message.Message
-
This can be used to set a HTTP message header to this object.
- setValue(String, String) - Method in class org.simpleframework.http.message.MessageHeader
-
This can be used to set a HTTP message header to this object.
- setValue(String, String) - Method in interface org.simpleframework.http.ResponseHeader
-
This can be used to set a HTTP message header to this object.
- setValue(String, String) - Method in class org.simpleframework.http.ResponseWrapper
-
This can be used to set a HTTP message header to this object.
- setVersion(int) - Method in class org.simpleframework.http.Cookie
-
This enables the version of the
Cookie
to be set. - skip(String) - Method in class org.simpleframework.http.parse.CookieParser
-
This is used to skip an arbitrary
String
within thechar
buf. - space(byte) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This identifies a given ISO-8859-1 byte as a space character.
- Status - Enum in org.simpleframework.http
-
The
Status
enumeration is used to specify status codes and the descriptions of those status codes. - StatusLine - Interface in org.simpleframework.http
-
The
StatusLine
is used to represent a HTTP status line. - stop() - Method in class org.simpleframework.http.core.ContainerSocketProcessor
-
This method is used to stop the connector in such a way that it will not accept and process any further messages.
- stop() - Method in class org.simpleframework.http.core.ContainerTransportProcessor
-
This method is used to stop the connector in such a way that it will not accept and process any further messages.
- SWITCHING_PROTOCOLS - org.simpleframework.http.Status
-
This represents a change in the protocol the client is using.
T
- target - Variable in class org.simpleframework.http.message.RequestConsumer
-
This represents the raw request URI in an unparsed form.
- TE - Static variable in interface org.simpleframework.http.Protocol
-
Indicates what extension transfer codings it is willing to accept.
- TEMPORARY_REDIRECT - org.simpleframework.http.Status
-
This is used to redirect the client to a resource that has moved.
- terminal(byte) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This determines if an ISO-8859-1 byte is a terminal character.
- TERMINATE_SOCKET - org.simpleframework.http.socket.service.ServiceEvent
-
This event is dispatched when a WebSocket channel is closed.
- TEXT - org.simpleframework.http.socket.FrameType
-
A text frame identifies a message that contains UTF-8 text data.
- TEXT - Static variable in interface org.simpleframework.http.Protocol
-
Represents a message type containing human readable text.
- TextData - Class in org.simpleframework.http.socket
-
The
TextData
object represents a text payload for a WebScoket frame. - TextData(String) - Constructor for class org.simpleframework.http.socket.TextData
-
Constructor for the
TextData
object. - TLS_HANDSHAKE_FAILURE - org.simpleframework.http.socket.CloseCode
-
Indicates a validation failure for TLS and should not be used.
- toClientString() - Method in class org.simpleframework.http.Cookie
-
This will give the correct string value of this cookie.
- toLong() - Method in class org.simpleframework.http.parse.DateParser
-
This returns the date in as a
long
, given the exact time this will use thejava.util.Date
to parse this date into along
. - TOO_BIG - org.simpleframework.http.socket.CloseCode
-
Indicates that a payload is too big to be processed.
- toString() - Method in interface org.simpleframework.http.Address
-
This is used to convert this URI object into a
String
object. - toString() - Method in interface org.simpleframework.http.ContentType
-
This will return the value of the MIME type as a string.
- toString() - Method in class org.simpleframework.http.Cookie
-
The
toString
method converts the cookie to the Set-Cookie value. - toString() - Method in interface org.simpleframework.http.message.Header
-
This method returns a string representing the header that was consumed by this consumer.
- toString() - Method in class org.simpleframework.http.message.RequestConsumer
-
This is used to convert the byte range to a string.
- toString() - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is used to provide a string representation of the header read.
- toString() - Method in class org.simpleframework.http.parse.AddressParser
-
This is used to convert this URI object into a
String
object. - toString() - Method in class org.simpleframework.http.parse.ContentTypeParser
-
This will return the value of the MIME type as a string.
- toString() - Method in class org.simpleframework.http.parse.DateParser
-
This prints the date in the format of a RFC 1123 date.
- toString() - Method in class org.simpleframework.http.parse.PathParser
-
This will return the normalized path.
- toString() - Method in class org.simpleframework.http.parse.QueryParser
-
This
toString
method is used to compose an string in theapplication/x-www-form-urlencoded
MIME type. - toString() - Method in interface org.simpleframework.http.Path
-
This will return the normalized path.
- toString() - Method in interface org.simpleframework.http.Query
-
This will return all parameters represented using the HTTP URL query format.
- toString() - Method in interface org.simpleframework.http.RequestHeader
-
This method returns a string representing the header that was consumed for this request.
- toString() - Method in class org.simpleframework.http.RequestWrapper
-
This method returns a string representing the header that was consumed for this request.
- toString() - Method in interface org.simpleframework.http.ResponseHeader
-
This method returns a string representing the header that was generated for this header.
- toString() - Method in class org.simpleframework.http.ResponseWrapper
-
This method returns a string representing the header that was generated for this header.
- toString() - Method in class org.simpleframework.http.socket.DataFrame
-
This returns the text payload that is to be sent with the frame.
- toString() - Method in class org.simpleframework.http.socket.Reason
-
This is used to provide a textual representation of the reason.
- toString(Set) - Method in class org.simpleframework.http.parse.QueryParser
-
This
toString
method is used to compose an string in theapplication/x-www-form-urlencoded
MIME type. - trace - Variable in class org.simpleframework.http.message.EntityConsumer
-
This is used to trace the progress of the request consumption.
- TRACE - Static variable in interface org.simpleframework.http.Method
-
Invoke a remote application layer loop back of the request.
- TRAILER - Static variable in interface org.simpleframework.http.Protocol
-
Indicates that these header fields is present in the trailer.
- TRANSFER_ENCODING - Static variable in interface org.simpleframework.http.Protocol
-
Indicates the transformation has been applied to the message body.
- type - Variable in class org.simpleframework.http.message.SegmentConsumer
-
This is used to parse the content type header consumed.
- type(String) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is used to parse the content type header header so that the MIME type is available to the segment.
U
- UNAUTHORIZED - org.simpleframework.http.Status
-
This is used to tell the client that authorization is required.
- UNSUPPORTED_DATA - org.simpleframework.http.socket.CloseCode
-
Indicates the connection received a data type it cannot accept.
- UNSUPPORTED_MEDIA_TYPE - org.simpleframework.http.Status
-
This is used to tell the client that the content type is invalid.
- update(byte[], int, int) - Method in class org.simpleframework.http.message.ChunkedConsumer
-
This is used to process the bytes that have been read from the cursor.
- update(byte[], int, int) - Method in class org.simpleframework.http.message.FixedLengthConsumer
-
This is used to process the bytes that have been read from the cursor.
- update(byte[], int, int) - Method in class org.simpleframework.http.message.UpdateConsumer
-
This is used to process the bytes that have been read from the cursor.
- UpdateConsumer - Class in org.simpleframework.http.message
-
The
UpdateConsumer
object is used to create a consumer that is used to consume and process large bodies. - UpdateConsumer() - Constructor for class org.simpleframework.http.message.UpdateConsumer
-
Constructor for the
UpdateConsumer
object. - UpdateConsumer(int) - Constructor for class org.simpleframework.http.message.UpdateConsumer
-
Constructor for the
UpdateConsumer
object. - UPGRADE - Static variable in interface org.simpleframework.http.Protocol
-
Specifies additional communication protocols the client supports.
- URL_ENCODED - Static variable in interface org.simpleframework.http.Protocol
-
Represents a message type that contains HTML form posted data.
- USE_PROXY - org.simpleframework.http.Status
-
This is used to tell the client that it should use a proxy.
- USER_AGENT - Static variable in interface org.simpleframework.http.Protocol
-
Contains information about the user agent originating the request.
V
- value - Variable in class org.simpleframework.http.message.SegmentConsumer
-
During parsing this is used to store the parsed header value.
- valueOf(String) - Static method in enum org.simpleframework.http.core.ContainerEvent
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.simpleframework.http.Scheme
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.simpleframework.http.socket.CloseCode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.simpleframework.http.socket.FrameType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.simpleframework.http.socket.service.ServiceEvent
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.simpleframework.http.Status
-
Returns the enum constant of this type with the specified name.
- ValueParser - Class in org.simpleframework.http.parse
-
The
ValueParser
is used to extract a comma separated list of HTTP header values. - ValueParser() - Constructor for class org.simpleframework.http.parse.ValueParser
-
Constructor for the
ValueParser
. - ValueParser(String) - Constructor for class org.simpleframework.http.parse.ValueParser
-
Constructor for the
ValueParser
. - ValueParser(List<String>) - Constructor for class org.simpleframework.http.parse.ValueParser
-
Constructor for the
ValueParser
. - values() - Static method in enum org.simpleframework.http.core.ContainerEvent
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.simpleframework.http.Scheme
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.simpleframework.http.socket.CloseCode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.simpleframework.http.socket.FrameType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.simpleframework.http.socket.service.ServiceEvent
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.simpleframework.http.Status
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VARY - Static variable in interface org.simpleframework.http.Protocol
-
Indicates the headers that can make a cached resource stale.
- version() - Method in class org.simpleframework.http.message.RequestConsumer
-
This will parse HTTP version from the first line of the header and store the parsed string internally.
- VERSION_NOT_SUPPORTED - org.simpleframework.http.Status
-
This is used to tell the client the request version is invalid.
- VIA - Static variable in interface org.simpleframework.http.Protocol
-
Used by gateways and proxies to indicate the intermediate protocols.
W
- WARNING - Static variable in interface org.simpleframework.http.Protocol
-
Used to carry additional information about the status or body.
- WEBSOCKET - Static variable in interface org.simpleframework.http.Protocol
-
This is the protocol token that is used when upgrading.
- white(byte) - Method in class org.simpleframework.http.message.SegmentConsumer
-
This is used to determine if a given ISO-8859-1 byte is a white space character, such as a tab or space or a terminal character, such as a carriage return or a new line.
- WRITE_BODY - org.simpleframework.http.core.ContainerEvent
-
This event indicates that the server is writing the response body.
- WRITE_FRAME - org.simpleframework.http.socket.service.ServiceEvent
-
This event is dispatched when a frame is sent over a WebSocket.
- WRITE_HEADER - org.simpleframework.http.core.ContainerEvent
-
This event indicates that the server is writing the response header.
- WRITE_HEADER - org.simpleframework.http.socket.service.ServiceEvent
-
This event is dispatched when the response handshake is sent.
- WRITE_PING - org.simpleframework.http.socket.service.ServiceEvent
-
This event is dispatched when a ping is sent over a WebSocket.
- WRITE_PONG - org.simpleframework.http.socket.service.ServiceEvent
-
This event is dispatched when a pong is sent over a WebSocket.
- WS - org.simpleframework.http.Scheme
-
This represents the scheme for a plaintext WebSocket connection.
- WSS - org.simpleframework.http.Scheme
-
This represents the scheme for WebSocket over TLS connection.
- WWW_AUTHENTICATE - Static variable in interface org.simpleframework.http.Protocol
-
Uses to challenge a client for authentication for a resource.
All Classes All Packages