org.infinispan.rest

Class InfinispanResponse

java.lang.Object

org.infinispan.rest.InfinispanResponse

public class InfinispanResponse
extends Object

Representation of a HTTP response tailed for Infinispan-specific responses.

Author:

Sebastian Łaskawiec

Method Summary

Modifier and Type	Method and Description
static InfinispanResponse	asError(InfinispanRequest request, io.netty.handler.codec.http.HttpResponseStatus status, String description) Creates an InfinispanResponse as an error.
void	authenticate(String authenticateHeader) Adds www-authenticate header.
void	cacheControl(CacheControl cacheControl) Adds Cache Control headers.
void	charset(Charset charset) Adds a charset.
void	clusterNodeName(String nodeName) Adds Cluster-Node-Name header.
void	clusterPrimaryOwner(String primaryOwner) Adds Cluster-Primary-Owner header.
void	clusterServerAddress(String serverAddress) Adds Cluster-Server-Address header.
void	contentAsBytes(byte[] content) Adds content as binary array.
void	contentAsText(String content) Adds content as text.
void	contentType(String contentType) Adds Content-Type header.
void	etag(String etag) Adds ETAG.
void	expires(Date expires) Adds expires header.
void	httpVersion(io.netty.handler.codec.http.HttpVersion httpVersion) Adds HTTP version header.
static InfinispanResponse	inReplyTo(InfinispanRequest request) Creates an InfinispanResponse as a reply to specific InfinispanRequest.
boolean	isKeepAlive() Checks whether this is a Keep Alive type of response.
void	lastModified(Date lastModified) Add last-modified header.
void	maxIdle(long maxIdle) Adds maxIdleTimeSeconds header.
void	status(io.netty.handler.codec.http.HttpResponseStatus httpStatus) Adds status code.
void	timeToLive(long lifespan)
io.netty.handler.codec.http.FullHttpResponse	toNettyHttpResponse() Renders FullHttpResponse object.

Methods inherited from class java.lang.Object

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

Method Detail

inReplyTo

public static final InfinispanResponse inReplyTo(InfinispanRequest request)

Creates an InfinispanResponse as a reply to specific InfinispanRequest.

Parameters:

request - Request to reply to.

Returns:

Response object.

asError

public static final InfinispanResponse asError(InfinispanRequest request,
                                               io.netty.handler.codec.http.HttpResponseStatus status,
                                               String description)

Creates an InfinispanResponse as an error.

Returns:

Response object.

contentAsText

public void contentAsText(String content)

Adds content as text. Converts it internally to UTF-8.

Parameters:

content - Content.

contentAsBytes

public void contentAsBytes(byte[] content)

Adds content as binary array.

Parameters:

content - Content.

contentType

public void contentType(String contentType)

Adds Content-Type header.

Parameters:

contentType - Content-Type header.

httpVersion

public void httpVersion(io.netty.handler.codec.http.HttpVersion httpVersion)

Adds HTTP version header.

Parameters:

httpVersion - HTTP version header.

status

public void status(io.netty.handler.codec.http.HttpResponseStatus httpStatus)

Adds status code.

Parameters:

httpStatus - Status code.

isKeepAlive

public boolean isKeepAlive()

Checks whether this is a Keep Alive type of response.

Returns:

true if the response contains Keep Alive headers.

toNettyHttpResponse

public io.netty.handler.codec.http.FullHttpResponse toNettyHttpResponse()

Renders FullHttpResponse object.

Returns:

FullHttpResponse object based on this InfinispanResponse.

etag

public void etag(String etag)

Adds ETAG.

Parameters:

etag - ETag value to be added.

cacheControl

public void cacheControl(CacheControl cacheControl)

Adds Cache Control headers.

Parameters:

cacheControl - Cache Control headers.

lastModified

public void lastModified(Date lastModified)

Add last-modified header.

Parameters:

lastModified - last-modified header value.

expires

public void expires(Date expires)

Adds expires header.

Parameters:

expires - expires header value.

timeToLive

public void timeToLive(long lifespan)

maxIdle

public void maxIdle(long maxIdle)

Adds maxIdleTimeSeconds header.

Parameters:

maxIdle - maxIdleTimeSeconds header value.

clusterPrimaryOwner

public void clusterPrimaryOwner(String primaryOwner)

Adds Cluster-Primary-Owner header.

Parameters:

primaryOwner - Cluster-Primary-Owner header value.

clusterNodeName

public void clusterNodeName(String nodeName)

Adds Cluster-Node-Name header.

Parameters:

nodeName - Cluster-Node-Name header value.

clusterServerAddress

public void clusterServerAddress(String serverAddress)

Adds Cluster-Server-Address header.

Parameters:

serverAddress - Cluster-Server-Address header value.

authenticate

public void authenticate(String authenticateHeader)

Adds www-authenticate header.

Parameters:

authenticateHeader - www-authenticate header value.

charset

public void charset(Charset charset)

Adds a charset.

Parameters:

charset - charset value.