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

Interface SslEndpoint

All Superinterfaces:

Endpoint

All Known Implementing Classes:

HttpsEndpoint

public interface SslEndpoint
extends Endpoint

An SSL endpoint.

Nested Class Summary

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

Endpoint.EndpointType, Endpoint.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	setNeedClientAuth(boolean needed) Sets whether the server will require the client to authenticate with certificate.
void	setWantClientAuth(boolean wanted) Sets whether the server will desire the client to authenticate with certificate.

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

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

Method Detail

getKeyStoreType

String getKeyStoreType()

Returns keystore type

getKeyStorePath

String getKeyStorePath()

Returns the path to the keystore.

Returns:

The path to the keystore.

getKeyStorePassword

String getKeyStorePassword()

Returns the keystore password.

Returns:

The keystore password;

getKeyAlias

String getKeyAlias()

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".

Returns:

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

getKeyPassword

String getKeyPassword()

Returns the key password.

Returns:

The key password;

getTrustStorePath

String getTrustStorePath()

Returns the path to the trust store.

Returns:

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

getTrustStorePassword

String getTrustStorePassword()

Returns the trust store password.

Returns:

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

setNeedClientAuth

void setNeedClientAuth(boolean needed)

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

Parameters:

needed - true if authentication is needed

setWantClientAuth

void setWantClientAuth(boolean wanted)

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

Parameters:

wanted - true if authentication is desired

getNeedClientAuth

boolean getNeedClientAuth()

Gets whether server requires the client to authenticate with certificate.

Returns:

true if client must provide certificate

getWantClientAuth

boolean getWantClientAuth()

Gets whether server desires the client to authenticate with certificate.

Returns:

true if client may provide certificate

getEnabledProtocols

String getEnabledProtocols()

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

Returns:

list of protocols enabled to use by SSL connections.