com.noelios.restlet.ext.servlet
Class ServletCall

java.lang.Object
  com.noelios.restlet.http.HttpCall
      com.noelios.restlet.http.HttpServerCall
          com.noelios.restlet.ext.servlet.ServletCall

public class ServletCall
extends HttpServerCall

Call that is used by the Servlet HTTP server connector.

Author:

Jerome Louvel

Constructor Summary

ServletCall(Server server, HttpServletRequest request, HttpServletResponse response)
Constructor.

ServletCall(String serverAddress, int serverPort, HttpServletRequest request, HttpServletResponse response)
Constructor.

Method Summary

String	getClientAddress()
int	getClientPort()
String	getHostDomain() Returns the server domain name.
String	getMethod() Returns the request method.
Protocol	getProtocol() Returns the server protocol.
HttpServletRequest	getRequest() Returns the HTTP Servlet request.
static HttpServletRequest	getRequest(Request request) Returns the Servlet request that was used to generate the given Restlet request.
ReadableByteChannel	getRequestEntityChannel(long size)
InputStream	getRequestEntityStream(long size)
ReadableByteChannel	getRequestHeadChannel()
Series<Parameter>	getRequestHeaders() Returns the list of request headers.
InputStream	getRequestHeadStream()
String	getRequestUri() Returns the full request URI.
HttpServletResponse	getResponse() Returns the HTTP Servlet response.
WritableByteChannel	getResponseEntityChannel() Returns the response channel if it exists, null otherwise.
OutputStream	getResponseEntityStream() Returns the response stream if it exists, null otherwise.
String	getServerAddress() Returns the response address. Corresponds to the IP address of the responding server.
int	getServerPort() Returns the server port.
String	getSslCipherSuite()
List<Certificate>	getSslClientCertificates()
Integer	getSslKeySize()
String	getVersion()
boolean	isConfidential() Indicates if the request was made using a confidential mean.
void	sendResponse(Response response) Sends the response back to the client.

Methods inherited from class com.noelios.restlet.http.HttpServerCall

complete, formatContentDisposition, getContentLength, getHostPort, getRequestEntity, isClientKeepAlive, isServerKeepAlive, readRequestHead, shouldResponseBeChunked, writeResponseBody, writeResponseHead, writeResponseHead

Methods inherited from class com.noelios.restlet.http.HttpCall

formatDate, getConnectorService, getContentLength, getLogger, getReasonPhrase, getResponseHeaders, getStatusCode, isConnectionBroken, isKeepAlive, isRequestChunked, isResponseChunked, parseDate, setClientAddress, setClientPort, setConfidential, setHostDomain, setHostPort, setMethod, setProtocol, setReasonPhrase, setRequestUri, setServerAddress, setServerPort, setStatusCode, setVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletCall

public ServletCall(String serverAddress,
                   int serverPort,
                   HttpServletRequest request,
                   HttpServletResponse response)

Constructor.

Parameters:

serverAddress - The server IP address.

serverPort - The server port.

request - The Servlet request

response - The Servlet response.

ServletCall

public ServletCall(Server server,
                   HttpServletRequest request,
                   HttpServletResponse response)

Constructor.

Parameters:

server - The parent server.

request - The HTTP Servlet request to wrap.

response - The HTTP Servlet response to wrap.

Method Detail

getRequest

public static HttpServletRequest getRequest(Request request)

Returns the Servlet request that was used to generate the given Restlet request.

Parameters:

request - The Restlet request.

Returns:

The Servlet request or null.

getClientAddress

public String getClientAddress()

Overrides:

getClientAddress in class HttpCall

getClientPort

public int getClientPort()

Overrides:

getClientPort in class HttpCall

getHostDomain

public String getHostDomain()

Returns the server domain name.

Overrides:

getHostDomain in class HttpServerCall

Returns:

The server domain name.

getMethod

public String getMethod()

Returns the request method.

Overrides:

getMethod in class HttpCall

Returns:

The request method.

getProtocol

public Protocol getProtocol()

Returns the server protocol.

Overrides:

getProtocol in class HttpCall

Returns:

The server protocol.

getRequest

public HttpServletRequest getRequest()

Returns the HTTP Servlet request.

Returns:

The HTTP Servlet request.

getRequestEntityChannel

public ReadableByteChannel getRequestEntityChannel(long size)

Specified by:

getRequestEntityChannel in class HttpServerCall

getRequestEntityStream

public InputStream getRequestEntityStream(long size)

Specified by:

getRequestEntityStream in class HttpServerCall

getRequestHeadChannel

public ReadableByteChannel getRequestHeadChannel()

Specified by:

getRequestHeadChannel in class HttpServerCall

getRequestHeaders

public Series<Parameter> getRequestHeaders()

Returns the list of request headers.

Overrides:

getRequestHeaders in class HttpCall

Returns:

The list of request headers.

getRequestHeadStream

public InputStream getRequestHeadStream()

Specified by:

getRequestHeadStream in class HttpServerCall

getRequestUri

public String getRequestUri()

Returns the full request URI.

Overrides:

getRequestUri in class HttpCall

Returns:

The full request URI.

getResponse

public HttpServletResponse getResponse()

Returns the HTTP Servlet response.

Returns:

The HTTP Servlet response.

getResponseEntityChannel

public WritableByteChannel getResponseEntityChannel()

Returns the response channel if it exists, null otherwise.

Specified by:

getResponseEntityChannel in class HttpServerCall

Returns:

The response channel if it exists, null otherwise.

getResponseEntityStream

public OutputStream getResponseEntityStream()

Returns the response stream if it exists, null otherwise.

Specified by:

getResponseEntityStream in class HttpServerCall

Returns:

The response stream if it exists, null otherwise.

getServerAddress

public String getServerAddress()

Returns the response address.
Corresponds to the IP address of the responding server.

Overrides:

getServerAddress in class HttpCall

Returns:

The response address.

getServerPort

public int getServerPort()

Returns the server port.

Overrides:

getServerPort in class HttpCall

Returns:

The server port.

getSslCipherSuite

public String getSslCipherSuite()

Overrides:

getSslCipherSuite in class HttpServerCall

getSslClientCertificates

public List<Certificate> getSslClientCertificates()

Overrides:

getSslClientCertificates in class HttpServerCall

getSslKeySize

public Integer getSslKeySize()

Overrides:

getSslKeySize in class HttpServerCall

getVersion

public String getVersion()

Overrides:

getVersion in class HttpCall

isConfidential

public boolean isConfidential()

Indicates if the request was made using a confidential mean.

Overrides:

isConfidential in class HttpCall

Returns:

True if the request was made using a confidential mean.

sendResponse

public void sendResponse(Response response)
                  throws IOException

Sends the response back to the client. Commits the status, headers and optional entity and send them on the network.

Overrides:

sendResponse in class HttpServerCall

Parameters:

response - The high-level response.

Throws:

IOException