|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.engine.Helper
org.restlet.engine.RestletHelper<T>
org.restlet.engine.ConnectorHelper<T>
org.restlet.engine.http.connector.BaseHelper<Server>
org.restlet.engine.http.connector.BaseServerHelper
public abstract class BaseServerHelper
Base server helper based on NIO blocking sockets. Here is the list of parameters that are supported. They should be set in the Server's context before it is started:
Parameter name | Value type | Default value | Description | useForwardedForHeader | boolean | false | Lookup the "X-Forwarded-For" header supported by popular proxies and caches and uses it to populate the Request.getClientAddresses() method result. This information is only safe for intermediary components within your local network. Other addresses could easily be changed by setting a fake header and should not be trusted for serious security checks. |
---|
Constructor Summary | |
---|---|
BaseServerHelper(Server server)
Constructor. |
Method Summary | |
---|---|
protected ExecutorService |
createAcceptorService()
Creates the handler service. |
protected ServerSocket |
createServerSocket()
Create a server socket channel and bind it to the given address |
protected SocketAddress |
createSocketAddress()
Creates a socket address to listen on. |
ServerSocket |
getServerSocket()
Returns the server socket. |
void |
handle(Request request,
Response response)
Handles a call by invoking the helped Server's Server.handle(Request, Response) method. |
void |
handleInbound(Response response)
Handles an inbound message. |
void |
handleOutbound(Response response)
Handles an outbound message. |
boolean |
isProxying()
Indicates if the helper is going through a client proxy or is a server proxy. |
void |
setEphemeralPort(int localPort)
Sets the ephemeral port in the attributes map if necessary. |
void |
setEphemeralPort(ServerSocket socket)
Sets the ephemeral port in the attributes map if necessary. |
void |
start()
Start callback. |
void |
stop()
Stop callback. |
Methods inherited from class org.restlet.engine.ConnectorHelper |
---|
getConnectorService, getContext, getProtocols, update |
Methods inherited from class org.restlet.engine.RestletHelper |
---|
getAttributes, getHelped, getHelpedParameters, getLogger, getMetadataService, setHelped |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BaseServerHelper(Server server)
server
- The server to help.Method Detail |
---|
protected ExecutorService createAcceptorService()
protected ServerSocket createServerSocket() throws IOException
IOException
protected SocketAddress createSocketAddress() throws IOException
IOException
public ServerSocket getServerSocket()
public void handle(Request request, Response response)
Server.handle(Request, Response)
method.
handle
in class RestletHelper<Server>
request
- The request to handle.response
- The response to update.public void handleInbound(Response response)
BaseHelper
handleInbound
in class BaseHelper<Server>
response
- The response to handle.public void handleOutbound(Response response)
BaseHelper
handleOutbound
in class BaseHelper<Server>
response
- The response to handle.public boolean isProxying()
BaseHelper
isProxying
in class BaseHelper<Server>
public void setEphemeralPort(int localPort)
localPort
- The ephemeral local port.public void setEphemeralPort(ServerSocket socket)
socket
- The bound server socket.public void start() throws Exception
RestletHelper
start
in class BaseHelper<Server>
Exception
public void stop() throws Exception
RestletHelper
stop
in class BaseHelper<Server>
Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |