ServletCall (Restlet project 2.1.4 API)

java.lang.Object
- org.restlet.engine.adapter.Call
- - org.restlet.engine.adapter.ServerCall
  - - org.restlet.ext.servlet.internal.ServletCall

```
public class ServletCall
extends ServerCall
```
Call that is used by the Servlet HTTP server connector.

Author:

Jerome Louvel

Constructor Summary

Constructors
Constructor and Description
`ServletCall(Server server, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Constructor.
`ServletCall(String serverAddress, int serverPort, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`abort()` Not supported.
`List<Certificate>`	`getCertificates()` Returns the chain of client SSL certificates, if available and accessible.
`String`	`getCipherSuite()` Returns the SSL Cipher Suite, if available and accessible.
`String`	`getClientAddress()` Returns the client address. Corresponds to the IP address of the requesting client.
`int`	`getClientPort()` Returns the client port. Corresponds to the TCP/IP port of the requesting client.
`String`	`getHostDomain()` Returns the server domain name.
`String`	`getMethod()` Returns the request method.
`Protocol`	`getProtocol()` Returns the server protocol.
`javax.servlet.http.HttpServletRequest`	`getRequest()` Returns the HTTP Servlet request.
`InputStream`	`getRequestEntityStream(long size)` Returns the request entity stream if it exists.
`Series<Header>`	`getRequestHeaders()` Returns the list of request headers.
`InputStream`	`getRequestHeadStream()` Returns the request head stream if it exists.
`String`	`getRequestUri()` Returns the full request URI.
`javax.servlet.http.HttpServletResponse`	`getResponse()` Returns the HTTP Servlet response.
`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.
`Integer`	`getSslKeySize()` Returns the SSL key size, if available and accessible.
`String`	`getSslSessionId()` Returns the SSL session ID, in hexadecimal encoding, if available and accessible.
`Principal`	`getUserPrincipal()` Returns the user principal.
`String`	`getVersion()` Returns the protocol version used.
`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 org.restlet.engine.adapter.ServerCall
complete, getContentLength, getHostPort, getRequestEntity, getSslSessionIdBytes, isClientKeepAlive, isServerKeepAlive, readRequestHead, shouldResponseBeChunked, writeResponseBody, writeResponseHead, writeResponseHead

Methods inherited from class org.restlet.engine.adapter.Call
getLogger, getReasonPhrase, getRepresentation, getRepresentation, getResponseHeaders, getStatusCode, isBroken, isConnectionBroken, isKeepAlive, isRequestChunked, isResponseChunked, setClientAddress, setClientPort, setConfidential, setHostDomain, setHostPort, setMethod, setProtocol, setReasonPhrase, setRequestUri, setServerAddress, setServerPort, setStatusCode, setUserPrincipal, setVersion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ServletCall
```
public ServletCall(Server server,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
```
    Constructor.
    
    Parameters:
    
    server - The parent server.
    
    request - The HTTP Servlet request to wrap.
    
    response - The HTTP Servlet response to wrap.
  - ServletCall
```
public ServletCall(String serverAddress,
                   int serverPort,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
```
    Constructor.
    
    Parameters:
    
    serverAddress - The server IP address.
    
    serverPort - The server port.
    
    request - The Servlet request
    
    response - The Servlet response.
- Method Detail
  - abort
```
public boolean abort()
```
    Not supported. Always returns false.
    
    Specified by:
    
    abort in class ServerCall
    
    Returns:
    
    True if the request was aborted.
  - getCertificates
```
public List<Certificate> getCertificates()
```
    Description copied from class: ServerCall
    
    Returns the chain of client SSL certificates, if available and accessible.
    
    Overrides:
    
    getCertificates in class ServerCall
    
    Returns:
    
    The chain of client SSL certificates, if available and accessible.
  - getCipherSuite
```
public String getCipherSuite()
```
    Description copied from class: ServerCall
    
    Returns the SSL Cipher Suite, if available and accessible.
    
    Overrides:
    
    getCipherSuite in class ServerCall
    
    Returns:
    
    The SSL Cipher Suite, if available and accessible.
  - getClientAddress
```
public String getClientAddress()
```
    Description copied from class: Call
    
    Returns the client address.
    Corresponds to the IP address of the requesting client.
    
    Overrides:
    
    getClientAddress in class Call
    
    Returns:
    
    The client address.
  - getClientPort
```
public int getClientPort()
```
    Description copied from class: Call
    
    Returns the client port.
    Corresponds to the TCP/IP port of the requesting client.
    
    Overrides:
    
    getClientPort in class Call
    
    Returns:
    
    The client port.
  - getHostDomain
```
public String getHostDomain()
```
    Returns the server domain name.
    
    Overrides:
    
    getHostDomain in class ServerCall
    
    Returns:
    
    The server domain name.
  - getMethod
```
public String getMethod()
```
    Returns the request method.
    
    Overrides:
    
    getMethod in class Call
    
    Returns:
    
    The request method.
  - getProtocol
```
public Protocol getProtocol()
```
    Returns the server protocol.
    
    Overrides:
    
    getProtocol in class Call
    
    Returns:
    
    The server protocol.
  - getRequest
```
public javax.servlet.http.HttpServletRequest getRequest()
```
    Returns the HTTP Servlet request.
    
    Returns:
    
    The HTTP Servlet request.
  - getRequestEntityStream
```
public InputStream getRequestEntityStream(long size)
```
    Description copied from class: ServerCall
    
    Returns the request entity stream if it exists.
    
    Specified by:
    
    getRequestEntityStream in class ServerCall
    
    Parameters:
    
    size - The expected entity size or -1 if unknown.
    
    Returns:
    
    The request entity stream if it exists.
  - getRequestHeaders
```
public Series<Header> getRequestHeaders()
```
    Returns the list of request headers.
    
    Overrides:
    
    getRequestHeaders in class Call
    
    Returns:
    
    The list of request headers.
  - getRequestHeadStream
```
public InputStream getRequestHeadStream()
```
    Description copied from class: ServerCall
    
    Returns the request head stream if it exists.
    
    Specified by:
    
    getRequestHeadStream in class ServerCall
    
    Returns:
    
    The request head stream if it exists.
  - getRequestUri
```
public String getRequestUri()
```
    Returns the full request URI.
    
    Overrides:
    
    getRequestUri in class Call
    
    Returns:
    
    The full request URI.
  - getResponse
```
public javax.servlet.http.HttpServletResponse getResponse()
```
    Returns the HTTP Servlet response.
    
    Returns:
    
    The HTTP Servlet response.
  - getResponseEntityStream
```
public OutputStream getResponseEntityStream()
```
    Returns the response stream if it exists, null otherwise.
    
    Specified by:
    
    getResponseEntityStream in class ServerCall
    
    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 Call
    
    Returns:
    
    The response address.
  - getServerPort
```
public int getServerPort()
```
    Returns the server port.
    
    Overrides:
    
    getServerPort in class Call
    
    Returns:
    
    The server port.
  - getSslKeySize
```
public Integer getSslKeySize()
```
    Description copied from class: ServerCall
    
    Returns the SSL key size, if available and accessible.
    
    Overrides:
    
    getSslKeySize in class ServerCall
    
    Returns:
    
    The SSL key size, if available and accessible.
  - getSslSessionId
```
public String getSslSessionId()
```
    Description copied from class: ServerCall
    
    Returns the SSL session ID, in hexadecimal encoding, if available and accessible.
    
    Overrides:
    
    getSslSessionId in class ServerCall
    
    Returns:
    
    The SSL session ID, in hexadecimal encoding, if available and accessible.
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    Description copied from class: Call
    
    Returns the user principal.
    
    Overrides:
    
    getUserPrincipal in class Call
    
    Returns:
    
    The user principal.
  - getVersion
```
public String getVersion()
```
    Description copied from class: Call
    
    Returns the protocol version used.
    
    Overrides:
    
    getVersion in class Call
    
    Returns:
    
    The protocol version used.
  - isConfidential
```
public boolean isConfidential()
```
    Indicates if the request was made using a confidential mean.
    
    Overrides:
    
    isConfidential in class Call
    
    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 ServerCall
    
    Parameters:
    
    response - The high-level response.
    
    Throws:
    
    IOException - if the Response could not be written to the network.

Class ServletCall

Constructor Summary

Method Summary

Methods inherited from class org.restlet.engine.adapter.ServerCall

Methods inherited from class org.restlet.engine.adapter.Call

Methods inherited from class java.lang.Object

Constructor Detail

ServletCall

ServletCall

Method Detail

abort

getCertificates

getCipherSuite

getClientAddress

getClientPort

getHostDomain

getMethod

getProtocol

getRequest

getRequestEntityStream

getRequestHeaders

getRequestHeadStream

getRequestUri

getResponse

getResponseEntityStream

getServerAddress

getServerPort

getSslKeySize

getSslSessionId

getUserPrincipal

getVersion

isConfidential

sendResponse