com.noelios.restlet.ext.simple
Class HttpsServerHelper

java.lang.Object
  extended by org.restlet.util.Helper<T>
      extended by com.noelios.restlet.ConnectorHelper<Server>
          extended by com.noelios.restlet.ServerHelper
              extended by com.noelios.restlet.http.HttpServerHelper
                  extended by com.noelios.restlet.ext.simple.SimpleServerHelper
                      extended by com.noelios.restlet.ext.simple.HttpsServerHelper

public class HttpsServerHelper
extends SimpleServerHelper

Simple HTTP server connector. Here is the list of additional parameters that are supported:

Parameter name Value type Default value Description
sslContextFactory String null Let you specify a SslContextFactory instance for a more complete and flexible SSL context setting. If this parameter is set, it takes precedance over the other SSL parameters below.
sslContextFactory String null Let you specify a SslContextFactory class name as a parameter, or an instance as an attribute for a more complete and flexible SSL context setting. If set, it takes precedance over the other SSL parameters below.
keystorePath String ${user.home}/.keystore SSL keystore path.
keystorePassword String SSL keystore password.
keystoreType String JKS SSL keystore type
keyPassword String SSL key password.
certAlgorithm String SunX509 SSL certificate algorithm.
enabledCipherSuites String null Whitespace-separated list of enabled cipher suites and/or can be specified multiple times.
disabledCipherSuites String null Whitespace-separated list of disabled cipher suites and/or can be specified multiple times. It affects the cipher suites manually enabled or the default ones.
needClientAuthentication boolean false Indicates if we require client certificate authentication.
sslProtocol String TLS SSL protocol.
wantClientAuthentication boolean false Indicates if we would like client certificate authentication (only for the BIO connector type).

Author:
Lars Heuer, Jerome Louvel

Constructor Summary
HttpsServerHelper(Server server)
          Constructor.
 
Method Summary
 java.lang.String getCertAlgorithm()
          Returns the SSL certificate algorithm.
 java.lang.String getKeyPassword()
          Returns the SSL key password.
 java.lang.String getKeystorePassword()
          Returns the SSL keystore password.
 java.lang.String getKeystorePath()
          Returns the SSL keystore path.
 java.lang.String getKeystoreType()
          Returns the SSL keystore type.
 java.lang.String getSslProtocol()
          Returns the SSL keystore type.
 boolean isNeedClientAuthentication()
          Indicates if we require client certificate authentication.
 boolean isWantClientAuthentication()
          Indicates if we would like client certificate authentication.
 void start()
          Starts the Restlet.
 
Methods inherited from class com.noelios.restlet.ext.simple.SimpleServerHelper
getConnection, getDefaultThreads, getHandler, getMaxWaitTimeMs, getSocket, isConfidential, setConfidential, setConnection, setHandler, setSocket, stop
 
Methods inherited from class com.noelios.restlet.http.HttpServerHelper
getConverter, handle, setConverter
 
Methods inherited from class com.noelios.restlet.ServerHelper
handle, setEphemeralPort, setEphemeralPort
 
Methods inherited from class com.noelios.restlet.ConnectorHelper
getProtocols, update
 
Methods inherited from class org.restlet.util.Helper
getAttributes, getContext, getHelped, getHelpedParameters, getLogger, 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 server to help.
Method Detail

getCertAlgorithm

public java.lang.String getCertAlgorithm()
Returns the SSL certificate algorithm.

Returns:
The SSL certificate algorithm.

getKeyPassword

public java.lang.String getKeyPassword()
Returns the SSL key password.

Returns:
The SSL key password.

getKeystorePassword

public java.lang.String getKeystorePassword()
Returns the SSL keystore password.

Returns:
The SSL keystore password.

getKeystorePath

public java.lang.String getKeystorePath()
Returns the SSL keystore path.

Returns:
The SSL keystore path.

getKeystoreType

public java.lang.String getKeystoreType()
Returns the SSL keystore type.

Returns:
The SSL keystore type.

getSslProtocol

public java.lang.String getSslProtocol()
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.

start

public void start()
           throws java.lang.Exception
Starts the Restlet.

Overrides:
start in class SimpleServerHelper
Throws:
java.lang.Exception


Copyright © 2005-2008 Noelios Technologies.