com.vmware.vapi.protocol.server.rpc.http.impl

Class HttpsEndpoint

java.lang.Object

com.vmware.vapi.protocol.server.rpc.http.impl.HttpEndpoint

com.vmware.vapi.protocol.server.rpc.http.impl.HttpsEndpoint

All Implemented Interfaces:

Endpoint, SslEndpoint

public class HttpsEndpoint
extends HttpEndpoint
implements SslEndpoint

Implementation of an HTTPS server endpoint.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vapi.protocol.server.rpc.http.Endpoint

Endpoint.EndpointType, Endpoint.Protocol

Field Summary

Fields inherited from class com.vmware.vapi.protocol.server.rpc.http.impl.HttpEndpoint

_acceptQueueSize, _host, _maxIdleTime, _numAcceptors, _port, _protocol, _type

Constructor Summary

Constructors

Constructor and Description
HttpsEndpoint(int port) Construct an SSL endpoint that listens on all interfaces.
HttpsEndpoint(String host, int port) Construct an SSL endpoint for a particular host, port, and protocol.

Method Summary

Modifier and Type	Method and Description
String	getEnabledProtocols() Gets the list of protocols that are enabled for use by SSL connections.
String	getKeyAlias() Returns the alias of the key/cert pair to use for this endpoint.
String	getKeyPassword() Returns the key password.
String	getKeyStorePassword() Returns the keystore password.
String	getKeyStorePath() Returns the path to the keystore.
String	getKeyStoreType() Returns keystore type
boolean	getNeedClientAuth() Gets whether server requires the client to authenticate with certificate.
String	getTrustStorePassword() Returns the trust store password.
String	getTrustStorePath() Returns the path to the trust store.
boolean	getWantClientAuth() Gets whether server desires the client to authenticate with certificate.
void	setEnabledProtocols(String enabledProtocols) Sets the list of protocols that are enabled for use by SSL connections.
void	setKeyPassword(String keyPassword) Set the password for the private key.
void	setKeyStorePassword(String keyStorePassword) Set the password for the keystore.
void	setKeyStorePath(String keyStorePath) Set the endpoint's keystore.
void	setKeyStoreResource(org.springframework.core.io.Resource keystore) Set keystore (for spring config).
void	setKeyStoreType(String type) Sets keystore type
void	setNeedClientAuth(boolean needed) Sets whether the server will require the client to authenticate with certificate.
void	setTrustStorePassword(String trustStorePassword) Set the password for the trust store.
void	setTrustStorePath(String trustStorePath) Set the endpoint's trust store.
void	setWantClientAuth(boolean wanted) Sets whether the server will desire the client to authenticate with certificate.

Methods inherited from class com.vmware.vapi.protocol.server.rpc.http.impl.HttpEndpoint

getAcceptQueueSize, getEndpointType, getHost, getMaxIdleTime, getNumAcceptors, getPort, getProtocol, setAcceptQueueSize, setEndpointType, setMaxIdleTime, setNumAcceptors, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vmware.vapi.protocol.server.rpc.http.Endpoint

getAcceptQueueSize, getEndpointType, getHost, getMaxIdleTime, getNumAcceptors, getPort, getProtocol, setAcceptQueueSize, setEndpointType, setMaxIdleTime, setNumAcceptors

Constructor Detail

HttpsEndpoint

public HttpsEndpoint(String host,
                     int port)

Construct an SSL endpoint for a particular host, port, and protocol.

Parameters:

host - The listening interface.

port - The listening port.

HttpsEndpoint

public HttpsEndpoint(int port)

Construct an SSL endpoint that listens on all interfaces.

Parameters:

port - The listening port.

Method Detail

setKeyStoreType

public void setKeyStoreType(String type)

Sets keystore type

Parameters:

type - keystore type

setKeyStorePath

public void setKeyStorePath(String keyStorePath)

Set the endpoint's keystore.

Parameters:

keyStorePath - The path to the endpoint's keystore.

setKeyStoreResource

public void setKeyStoreResource(org.springframework.core.io.Resource keystore)
                         throws IOException

Set keystore (for spring config).

Parameters:

keystore - resource representing the keystore. Must not be null. The resource must not be pointing to a file on the classpath which is in a jar.

