A B C E G H I O R S T W

A

addCookie(Cookie) - Method in class co.paralleluniverse.comsat.webactors.HttpResponse.Builder

Adds the specified cookie to the response.

addHeader(String, String) - Method in class co.paralleluniverse.comsat.webactors.HttpResponse.Builder

Adds a response header with the given name and value.

B

build() - Method in class co.paralleluniverse.comsat.webactors.Cookie.Builder

Instantiates a new immutable Cookie based on the values set in this builder.

build() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse.Builder

Instantiates a new immutable HttpResponse based on the values set in this builder.

C

co.paralleluniverse.comsat.webactors - package co.paralleluniverse.comsat.webactors

The Web Actors API

contentString() - Method in class co.paralleluniverse.comsat.webactors.HttpRequest

contentString() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse

contentString() - Method in class co.paralleluniverse.comsat.webactors.WebDataMessage

contentString() - Method in class co.paralleluniverse.comsat.webactors.WebMessage

Cookie - Class in co.paralleluniverse.comsat.webactors

A HTTP cookie

cookie(String, String) - Static method in class co.paralleluniverse.comsat.webactors.Cookie

Constructs a cookie with the specified name and value.

Cookie.Builder - Class in co.paralleluniverse.comsat.webactors

E

error(Throwable) - Method in class co.paralleluniverse.comsat.webactors.HttpResponse.Builder

Associates an exception with an error status.

error(HttpRequest, int, Throwable) - Static method in class co.paralleluniverse.comsat.webactors.HttpResponse

Creates an HttpResponse indicating an error, with a given status code and an attached exception that may be reported back to the client.

error(HttpRequest, int, String) - Static method in class co.paralleluniverse.comsat.webactors.HttpResponse

Creates an HttpResponse indicating an error, with a given status code and a text body.

event(long, String, String) - Static method in class co.paralleluniverse.comsat.webactors.SSE

Encodes a given payload as an SSE event message.

event(String, String) - Static method in class co.paralleluniverse.comsat.webactors.SSE

Encodes a given payload as an SSE event message.

event(long, String) - Static method in class co.paralleluniverse.comsat.webactors.SSE

Encodes a given payload and id as an SSE event message.

event(String) - Static method in class co.paralleluniverse.comsat.webactors.SSE

Encodes a given payload as an SSE event message.

G

getAtrributes() - Method in class co.paralleluniverse.comsat.webactors.HttpRequest

Returns the names values of all attributed associated with this request.

getAttribute(String) - Method in class co.paralleluniverse.comsat.webactors.HttpRequest

Returns the value of the given attribute.

getByteBufferBody() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse

getByteBufferBody() - Method in class co.paralleluniverse.comsat.webactors.WebDataMessage

getByteBufferBody() - Method in class co.paralleluniverse.comsat.webactors.WebMessage

The message’s binary body, if it has one; null otherwise.

getByteBufferBody() - Method in class co.paralleluniverse.comsat.webactors.WebStreamOpened

The message’s binary body, if it has one; null otherwise.

getCharacterEncoding() - Method in class co.paralleluniverse.comsat.webactors.HttpMessage

The Charset representing character encoding used in the body of this message.

getCharacterEncoding() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse

getComment() - Method in class co.paralleluniverse.comsat.webactors.Cookie

The comment describing the purpose of this cookie, or null if the cookie has no comment.

getContentLength() - Method in class co.paralleluniverse.comsat.webactors.HttpMessage

The length, in bytes, of the message body and made available by the input stream, or -1 if the length is not known or is greater than Integer.MAX_VALUE.

getContentLength() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse

getContentType() - Method in class co.paralleluniverse.comsat.webactors.HttpMessage

The MIME type of the body of the request, or null if the type is not known For example, text/html; charset=UTF-8.

getContentType() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse

getContextPath() - Method in class co.paralleluniverse.comsat.webactors.HttpRequest

The portion of the request URI that indicates the context of the request.

getCookies() - Method in class co.paralleluniverse.comsat.webactors.HttpMessage

A collection all of the Cookie objects the client sent with this message.

getCookies() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse

getDateHeader(String) - Method in class co.paralleluniverse.comsat.webactors.HttpRequest

Returns the value of the specified request header as a long value that represents a Date object.

getDomain() - Method in class co.paralleluniverse.comsat.webactors.Cookie

The domain name of this Cookie.

getError() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse

An exception optionally associated with an error status code.

getFrom() - Method in class co.paralleluniverse.comsat.webactors.HttpRequest

Returns an actor representing the client to which an HttpResponse should be sent as a response to this request.

getFrom() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse

getFrom() - Method in class co.paralleluniverse.comsat.webactors.WebDataMessage

getFrom() - Method in class co.paralleluniverse.comsat.webactors.WebMessage

The actor that sent this message.

getFrom() - Method in class co.paralleluniverse.comsat.webactors.WebStreamOpened

getHeader(String) - Method in class co.paralleluniverse.comsat.webactors.HttpMessage

