com.vmware.vapi.config

Class PropertyConfigurator

java.lang.Object

com.vmware.vapi.config.PropertyConfigurator

All Implemented Interfaces:

Configurator

public final class PropertyConfigurator
extends Object
implements Configurator

Creates vAPI runtime objects from a Java property file configuration.

The format of the property file is as follows:

 #
 # Primary API provider - mandatory
 #
 provider.type=[full name of provider class]
 provider.name=[name of the provider]
 local.interfaces=[list of full names of service classes]

 #
 # Protocol handlers - mandatory
 #
 protocols=[list of protocol aliases]
 protocol.[protocol alias].rpc=[rpc protocol alias]
 protocol.[protocol alias].rpc.[rpc protocol alias].args=[arguments for non-ssl rpc endpoint]

 #
 # SSL configuration for protocol handler - optional
 #
 protocol.[protocol alias].ssl=[true/false]
 protocol.[protocol alias].ssl.keystore=[keystore for ssl]
 protocol.[protocol alias].ssl.password=[password for the ssl keystore]
 protocol.[protocol alias].ssl.keypassword=[password for the ssl key pair]
 protocol.[protocol alias].rpc.[rpc protocol alias].secureargs=[arguments for ssl rpc endpoint]

 #
 # SSL configuration for mutual authentication - optional
 #
 protocol.[protocol alias].ssl.client.auth=[true/want/false] 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
 protocol.[protocol alias].ssl.client.keystore=[client keystore for ssl]
 protocol.[protocol alias].ssl.client.password=[password for the ssl client keystore]
 protocol.[protocol alias].ssl.client.alias=[alias for the key to be used by the client]

 

Constructor Summary

Constructors

Constructor and Description
PropertyConfigurator(Properties props)
PropertyConfigurator(Properties props, ProtocolHandlerFactory handlerFactory)

Method Summary

Methods

Modifier and Type	Method and Description
ApiProvider	getApiProvider() Returns the primary API provider described in the configuration.
List<ProtocolHandler>	getProtocolHandlers() Returns a list of protocol handlers as described in the configuration.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertyConfigurator

public PropertyConfigurator(Properties props)

PropertyConfigurator

public PropertyConfigurator(Properties props,
                    ProtocolHandlerFactory handlerFactory)

Method Detail

getApiProvider

public ApiProvider getApiProvider()

Description copied from interface: Configurator

Returns the primary API provider described in the configuration.

Specified by:

getApiProvider in interface Configurator

Returns:

API provider

getProtocolHandlers

public List<ProtocolHandler> getProtocolHandlers()

Description copied from interface: Configurator

Returns a list of protocol handlers as described in the configuration.

Specified by:

getProtocolHandlers in interface Configurator

Returns:

list of protocol handlers