Throws:

IOException

setKeyStorePassword

public void setKeyStorePassword(String keyStorePassword)

Set the password for the keystore.

Parameters:

keyStorePassword - The keystore password.

setKeyPassword

public void setKeyPassword(String keyPassword)

Set the password for the private key.

Parameters:

keyPassword - The key password.

setTrustStorePath

public void setTrustStorePath(String trustStorePath)

Set the endpoint's trust store.

Parameters:

trustStorePath - The path to the endpoint's keystore.

setTrustStorePassword

public void setTrustStorePassword(String trustStorePassword)

Set the password for the trust store.

Parameters:

trustStorePassword - The keystore password.

getKeyStorePath

public String getKeyStorePath()

Description copied from interface: SslEndpoint

Returns the path to the keystore.

Specified by:

getKeyStorePath in interface SslEndpoint

Returns:

The path to the keystore.

getKeyStorePassword

public String getKeyStorePassword()

Description copied from interface: SslEndpoint

Returns the keystore password.

Specified by:

getKeyStorePassword in interface SslEndpoint

Returns:

The keystore password;

getKeyPassword

public String getKeyPassword()

Description copied from interface: SslEndpoint

Returns the key password.

Specified by:

getKeyPassword in interface SslEndpoint

Returns:

The key password;

getKeyAlias

public String getKeyAlias()

Description copied from interface: SslEndpoint

Returns the alias of the key/cert pair to use for this endpoint. This value may not be configurable for some implementations. For example, the Jetty SSL connectors will always look for a key/cert pairs whose alias is "jetty".

Specified by:

getKeyAlias in interface SslEndpoint

Returns:

The alias of the key/cert pair to use for this endpoint.

getTrustStorePath

public String getTrustStorePath()

Description copied from interface: SslEndpoint

Returns the path to the trust store.

Specified by:

getTrustStorePath in interface SslEndpoint

Returns:

The path to the trust store. May be null if no trust store is configured.

getTrustStorePassword

public String getTrustStorePassword()

Description copied from interface: SslEndpoint

Returns the trust store password.

Specified by:

getTrustStorePassword in interface SslEndpoint

Returns:

The trust store password. May be null if no trust store is configured.

setNeedClientAuth

public void setNeedClientAuth(boolean needed)

Description copied from interface: SslEndpoint

Sets whether the server will require the client to authenticate with certificate.

Specified by:

setNeedClientAuth in interface SslEndpoint

Parameters:

needed - true if authentication is needed

getNeedClientAuth

public boolean getNeedClientAuth()

Description copied from interface: SslEndpoint

Gets whether server requires the client to authenticate with certificate.

Specified by:

getNeedClientAuth in interface SslEndpoint

Returns:

true if client must provide certificate

getWantClientAuth

public boolean getWantClientAuth()

Description copied from interface: SslEndpoint

Gets whether server desires the client to authenticate with certificate.

Specified by:

getWantClientAuth in interface SslEndpoint

Returns:

true if client may provide certificate

setWantClientAuth

public void setWantClientAuth(boolean wanted)

Description copied from interface: SslEndpoint

Sets whether the server will desire the client to authenticate with certificate.

Specified by:

setWantClientAuth in interface SslEndpoint

Parameters:

wanted - true if authentication is desired

getKeyStoreType

public String getKeyStoreType()

Description copied from interface: SslEndpoint

Returns keystore type

Specified by:

getKeyStoreType in interface SslEndpoint

setEnabledProtocols

public void setEnabledProtocols(String enabledProtocols)

Sets the list of protocols that are enabled for use by SSL connections.

The specified protocols must be among SSLv2Hello, SSLv3, TLSv1, TLSv1.1 and TLSv1.2; otherwise, applying this configuration over an SSLSocket later would fail.

Defaults to TLSv1,TLSv1.1,TLSv1.2.

Parameters:

enabledProtocols - comma separated list of protocols enabled to use by SSL connections; must not be null or empty.

getEnabledProtocols

public String getEnabledProtocols()

Description copied from interface: SslEndpoint

Gets the list of protocols that are enabled for use by SSL connections.

Specified by:

getEnabledProtocols in interface SslEndpoint

Returns:

list of protocols enabled to use by SSL connections.