Returns the value of the given header name.

getHeaders() - Method in class co.paralleluniverse.comsat.webactors.HttpMessage

A multimap of the headers contained in this message and (all) their values.

getHeaders() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse

getHeaderValues(String) - Method in class co.paralleluniverse.comsat.webactors.HttpMessage

Returns all values associated with the given header name

getId() - Method in class co.paralleluniverse.comsat.webactors.HttpStreamOpened

Returns the HttpResponse passed to the constructor.

getLastEventId(HttpRequest) - Static method in class co.paralleluniverse.comsat.webactors.SSE

Returns the SSE last-event-id value from the request (the Last-Event-ID header).

getMaxAge() - Method in class co.paralleluniverse.comsat.webactors.Cookie

The maximum age in seconds of this Cookie.

getMethod() - Method in class co.paralleluniverse.comsat.webactors.HttpRequest

The name of the HTTP method with which this request was made; for example, GET, POST, or PUT.

getName() - Method in class co.paralleluniverse.comsat.webactors.Cookie

The name of the cookie.

getParameter(String) - Method in class co.paralleluniverse.comsat.webactors.HttpRequest

Returns the value of the given parameter.

getParameters() - Method in class co.paralleluniverse.comsat.webactors.HttpRequest

A multimap of the parameters contained in this message and (all) their values.

getParametersValues(String) - Method in class co.paralleluniverse.comsat.webactors.HttpRequest

Returns all values associated with the given parameter

getPath() - Method in class co.paralleluniverse.comsat.webactors.Cookie

Returns the path on the server to which the browser returns this cookie.

getPathInfo() - Method in class co.paralleluniverse.comsat.webactors.HttpRequest

Returns any extra path information associated with the URL the client sent when it made this request.

getQueryString() - Method in class co.paralleluniverse.comsat.webactors.HttpRequest

The query string that is contained in the request URL after the path, or null if the URL does not have a query string.

getRedirectPath() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse

The redirect URL target if this is a redirect response.

getRequest() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse

The HttpRequest this is a response to.

getRequestURI() - Method in class co.paralleluniverse.comsat.webactors.HttpRequest

Returns the part of this request’s URL from the protocol name up to the query string in the first line of the HTTP request.

getServerName() - Method in class co.paralleluniverse.comsat.webactors.HttpRequest

The host name of the server to which the request was sent.

getServerPort() - Method in class co.paralleluniverse.comsat.webactors.HttpRequest

The port number to which the request was sent.

getStatus() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse

The response’s HTTP status code.

getStringBody() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse

getStringBody() - Method in class co.paralleluniverse.comsat.webactors.WebDataMessage

getStringBody() - Method in class co.paralleluniverse.comsat.webactors.WebMessage

The message’s text body, if it has one; null otherwise.

getStringBody() - Method in class co.paralleluniverse.comsat.webactors.WebStreamOpened

The message’s text body, if it has one; null otherwise.

getValue() - Method in class co.paralleluniverse.comsat.webactors.Cookie

The value of this Cookie.

getVersion() - Method in class co.paralleluniverse.comsat.webactors.Cookie

The version of the protocol this cookie complies with.

H

HttpMessage - Class in co.paralleluniverse.comsat.webactors

A message sent over an HTTP connection.

HttpMessage() - Constructor for class co.paralleluniverse.comsat.webactors.HttpMessage

HttpRequest - Class in co.paralleluniverse.comsat.webactors

An HTTP request message.

HttpRequest() - Constructor for class co.paralleluniverse.comsat.webactors.HttpRequest

HttpResponse - Class in co.paralleluniverse.comsat.webactors

An HTTP response message sent as a response to an HttpRequest.

HttpResponse(ActorRef<? super WebMessage>, HttpResponse) - Constructor for class co.paralleluniverse.comsat.webactors.HttpResponse

Use when forwarding

HttpResponse(ActorRef<? super WebMessage>, HttpResponse.Builder) - Constructor for class co.paralleluniverse.comsat.webactors.HttpResponse

HttpResponse.Builder - Class in co.paralleluniverse.comsat.webactors

HttpResponse.Builder(ActorRef<? super WebMessage>, HttpRequest, String) - Constructor for class co.paralleluniverse.comsat.webactors.HttpResponse.Builder

HttpResponse.Builder(ActorRef<? super WebMessage>, HttpRequest, ByteBuffer) - Constructor for class co.paralleluniverse.comsat.webactors.HttpResponse.Builder

HttpResponse.Builder(ActorRef<? super WebMessage>, HttpRequest) - Constructor for class co.paralleluniverse.comsat.webactors.HttpResponse.Builder

HttpStreamOpened - Class in co.paralleluniverse.comsat.webactors

A message sent to a web actor indicating that a new stream has been opened.

HttpStreamOpened(ActorRef<WebDataMessage>, HttpResponse) - Constructor for class co.paralleluniverse.comsat.webactors.HttpStreamOpened

I

isBinary() - Method in class co.paralleluniverse.comsat.webactors.WebDataMessage

