FileDocCategorySizeDatePackage
EngineConfiguration.javaAPI DocApache Axis 1.46309Sat Apr 22 18:57:26 BST 2006org.apache.axis

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)
author
Glen Daniels (gdaniels@apache.org)

Fields Summary
static final String
PROPERTY_NAME
Property name used for setting an EngineConfiguration to be used in creating engines.
Constructors Summary
Methods Summary
public voidconfigureEngine(AxisEngine engine)
Configure this AxisEngine using whatever data source we have.

param
engine the AxisEngine we'll deploy state to
throws
ConfigurationException if there was a problem

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

see
org.apache.axis.description.ServiceDesc
return
an Iterator over the ServiceDesc objects
throws
ConfigurationException if the deployed services could not be returned

public java.util.HashtablegetGlobalOptions()
Returns the global configuration options.

return
the global options as a Hashtable
throws
ConfigurationException if the global options could not be returned

public HandlergetGlobalRequest()
Returns a global request handler.

return
the Handler that globally handles requests
throws
ConfigurationException if there was some error fetching the handler

public HandlergetGlobalResponse()
Returns a global response handler.

return
the Handler that globally handles responses
throws
ConfigurationException if there was some error fetching the handler

public HandlergetHandler(javax.xml.namespace.QName qname)
Retrieve an instance of the named handler.

param
qname the QName identifying the Handler
return
the Handler associated with qname
throws
ConfigurationException if there was a failure in resolving qname

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

return
a List of the roles for this engine

public org.apache.axis.handlers.soap.SOAPServicegetService(javax.xml.namespace.QName qname)
Retrieve an instance of the named service.

param
qname the QName identifying the Service
return
the Service associated with qname
throws
ConfigurationException if there was an error resolving the qname

public org.apache.axis.handlers.soap.SOAPServicegetServiceByNamespaceURI(java.lang.String namespace)
Get a service which has been mapped to a particular namespace.

param
namespace a namespace URI
return
an instance of the appropriate Service, or null
throws
ConfigurationException if there was an error resolving the namespace

public HandlergetTransport(javax.xml.namespace.QName qname)
Retrieve an instance of the named transport.

param
qname the QName of the transport
return
a Handler implementing the transport
throws
ConfigurationException if there was an error resolving the transport

public org.apache.axis.encoding.TypeMappingRegistrygetTypeMappingRegistry()
Retrieve the TypeMappingRegistry for this engine.

return
the type mapping registry
throws
ConfigurationException if there was an error resolving the registry

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

param
engine the AxisEngine from which to read state.
throws
ConfigurationException if there was a problem