|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.axis.handlers.BasicHandler org.apache.axis.AxisEngine
An AxisEngine
is the base class for AxisClient and
AxisServer. Handles common functionality like dealing with the
handler/service registries and loading properties.
Field Summary | |
static java.lang.String |
DEFAULT_ATTACHMENT_IMPL
|
static java.lang.String |
ENV_ATTACHMENT_DIR
|
static java.lang.String |
ENV_SERVLET_CONTEXT
|
static java.lang.String |
ENV_SERVLET_REALPATH
|
static java.lang.String |
PROP_ATTACHMENT_CLEANUP
|
static java.lang.String |
PROP_ATTACHMENT_DIR
|
static java.lang.String |
PROP_ATTACHMENT_IMPLEMENTATION
|
static java.lang.String |
PROP_BP10_COMPLIANCE
Compliance with WS-I Basic Profile. |
static java.lang.String |
PROP_BYTE_BUFFER_BACKING
|
static java.lang.String |
PROP_BYTE_BUFFER_CACHE_INCREMENT
|
static java.lang.String |
PROP_BYTE_BUFFER_RESIDENT_MAX_SIZE
|
static java.lang.String |
PROP_BYTE_BUFFER_WORK_BUFFER_SIZE
|
static java.lang.String |
PROP_DEBUG_FILE
|
static java.lang.String |
PROP_DEBUG_LEVEL
|
static java.lang.String |
PROP_DEFAULT_CONFIG_CLASS
|
static java.lang.String |
PROP_DISABLE_PRETTY_XML
|
static java.lang.String |
PROP_DOMULTIREFS
|
static java.lang.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!) array. |
static java.lang.String |
PROP_EMIT_ALL_TYPES
|
static java.lang.String |
PROP_ENABLE_NAMESPACE_PREFIX_OPTIMIZATION
|
static java.lang.String |
PROP_PASSWORD
|
static java.lang.String |
PROP_SEND_XSI
|
static java.lang.String |
PROP_SOAP_ALLOWED_VERSION
|
static java.lang.String |
PROP_SOAP_VERSION
|
static java.lang.String |
PROP_SYNC_CONFIG
|
static java.lang.String |
PROP_TWOD_ARRAY_ENCODING
|
static java.lang.String |
PROP_XML_DECL
|
static java.lang.String |
PROP_XML_ENCODING
|
static java.lang.String |
PROP_XML_REUSE_SAX_PARSERS
|
Constructor Summary | |
AxisEngine(EngineConfiguration config)
Construct an AxisEngine using the specified engine configuration. |
Method Summary | |
void |
addActorURI(java.lang.String uri)
Add an actor by uri that will hold for the entire engine. |
void |
cleanup()
Cleanup routine removes application scoped objects. |
java.util.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. |
org.apache.axis.utils.cache.ClassCache |
getClassCache()
Get the ClassCache associated with this engine. |
java.lang.ClassLoader |
getClassLoader()
|
abstract AxisEngine |
getClientEngine()
Client engine access. |
SybCollectionStats |
getCollectionStats()
|
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(java.lang.String name)
Get the Handler for a particular local name. |
org.apache.axis.handlers.soap.SOAPService |
getService(java.lang.String name)
Get the SOAPService for a particular local name. |
javax.servlet.ServletContext |
getServletContext()
|
Handler |
getTransport(java.lang.String name)
Get the Handler that implements the transport for a local
name. |
org.apache.axis.encoding.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(java.lang.String uri)
Remove an actor by uri that will hold for the entire engine. |
void |
saveConfiguration()
Write out our engine configuration. |
void |
setAdminPassword(java.lang.String pw)
Set the administration password. |
void |
setClassLoader(java.lang.ClassLoader cl)
|
void |
setServletContext(javax.servlet.ServletContext servletContext)
|
void |
setShouldSaveConfig(boolean shouldSaveConfig)
Set the flag that controls if the configuration should be saved. |
Methods inherited from class org.apache.axis.handlers.BasicHandler |
canHandleBlock, generateWSDL, getDeploymentData, getName, getOption, getOptions, getUnderstoodHeaders, onFault, setName, setOption, setOptionDefault, setOptions |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.axis.Handler |
invoke |
Field Detail |
public static final java.lang.String PROP_XML_DECL
public static final java.lang.String PROP_DEBUG_LEVEL
public static final java.lang.String PROP_DEBUG_FILE
public static final java.lang.String PROP_DOMULTIREFS
public static final java.lang.String PROP_DISABLE_PRETTY_XML
public static final java.lang.String PROP_ENABLE_NAMESPACE_PREFIX_OPTIMIZATION
public static final java.lang.String PROP_PASSWORD
public static final java.lang.String PROP_SYNC_CONFIG
public static final java.lang.String PROP_SEND_XSI
public static final java.lang.String PROP_ATTACHMENT_DIR
public static final java.lang.String PROP_ATTACHMENT_IMPLEMENTATION
public static final java.lang.String PROP_ATTACHMENT_CLEANUP
public static final java.lang.String PROP_DEFAULT_CONFIG_CLASS
public static final java.lang.String PROP_SOAP_VERSION
public static final java.lang.String PROP_SOAP_ALLOWED_VERSION
public static final java.lang.String PROP_TWOD_ARRAY_ENCODING
public static final java.lang.String PROP_XML_ENCODING
public static final java.lang.String PROP_XML_REUSE_SAX_PARSERS
public static final java.lang.String PROP_BYTE_BUFFER_BACKING
public static final java.lang.String PROP_BYTE_BUFFER_CACHE_INCREMENT
public static final java.lang.String PROP_BYTE_BUFFER_RESIDENT_MAX_SIZE
public static final java.lang.String PROP_BYTE_BUFFER_WORK_BUFFER_SIZE
public static final java.lang.String PROP_EMIT_ALL_TYPES
public static final java.lang.String PROP_DOTNET_SOAPENC_FIX
public static final java.lang.String PROP_BP10_COMPLIANCE
public static final java.lang.String DEFAULT_ATTACHMENT_IMPL
public static final java.lang.String ENV_ATTACHMENT_DIR
public static final java.lang.String ENV_SERVLET_REALPATH
public static final java.lang.String ENV_SERVLET_CONTEXT
Constructor Detail |
public AxisEngine(EngineConfiguration config)
config
- the EngineConfiguration for this engineMethod Detail |
public static MessageContext getCurrentMessageContext()
public void init()
init
in interface Handler
init
in class BasicHandler
public void cleanup()
cleanup
in interface Handler
cleanup
in class BasicHandler
public void saveConfiguration()
public EngineConfiguration getConfig()
EngineConfiguration
used throughout this
AxisEngine
instance.
public boolean hasSafePassword()
AxisEngine
has a safe password.
public void setAdminPassword(java.lang.String pw)
pw
- the literal value of the password as a String
public void setShouldSaveConfig(boolean shouldSaveConfig)
shouldSaveConfig
- true if the configuration should be changed,
false otherwisepublic Handler getHandler(java.lang.String name) throws AxisFault
Handler
for a particular local name.
name
- the local name of the request type
Handler
for this request type
AxisFault
public org.apache.axis.handlers.soap.SOAPService getService(java.lang.String name) throws AxisFault
SOAPService
for a particular local name.
name
- the local name of the request type
SOAPService
for this request type
AxisFault
public Handler getTransport(java.lang.String name) throws AxisFault
Handler
that implements the transport for a local
name.
name
- the local name to fetch the transport for
Handler
for this local name
AxisFault
public org.apache.axis.encoding.TypeMappingRegistry getTypeMappingRegistry()
TypeMappingRegistry
for this axis engine.
TypeMappingRegistry
if possible, or null if
there is any error resolving itpublic Handler getGlobalRequest() throws ConfigurationException
Handler
.
Handler
used for global requests
ConfigurationException
public Handler getGlobalResponse() throws ConfigurationException
Handler
.
Handler
used for global responses
ConfigurationException
public java.util.ArrayList getActorURIs()
ArrayList
of all actor URIs as
Strings
public void addActorURI(java.lang.String uri)
uri
- a String
giving the uri of the actor to addpublic void removeActorURI(java.lang.String uri)
uri
- a String
giving the uri of the actor to removepublic abstract AxisEngine getClientEngine()
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.
AxisEngine
that is the client enginepublic static void normaliseOptions(Handler handler)
Convert boolean options from String to Boolean and default any ommitted boolean options to TRUE. Default the admin. password.
handler
- the Handler
to normalise; instances of
AxisEngine
get extra data normalisedpublic void refreshGlobalOptions() throws ConfigurationException
ConfigurationException
public Session getApplicationSession()
Session
object associated with the application
session.
Session
scoped to the applicationpublic org.apache.axis.utils.cache.ClassCache getClassCache()
ClassCache
associated with this engine.
public SybCollectionStats getCollectionStats()
public void setServletContext(javax.servlet.ServletContext servletContext)
public javax.servlet.ServletContext getServletContext()
public void setClassLoader(java.lang.ClassLoader cl)
public java.lang.ClassLoader getClassLoader()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |