com.vmware.vapi.config

Class SpringConfigurator

java.lang.Object

com.vmware.vapi.config.SpringConfigurator

All Implemented Interfaces:

Configurator

public class SpringConfigurator
extends Object
implements Configurator

Creates vAPI runtime objects from a Spring config/application context.

Constructor Summary

Constructors

Constructor and Description
SpringConfigurator(List<String> configFiles) Constructor.
SpringConfigurator(String uri, String providerSpringConfig) Constructor.
SpringConfigurator(String uri, String secureUri, String keystore, String password, String keypassword, String providerSpringConfig) Constructor.

Method Summary

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

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

Constructor Detail

SpringConfigurator

public SpringConfigurator(List<String> configFiles)

Constructor.

Creates an instance that load Spring application context and configures the infrastructure based on the specified configuration files.

It is expected that in the provided configuration

• exactly 1 bean exists with id="apiProvider" and that bean is of type LocalProvider or ApiAggregator
• 1 or more beans of types descendant of ProtocolHandler exists

The above beans are the result from Configurator interface methods implemented by this class.

Parameters:

configFiles - Spring XML configuration files, must be available on the classpath

Throws:

IllegalArgumentException - if configFiles is null or empty

SpringConfigurator

public SpringConfigurator(String uri,
                          String providerSpringConfig)

Constructor.

Creates an instance that uses the specified uri and optionally providerSpringConfig to configure the infrastructure.

Instances created with this constructor uses default configuration for JSON/HTTP ProtocolHandler. HTTP server uses HTTP listener only (no HTTPS). The configuration is available from:

• vapi-tcserver-spring.xml
• vapi-http-spring.xml

Custom Spring XML configuration may be provided with the providerSpringConfig. If provided it will be loaded and a bean with id id="apiProvider" will be used by this configurator.

Parameters:

uri - HTTP URL for server to listen on

providerSpringConfig - Spring XML configuration files supposed to contain definition for ApiProvider to be used' must be available on the classpath; must not be null

See Also:

SpringConfigurator(List)

SpringConfigurator

public SpringConfigurator(String uri,
                          String secureUri,
                          String keystore,
                          String password,
                          String keypassword,
                          String providerSpringConfig)

Constructor.

Creates an instance that uses the specified uri and optionally providerSpringConfig to configure the infrastructure.

Instances created with this constructor uses default configuration for JSON/HTTP ProtocolHandler. HTTP server uses HTTPS listener optionally HTTP one. The configuration is available from:

• vapi-tcserver-spring.xml
• vapi-http-spring.xml
• vapi-https-spring.xml

Parameters:

uri - HTTP URL for server to listen on

secureUri - HTTPS URL for server to listen on

keystore - SSL keystore

password - password for the SSL keystore

keypassword - password for the SSL key

providerSpringConfig - Spring XML configuration files supposed to contain definition for ApiProvider to be used' must be available on the classpath; must not be null

See Also:

SpringConfigurator(String, String), SpringConfigurator(List)

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