org.apache.axis

Interface EngineConfiguration

public interface EngineConfiguration

EngineConfiguration is an interface that the Message Flow subsystem provides so that engine configuration can be provided in a pluggable way. An instance of EngineConfiguration provides configuration for a particular engine instance.

Concrete implementations of this interface will obtain configuration information from some source (examples might be files, Strings, or databases) and are responsible for writing it into an AxisEngine, and writing an AxisEngine's state back out to whatever storage medium is in use.

Author: Glyn Normington (glyn@apache.org) Glen Daniels (gdaniels@apache.org)

Field Summary
static StringPROPERTY_NAME
Property name used for setting an EngineConfiguration to be used in creating engines.
Method Summary
voidconfigureEngine(AxisEngine engine)
Configure this AxisEngine using whatever data source we have.
IteratorgetDeployedServices()
Get an enumeration of the services deployed to this engine.
HashtablegetGlobalOptions()
Returns the global configuration options.
HandlergetGlobalRequest()
Returns a global request handler.
HandlergetGlobalResponse()
Returns a global response handler.
HandlergetHandler(QName qname)
Retrieve an instance of the named handler.
ListgetRoles()
Get a list of roles that this engine plays globally.
SOAPServicegetService(QName qname)
Retrieve an instance of the named service.
SOAPServicegetServiceByNamespaceURI(String namespace)
Get a service which has been mapped to a particular namespace.
HandlergetTransport(QName qname)
Retrieve an instance of the named transport.
TypeMappingRegistrygetTypeMappingRegistry()
Retrieve the TypeMappingRegistry for this engine.
voidwriteEngineConfig(AxisEngine engine)
Read the configuration from an engine, and store it somehow.

Field Detail

PROPERTY_NAME

public static final String PROPERTY_NAME
Property name used for setting an EngineConfiguration to be used in creating engines.

Method Detail

configureEngine

public void configureEngine(AxisEngine engine)
Configure this AxisEngine using whatever data source we have.

Parameters: engine the AxisEngine we'll deploy state to

Throws: ConfigurationException if there was a problem

getDeployedServices

public Iterator getDeployedServices()
Get an enumeration of the services deployed to this engine. Each service is represented as ServiceDesc object.

Returns: an Iterator over the ServiceDesc objects

Throws: ConfigurationException if the deployed services could not be returned

See Also: ServiceDesc

getGlobalOptions

public Hashtable getGlobalOptions()
Returns the global configuration options.

Returns: the global options as a Hashtable

Throws: ConfigurationException if the global options could not be returned

getGlobalRequest

public Handler getGlobalRequest()
Returns a global request handler.

Returns: the Handler that globally handles requests

Throws: ConfigurationException if there was some error fetching the handler

getGlobalResponse

public Handler getGlobalResponse()
Returns a global response handler.

Returns: the Handler that globally handles responses

Throws: ConfigurationException if there was some error fetching the handler

getHandler

public Handler getHandler(QName qname)
Retrieve an instance of the named handler.

Parameters: qname the QName identifying the Handler

Returns: the Handler associated with qname

Throws: ConfigurationException if there was a failure in resolving qname

getRoles

public List getRoles()
Get a list of roles that this engine plays globally. Services within the engine configuration may also add additional roles.

Returns: a List of the roles for this engine

getService

public SOAPService getService(QName qname)
Retrieve an instance of the named service.

Parameters: qname the QName identifying the Service

Returns: the Service associated with qname

Throws: ConfigurationException if there was an error resolving the qname

getServiceByNamespaceURI

public SOAPService getServiceByNamespaceURI(String namespace)
Get a service which has been mapped to a particular namespace.

Parameters: namespace a namespace URI

Returns: an instance of the appropriate Service, or null

Throws: ConfigurationException if there was an error resolving the namespace

getTransport

public Handler getTransport(QName qname)
Retrieve an instance of the named transport.

Parameters: qname the QName of the transport

Returns: a Handler implementing the transport

Throws: ConfigurationException if there was an error resolving the transport

getTypeMappingRegistry

public TypeMappingRegistry getTypeMappingRegistry()
Retrieve the TypeMappingRegistry for this engine.

Returns: the type mapping registry

Throws: ConfigurationException if there was an error resolving the registry

writeEngineConfig

public void writeEngineConfig(AxisEngine engine)
Read the configuration from an engine, and store it somehow.

Parameters: engine the AxisEngine from which to read state.

Throws: ConfigurationException if there was a problem

Copyright B) 2005 Apache Web Services Project. All Rights Reserved.