Whether this is a binary message or a text message.

isHttpOnly() - Method in class co.paralleluniverse.comsat.webactors.Cookie

Whether this Cookie has been marked as HttpOnly.

isSecure() - Method in class co.paralleluniverse.comsat.webactors.Cookie

Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.

O

ok(HttpRequest, String) - Static method in class co.paralleluniverse.comsat.webactors.HttpResponse

Creates an HttpResponse with a text body and response code 200.

ok(HttpRequest, ByteBuffer) - Static method in class co.paralleluniverse.comsat.webactors.HttpResponse

Creates an HttpResponse with a binary body and response code 200.

R

reconnectTimeout(long) - Static method in class co.paralleluniverse.comsat.webactors.SSE

Encodes an indication to the client to attempt a reconnect if the connection is closed within the given time.

redirect(HttpRequest, String) - Static method in class co.paralleluniverse.comsat.webactors.HttpResponse

Sends a temporary redirect response to the client using the specified redirect location URL and clears the buffer.

S

setCharacterEncoding(Charset) - Method in class co.paralleluniverse.comsat.webactors.HttpResponse.Builder

Sets the character encoding (MIME charset) of the response being sent to the client, for example, UTF-8.

setComment(String) - Method in class co.paralleluniverse.comsat.webactors.Cookie.Builder

Specifies a comment that describes a cookie’s purpose.

setContentType(String) - Method in class co.paralleluniverse.comsat.webactors.HttpResponse.Builder

Sets the content type of the response being sent to the client.

setDomain(String) - Method in class co.paralleluniverse.comsat.webactors.Cookie.Builder

Specifies the domain within which this cookie should be presented.

setHttpOnly(boolean) - Method in class co.paralleluniverse.comsat.webactors.Cookie.Builder

Marks or unmarks this Cookie as HttpOnly.

setMaxAge(int) - Method in class co.paralleluniverse.comsat.webactors.Cookie.Builder

Sets the maximum age in seconds for this Cookie.

setPath(String) - Method in class co.paralleluniverse.comsat.webactors.Cookie.Builder

Specifies a path for the cookie to which the client should return the cookie.

setSecure(boolean) - Method in class co.paralleluniverse.comsat.webactors.Cookie.Builder

Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.

setVersion(int) - Method in class co.paralleluniverse.comsat.webactors.Cookie.Builder

Sets the version of the cookie protocol that this Cookie complies with.

shouldStartActor() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse

SSE - Class in co.paralleluniverse.comsat.webactors

Utility classes for SSE (Server-Sent Events).

startActor() - Method in class co.paralleluniverse.comsat.webactors.HttpResponse.Builder

Indicates that the connection to the client must not be closed after sending this response; rather an HttpStreamOpened message will be sent to the actor sending this response.

startSSE(HttpRequest) - Static method in class co.paralleluniverse.comsat.webactors.SSE

This method returns a new HttpResponse with its content type and character encoding set in compliance with to the SSE spec, and an empty body.

startSSE(HttpRequest, long) - Static method in class co.paralleluniverse.comsat.webactors.SSE

This method returns a new HttpResponse with its content type and character encoding set in compliance with to the SSE spec, and a body encoding a reconnection timeout indication.

status(int) - Method in class co.paralleluniverse.comsat.webactors.HttpResponse.Builder

Sets the status code for this response.

T

toString() - Method in class co.paralleluniverse.comsat.webactors.Cookie

W

WebActor - Annotation Type in co.paralleluniverse.comsat.webactors

A class annotated with this annotation will be automatically loaded by COMSAT and spawned as a web actor.

WebDataMessage - Class in co.paralleluniverse.comsat.webactors

A message that can be received from or sent to a web client, and contains only data (and no metadata like headers).

WebDataMessage(ActorRef<? super WebDataMessage>, String) - Constructor for class co.paralleluniverse.comsat.webactors.WebDataMessage

Constructs a WebDataMessage with a text body.

WebDataMessage(ActorRef<? super WebDataMessage>, ByteBuffer) - Constructor for class co.paralleluniverse.comsat.webactors.WebDataMessage

Constructs a WebDataMessage with a binary body.

WebMessage - Class in co.paralleluniverse.comsat.webactors

A message that is received from or can be set to a web client (via HTTP or WebSockets).

WebMessage() - Constructor for class co.paralleluniverse.comsat.webactors.WebMessage

WebSocketOpened - Class in co.paralleluniverse.comsat.webactors

A message sent to a web actor indicating that a new WebSocket has been opened by the client.

WebSocketOpened(ActorRef<WebDataMessage>) - Constructor for class co.paralleluniverse.comsat.webactors.WebSocketOpened

WebStreamOpened - Class in co.paralleluniverse.comsat.webactors

A message sent to a web actor indicating that a new stream has been opened by the client.

WebStreamOpened(ActorRef<WebDataMessage>) - Constructor for class co.paralleluniverse.comsat.webactors.WebStreamOpened

A B C E G H I O R S T W