org.apache.axis.providers.java
Class JavaProvider

java.lang.Object
  |
  +--org.apache.axis.handlers.BasicHandler
        |
        +--org.apache.axis.providers.BasicProvider
              |
              +--org.apache.axis.providers.java.JavaProvider

All Implemented Interfaces:

Handler, java.io.Serializable

Direct Known Subclasses:

MsgProvider, RPCProvider

public abstract class JavaProvider

extends BasicProvider

Base class for Java dispatching. Fetches various fields out of envelope, looks up service object (possibly using session state), and delegates envelope body processing to subclass via abstract processMessage method.

Author:

Doug Davis (dug@us.ibm.com), Carl Woolf (cwoolf@macromedia.com)

See Also:

Serialized Form

Field Summary

protected static org.apache.commons.logging.Log	entLog
protected static org.apache.commons.logging.Log	log
static java.lang.String	OPTION_ALLOWEDMETHODS
static java.lang.String	OPTION_CLASSNAME
static java.lang.String	OPTION_CLASSPATH
static java.lang.String	OPTION_IS_STATIC
static java.lang.String	OPTION_SCOPE
static java.lang.String	OPTION_WSDL_INPUTSCHEMA
static java.lang.String	OPTION_WSDL_PORTTYPE
static java.lang.String	OPTION_WSDL_SERVICEELEMENT
static java.lang.String	OPTION_WSDL_SERVICEPORT
static java.lang.String	OPTION_WSDL_TARGETNAMESPACE

Fields inherited from class org.apache.axis.handlers.BasicHandler

makeLockable, name, options

Constructor Summary

JavaProvider()

Method Summary

void	generateWSDL(MessageContext msgContext) Generate the WSDL for this service.
protected java.lang.Class	getServiceClass(java.lang.String clsName, SOAPService service, MessageContext msgContext) Returns the Class info about the service class.
protected java.lang.String	getServiceClassName(Handler service) Return the class name of the service
protected java.lang.String	getServiceClassNameOptionName() Return the option in the configuration that contains the service class name
java.lang.Object	getServiceObject(MessageContext msgContext, Handler service, java.lang.String clsName, IntHolder scopeHolder) Get the service object whose method actually provides the service.
void	initServiceDesc(SOAPService service, MessageContext msgContext) Fill in a service description with the correct impl class and typemapping set.
void	invoke(MessageContext msgContext) Invoke the message by obtaining various common fields, looking up the service object (via getServiceObject), and actually processing the message (via processMessage).
protected java.lang.Object	makeNewServiceObject(MessageContext msgContext, java.lang.String clsName) Default java service object comes from simply instantiating the class wrapped in jc
abstract void	processMessage(MessageContext msgContext, SOAPEnvelope reqEnv, SOAPEnvelope resEnv, java.lang.Object obj) Process the current message.

Methods inherited from class org.apache.axis.providers.BasicProvider

addOperation, getOperationName, getOperationNames, getOperationQNames

Methods inherited from class org.apache.axis.handlers.BasicHandler

canHandleBlock, cleanup, getDeploymentData, getName, getOption, getOptions, getUnderstoodHeaders, init, initHashtable, onFault, setName, setOption, setOptionDefault, setOptions, setOptionsLockable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static org.apache.commons.logging.Log log

entLog

protected static org.apache.commons.logging.Log entLog

OPTION_CLASSNAME

public static final java.lang.String OPTION_CLASSNAME

See Also:

Constant Field Values

OPTION_ALLOWEDMETHODS

public static final java.lang.String OPTION_ALLOWEDMETHODS

See Also:

Constant Field Values

OPTION_IS_STATIC

public static final java.lang.String OPTION_IS_STATIC

See Also:

Constant Field Values

OPTION_CLASSPATH

public static final java.lang.String OPTION_CLASSPATH

See Also:

Constant Field Values

OPTION_WSDL_PORTTYPE

public static final java.lang.String OPTION_WSDL_PORTTYPE

See Also:

Constant Field Values

OPTION_WSDL_SERVICEELEMENT

public static final java.lang.String OPTION_WSDL_SERVICEELEMENT

See Also:

Constant Field Values

OPTION_WSDL_SERVICEPORT

public static final java.lang.String OPTION_WSDL_SERVICEPORT

See Also:

Constant Field Values

OPTION_WSDL_TARGETNAMESPACE

public static final java.lang.String OPTION_WSDL_TARGETNAMESPACE

See Also:

Constant Field Values

OPTION_WSDL_INPUTSCHEMA

public static final java.lang.String OPTION_WSDL_INPUTSCHEMA

See Also:

Constant Field Values

OPTION_SCOPE

public static final java.lang.String OPTION_SCOPE

See Also:

Constant Field Values

Constructor Detail

JavaProvider

public JavaProvider()

Method Detail

getServiceObject

public java.lang.Object getServiceObject(MessageContext msgContext,
                                         Handler service,
                                         java.lang.String clsName,
                                         IntHolder scopeHolder)
                                  throws java.lang.Exception

Get the service object whose method actually provides the service. May look up in session table.

java.lang.Exception

processMessage

public abstract void processMessage(MessageContext msgContext,
                                    SOAPEnvelope reqEnv,
                                    SOAPEnvelope resEnv,
                                    java.lang.Object obj)
                             throws java.lang.Exception

Process the current message. Side-effect resEnv to create return value.

Parameters:

msgContext - self-explanatory

reqEnv - the request envelope

resEnv - the response envelope

obj - the service object itself

java.lang.Exception

invoke

public void invoke(MessageContext msgContext)
            throws AxisFault

Invoke the message by obtaining various common fields, looking up the service object (via getServiceObject), and actually processing the message (via processMessage).

Specified by:

invoke in interface Handler

Specified by:

invoke in class BasicHandler

AxisFault

generateWSDL

public void generateWSDL(MessageContext msgContext)
                  throws AxisFault

Generate the WSDL for this service. Put in the "WSDL" property of the message context as a org.w3c.dom.Document

Specified by:

generateWSDL in interface Handler

Overrides:

generateWSDL in class BasicProvider

AxisFault

makeNewServiceObject

protected java.lang.Object makeNewServiceObject(MessageContext msgContext,
                                                java.lang.String clsName)
                                         throws java.lang.Exception

Default java service object comes from simply instantiating the class wrapped in jc

java.lang.Exception

getServiceClassName

protected java.lang.String getServiceClassName(Handler service)

Return the class name of the service

getServiceClassNameOptionName

protected java.lang.String getServiceClassNameOptionName()

Return the option in the configuration that contains the service class name

getServiceClass

protected java.lang.Class getServiceClass(java.lang.String clsName,
                                          SOAPService service,
                                          MessageContext msgContext)
                                   throws AxisFault

Returns the Class info about the service class.

AxisFault

initServiceDesc

public void initServiceDesc(SOAPService service,
                            MessageContext msgContext)
                     throws AxisFault

Fill in a service description with the correct impl class and typemapping set. This uses methods that can be overridden by other providers (like the EJBProvider) to get the class from the right place.

Specified by:

initServiceDesc in class BasicProvider

AxisFault