org.restlet.ext.netty
Class HttpsServerHelper

java.lang.Object
  extended by org.restlet.engine.Helper
      extended by org.restlet.engine.RestletHelper<T>
          extended by org.restlet.engine.ConnectorHelper<Server>
              extended by org.restlet.engine.ServerHelper
                  extended by org.restlet.engine.http.HttpServerHelper
                      extended by org.restlet.ext.netty.NettyServerHelper
                          extended by org.restlet.ext.netty.HttpsServerHelper

public class HttpsServerHelper
extends NettyServerHelper

Netty HTTPS server connector. Here is the list of additional parameters that are supported. They should be set in the Server's context before it is started:

Parameter name Value type Default value Description
certAlgorithm String SunX509 SSL certificate algorithm
keyPassword String SSL key password
keystorePassword String SSL keystore password
keystorePath String ${user.home}/.keystore SSL keystore path
keystoreType String JKS SSL keystore type
sslProtocol String TLS SSL protocol
needClientAuthentication boolean false Indicates if we require client certificate authentication
wantClientAuthentication boolean false Indicates if we would like client certificate authentication

Author:
Gabriel Ciuloaica (gciuloaica@gmail.com)
See Also:
Netty home page

Constructor Summary
HttpsServerHelper(Server server)
          Constructor.
 
Method Summary
 String getCertAlgorithm()
          Deprecated. 
 String getKeyPassword()
          Deprecated. 
 String getKeystorePassword()
          Deprecated. 
 String getKeystorePath()
          Deprecated. 
 String getKeystoreType()
          Deprecated. 
 ChannelPipelineFactory getPipelineFatory()
          Returns the Netty pipeline factory.
 SSLContext getSslContext()
          Gets the SSL context used by this server.
 String getSslProtocol()
          Deprecated. 
 boolean isNeedClientAuthentication()
          Indicates if we require client certificate authentication.
 boolean isWantClientAuthentication()
          Indicates if we would like client certificate authentication.
 void setSslContext(SSLContext sslContext)
          Sets the SSL context for the server.
 void start()
           
 
Methods inherited from class org.restlet.ext.netty.NettyServerHelper
stop
 
Methods inherited from class org.restlet.engine.http.HttpServerHelper
getAdapter, handle, setAdapter
 
Methods inherited from class org.restlet.engine.ServerHelper
handle, setEphemeralPort, setEphemeralPort
 
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

HttpsServerHelper

public HttpsServerHelper(Server server)
Constructor.

Parameters:
server - The helped server.
Method Detail

getCertAlgorithm

@Deprecated
public String getCertAlgorithm()
Deprecated. 

Returns the SSL certificate algorithm.

Returns:
The SSL certificate algorithm.

getKeyPassword

@Deprecated
public String getKeyPassword()
Deprecated. 

Returns the SSL key password.

Returns:
The SSL key password.

getKeystorePassword

@Deprecated
public String getKeystorePassword()
Deprecated. 

Returns the SSL keystore password.

Returns:
The SSL keystore password.

getKeystorePath

@Deprecated
public String getKeystorePath()
Deprecated. 

Returns the SSL keystore path.

Returns:
The SSL keystore path.

getKeystoreType

@Deprecated
public String getKeystoreType()
Deprecated. 

Returns the SSL keystore type.

Returns:
The SSL keystore type.

getPipelineFatory

public ChannelPipelineFactory getPipelineFatory()
Description copied from class: NettyServerHelper
Returns the Netty pipeline factory.

Specified by:
getPipelineFatory in class NettyServerHelper
Returns:
The Netty pipeline factory.

getSslContext

public SSLContext getSslContext()
Gets the SSL context used by this server.

Returns:
this returns the SSL context.

getSslProtocol

@Deprecated
public String getSslProtocol()
Deprecated. 

Returns the SSL keystore type.

Returns:
The SSL keystore type.

isNeedClientAuthentication

public boolean isNeedClientAuthentication()
Indicates if we require client certificate authentication.

Returns:
True if we require client certificate authentication.

isWantClientAuthentication

public boolean isWantClientAuthentication()
Indicates if we would like client certificate authentication.

Returns:
True if we would like client certificate authentication.

setSslContext

public void setSslContext(SSLContext sslContext)
Sets the SSL context for the server.

Parameters:
sslContext - the SSL context

start

public void start()
           throws Exception
Overrides:
start in class NettyServerHelper
Throws:
Exception


Copyright © 2005-2012 Restlet S.A.S..