com.vmware.vapi.protocol

Interface ProtocolHandlerFactory

public interface ProtocolHandlerFactory

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ProtocolHandlerFactory.KeyStoreConfig This class contains the keystore configuration.
static class	ProtocolHandlerFactory.TrustStoreConfig This class contains the truststore configuration.

Method Summary

Methods

Modifier and Type	Method and Description
ProtocolHandler	getInsecureProtocolHandler(String type, String args, ApiProvider provider) Create a insecure protocol handler.
ProtocolHandler	getProtocolHandler(String type, String args, String secureArgs, String clientAuth, ProtocolHandlerFactory.KeyStoreConfig keystoreConfig, ProtocolHandlerFactory.TrustStoreConfig truststoreConfig, ApiProvider provider) Create protocol handler with configurable client authentication.
ProtocolHandler	getProtocolHandler(String type, String args, String secureArgs, String keystore, String keystorePassword, String keyPassword, ApiProvider provider) Create protocol handler.

Method Detail

getProtocolHandler

ProtocolHandler getProtocolHandler(String type,
                                 String args,
                                 String secureArgs,
                                 String keystore,
                                 String keystorePassword,
                                 String keyPassword,
                                 ApiProvider provider)

Create protocol handler.

Protocol handler has a Http Endpoint if args is not null

Protocol handler has a Https Endpoint if secureArgs is not null. A valid keystore configuration must be provided in this case

Parameters:

type - protocol type; must not be null

args - http uri; might be null

secureArgs - https uri; might be null

keystore - the keystore, which contains the server certificates and keys; must be not null if secureArgs is provided

keystorePassword - the keystore password; might be null

keyPassword - the key password, if different from the keystore password; might be null

provider - the API provider; must not be null

Returns:

the protocol handler

getProtocolHandler

ProtocolHandler getProtocolHandler(String type,
                                 String args,
                                 String secureArgs,
                                 String clientAuth,
                                 ProtocolHandlerFactory.KeyStoreConfig keystoreConfig,
                                 ProtocolHandlerFactory.TrustStoreConfig truststoreConfig,
                                 ApiProvider provider)

Create protocol handler with configurable client authentication.

Protocol handler has a Http Endpoint if args is not null

Protocol handler has a Https Endpoint if secureArgs is not null. A valid keystore configuration must be provided in this case. A valid truststore configuration must be provided client authentication

Parameters:

type - protocol type; must not be null

args - http uri; might be null

secureArgs - https uri; might be null

clientAuth - the client authentication to be used: true to require a valid certificate from the client to accept a connection and fail if the certificate is not supplied, want to request the client to supply a valid certificate, but do not fail if is not provided, false to not require a client certificate; might be null

keystoreConfig - the keystore configuration; must be not null if secureArgs is provided

truststoreConfig - the trustore configuration; must be not null if client authentication is true

provider - the API provider; must not be null

Returns:

the protocol handler

getInsecureProtocolHandler

ProtocolHandler getInsecureProtocolHandler(String type,
                                         String args,
                                         ApiProvider provider)

Create a insecure protocol handler.

Parameters:

type - protocol type; must not be null

args - http uri; might be null

provider - the API provider; must not be null

Returns:

the protocol handler