org.apache.axis
public abstract class AxisEngine extends BasicHandler
AxisEngine
is the base class for AxisClient and
AxisServer. Handles common functionality like dealing with the
handler/service registries and loading properties.
Field Summary | |
---|---|
protected ClassCache | classCache Java class cache. |
protected EngineConfiguration | config Our go-to guy for configuration... |
static String | DEFAULT_ATTACHMENT_IMPL |
static String | ENV_ATTACHMENT_DIR |
static String | ENV_SERVLET_CONTEXT |
static String | ENV_SERVLET_REALPATH |
protected static Log | log
The Log for all message logging. |
static String | PROP_ATTACHMENT_CLEANUP |
static String | PROP_ATTACHMENT_DIR |
static String | PROP_ATTACHMENT_IMPLEMENTATION |
static String | PROP_BP10_COMPLIANCE Compliance with WS-I Basic Profile. |
static String | PROP_BYTE_BUFFER_BACKING |
static String | PROP_BYTE_BUFFER_CACHE_INCREMENT |
static String | PROP_BYTE_BUFFER_RESIDENT_MAX_SIZE |
static String | PROP_BYTE_BUFFER_WORK_BUFFER_SIZE |
static String | PROP_DEBUG_FILE |
static String | PROP_DEBUG_LEVEL |
static String | PROP_DEFAULT_CONFIG_CLASS |
static String | PROP_DISABLE_PRETTY_XML |
static String | PROP_DOMULTIREFS |
static String | PROP_DOTNET_SOAPENC_FIX
Set this property to 'true' when you want Axis to avoid soap encoded
types to work around a .NET problem where it wont accept soap encoded
types for a (soap encoded!) |
static String | PROP_EMIT_ALL_TYPES |
static String | PROP_ENABLE_NAMESPACE_PREFIX_OPTIMIZATION |
static String | PROP_PASSWORD |
static String | PROP_SEND_XSI |
static String | PROP_SOAP_ALLOWED_VERSION |
static String | PROP_SOAP_VERSION |
static String | PROP_SYNC_CONFIG |
static String | PROP_TWOD_ARRAY_ENCODING |
static String | PROP_XML_DECL |
static String | PROP_XML_ENCODING |
static String | PROP_XML_REUSE_SAX_PARSERS |
protected boolean | shouldSaveConfig
Should we save the engine config each time we modify it? |
protected boolean | _hasSafePassword Has the user changed the password yet? |
Constructor Summary | |
---|---|
AxisEngine(EngineConfiguration config)
Construct an AxisEngine using the specified engine configuration.
|
Method Summary | |
---|---|
void | addActorURI(String uri)
Add an actor by uri that will hold for the entire engine.
|
void | cleanup()
Cleanup routine removes application scoped objects.
|
ArrayList | getActorURIs()
Get a list of actor URIs that hold for the entire engine.
|
Session | getApplicationSession()
Get the Session object associated with the application
session.
|
ClassCache | getClassCache()
Get the ClassCache associated with this engine.
|
abstract AxisEngine | getClientEngine()
Client engine access.
|
EngineConfiguration | getConfig()
Get the EngineConfiguration used throughout this
AxisEngine instance.
|
static MessageContext | getCurrentMessageContext()
Get the active message context.
|
Handler | getGlobalRequest()
Get the global request Handler .
|
Handler | getGlobalResponse()
Get the global respones Handler .
|
Handler | getHandler(String name)
Get the Handler for a particular local name.
|
SOAPService | getService(String name)
Get the SOAPService for a particular local name.
|
Handler | getTransport(String name)
Get the Handler that implements the transport for a local
name.
|
TypeMappingRegistry | getTypeMappingRegistry()
Get the TypeMappingRegistry for this axis engine.
|
boolean | hasSafePassword()
Discover if this AxisEngine has a safe password.
|
void | init()
Initialize the engine. |
static void | normaliseOptions(Handler handler)
Normalise the engine's options.
|
void | refreshGlobalOptions()
(Re-)load the global options from the registry.
|
void | removeActorURI(String uri)
Remove an actor by uri that will hold for the entire engine.
|
void | saveConfiguration() Write out our engine configuration. |
void | setAdminPassword(String pw)
Set the administration password.
|
protected static void | setCurrentMessageContext(MessageContext mc)
Set the active message context.
|
void | setShouldSaveConfig(boolean shouldSaveConfig)
Set the flag that controls if the configuration should be saved.
|
Log
for all message logging.Parameters: config the EngineConfiguration for this engine
Parameters: uri a String
giving the uri of the actor to add
Returns: an ArrayList
of all actor URIs as
Strings
Session
object associated with the application
session.
Returns: a Session
scoped to the application
ClassCache
associated with this engine.
Returns: the class cache
An AxisEngine may define another specific AxisEngine to be used by newly created Clients. For instance, a server may create an AxisClient and allow deployment to it. Then the server's services may access the AxisClient's deployed handlers and transports.
Returns: an AxisEngine
that is the client engine
EngineConfiguration
used throughout this
AxisEngine
instance.
Returns: the engine configuration instance
Returns: the current active message context
Handler
.
Returns: the Handler
used for global requests
Throws: ConfigurationException
Handler
.
Returns: the Handler
used for global responses
Throws: ConfigurationException
Handler
for a particular local name.
Parameters: name the local name of the request type
Returns: the Handler
for this request type
Throws: AxisFault
SOAPService
for a particular local name.
Parameters: name the local name of the request type
Returns: the SOAPService
for this request type
Throws: AxisFault
Handler
that implements the transport for a local
name.
Parameters: name the local name to fetch the transport for
Returns: a Handler
for this local name
Throws: AxisFault
TypeMappingRegistry
for this axis engine.
Returns: the TypeMappingRegistry
if possible, or null if
there is any error resolving it
AxisEngine
has a safe password.
Returns: true if it is safe, false otherwise
Convert boolean options from String to Boolean and default any ommitted boolean options to TRUE. Default the admin. password.
Parameters: handler the Handler
to normalise; instances of
AxisEngine
get extra data normalised
Throws: ConfigurationException
Parameters: uri a String
giving the uri of the actor to remove
Parameters: pw the literal value of the password as a String
Parameters: mc - the new active message context.
Parameters: shouldSaveConfig true if the configuration should be changed, false otherwise