org.apache.axis

Interface EngineConfiguration

All Superinterfaces:

java.io.Serializable

public interface EngineConfiguration
extends java.io.Serializable

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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_NAME Property name used for setting an EngineConfiguration to be used in creating engines.

Method Summary

Modifier and Type	Method and Description
void	configureEngine(AxisEngine engine) Configure this AxisEngine using whatever data source we have.
java.util.Iterator	getDeployedServices() Get an enumeration of the services deployed to this engine.
java.util.Hashtable	getGlobalOptions() Returns the global configuration options.
org.apache.axis.Handler	getGlobalRequest() Returns a global request handler.
org.apache.axis.Handler	getGlobalResponse() Returns a global response handler.
org.apache.axis.Handler	getHandler(javax.xml.namespace.QName qname) Retrieve an instance of the named handler.
java.util.List	getRoles() Get a list of roles that this engine plays globally.
org.apache.axis.handlers.soap.SOAPService	getService(javax.xml.namespace.QName qname) Retrieve an instance of the named service.
org.apache.axis.handlers.soap.SOAPService	getServiceByNamespaceURI(java.lang.String namespace) Get a service which has been mapped to a particular namespace.
org.apache.axis.Handler	getTransport(javax.xml.namespace.QName qname) Retrieve an instance of the named transport.
org.apache.axis.encoding.TypeMappingRegistry	getTypeMappingRegistry() Retrieve the TypeMappingRegistry for this engine.
void	writeEngineConfig(AxisEngine engine) Read the configuration from an engine, and store it somehow.

Field Detail

PROPERTY_NAME

static final java.lang.String PROPERTY_NAME

Property name used for setting an EngineConfiguration to be used in creating engines.

See Also:

Constant Field Values

Method Detail

configureEngine

void configureEngine(AxisEngine engine)
              throws org.apache.axis.ConfigurationException

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

writeEngineConfig

void writeEngineConfig(AxisEngine engine)
                throws org.apache.axis.ConfigurationException

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

getHandler

org.apache.axis.Handler getHandler(javax.xml.namespace.QName qname)
                            throws org.apache.axis.ConfigurationException

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

getService

org.apache.axis.handlers.soap.SOAPService getService(javax.xml.namespace.QName qname)
                                              throws org.apache.axis.ConfigurationException

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

org.apache.axis.handlers.soap.SOAPService getServiceByNamespaceURI(java.lang.String namespace)
                                                            throws org.apache.axis.ConfigurationException

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

org.apache.axis.Handler getTransport(javax.xml.namespace.QName qname)
                              throws org.apache.axis.ConfigurationException

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

org.apache.axis.encoding.TypeMappingRegistry getTypeMappingRegistry()
                                                             throws org.apache.axis.ConfigurationException

Retrieve the TypeMappingRegistry for this engine.

Returns:

the type mapping registry

Throws:

ConfigurationException - if there was an error resolving the registry

getGlobalRequest

org.apache.axis.Handler getGlobalRequest()
                                  throws org.apache.axis.ConfigurationException

Returns a global request handler.

Returns:

the Handler that globally handles requests

Throws:

ConfigurationException - if there was some error fetching the handler

getGlobalResponse

org.apache.axis.Handler getGlobalResponse()
                                   throws org.apache.axis.ConfigurationException

Returns a global response handler.

Returns:

the Handler that globally handles responses

Throws:

ConfigurationException - if there was some error fetching the handler

getGlobalOptions

java.util.Hashtable getGlobalOptions()
                              throws org.apache.axis.ConfigurationException

Returns the global configuration options.

Returns:

the global options as a Hashtable

Throws:

ConfigurationException - if the global options could not be returned

getDeployedServices

java.util.Iterator getDeployedServices()
                                throws org.apache.axis.ConfigurationException

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

getRoles

java.util.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