Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.axis.transport.http
Class AxisServlet

java.lang.Object
  extended byHttpServlet
      extended byorg.jboss.axis.transport.http.AxisServletBase (src) 
          extended byorg.jboss.axis.transport.http.AxisServlet
Direct Known Subclasses:
AbstractServlet (src) , AxisServiceServlet (src) , JBossJuddiAdminServlet (src) , JBossJuddiInquiryServlet (src) , JBossJuddiPublishServlet (src)
public class AxisServlet
extends AxisServletBase (src)

See Also:
Serialized Form

Field Summary
static java.lang.String INIT_PROPERTY_ENABLE_LIST
           
static java.lang.String INIT_PROPERTY_JWS_CLASS_DIR
           
static java.lang.String INIT_PROPERTY_TRANSPORT_NAME
           
static java.lang.String INIT_PROPERTY_USE_SECURITY
           
 
Fields inherited from class org.jboss.axis.transport.http.AxisServletBase (src)
ATTR_AXIS_ENGINE, axisServer
 
Constructor Summary
AxisServlet()
          create a new servlet instance
 
Method Summary
protected  MessageContext (src) createMessageContext(AxisEngine (src)  engine, HttpServletRequest req, HttpServletResponse res)
          Place the Request message in the MessagContext object - notice that we just leave it as a 'ServletRequest' object and let the Message processing routine convert it - we don't do it since we don't know how it's going to be used - perhaps it might not even need to be parsed.
 void doGet(HttpServletRequest request, HttpServletResponse response)
          Process GET requests.
 void doPost(HttpServletRequest req, HttpServletResponse res)
          Process a POST to the servlet by handing it off to the Axis Engine.
protected  java.lang.String getDefaultJWSClassDir()
          Provided to allow overload of default JWSClassDir by derived class.
protected  int getHttpServletResponseStatus(AxisFault (src)  af)
          Extract information from AxisFault and map it to a HTTP Status code.
protected  java.lang.String getJWSClassDir()
           
protected  java.lang.String getProtocolVersion(HttpServletRequest req)
          Return the HTTP protocol level 1.1 or 1.0 by derived class.
protected  java.lang.String getServiceName(HttpServletRequest request)
          Assumes that the service name is the first token in the path info
 void init()
          Initialization method.
protected  void invokeEndpointFromGet(MessageContext (src)  msgContext, HttpServletResponse response, java.io.PrintWriter writer, java.lang.String method, java.lang.String args)
          invoke an endpoint from a get request by building an XML request and handing it down.
protected  void logException(java.lang.Exception e)
          log any exception to our output log, at our chosen level
protected  void processAxisFault(AxisFault (src)  fault)
          routine called whenever an axis fault is caught; where they are logged and any other business.
protected  void processMethodRequest(MessageContext (src)  msgContext, HttpServletRequest request, HttpServletResponse response, java.io.PrintWriter writer)
          scan through the request for parameters, invoking the endpoint if we get a method param.
protected  void processWsdlRequest(MessageContext (src)  msgContext, HttpServletResponse response, java.io.PrintWriter writer)
          handle a ?wsdl request
protected  void reportAvailableServices(HttpServletResponse response, java.io.PrintWriter writer, HttpServletRequest request)
          This method lists the available services; it is called when there is nothing to execute on a GET
protected  void reportCantGetAxisService(HttpServletRequest request, HttpServletResponse response, java.io.PrintWriter writer)
          generate the error response to indicate that there is apparently no endpoint there
protected  void reportCantGetJWSService(HttpServletRequest request, HttpServletResponse response, java.io.PrintWriter writer)
          probe for a JWS page and report 'no service' if one is not found there
protected  void reportNoWSDL(HttpServletResponse res, java.io.PrintWriter writer, java.lang.String moreDetailCode, AxisFault (src)  axisFault)
          report that we have no WSDL
protected  void reportServiceInfo(HttpServletResponse response, java.io.PrintWriter writer, SOAPService (src)  service, java.lang.String serviceName)
          print a snippet of service info.
protected  void reportTrouble(java.lang.Exception exception, HttpServletResponse response, java.io.PrintWriter writer)
          when we get an exception or an axis fault in a GET, we handle it almost identically: we go 'something went wrong', set the response code to 500 and then dump info.
protected  void setupHTMLResponseHeader(HttpServletResponse response, java.io.PrintWriter writer)
           
 
Methods inherited from class org.jboss.axis.transport.http.AxisServletBase (src)
decLockCounter, destroy, getEngine, getEngine, getEngineEnvironment, getHomeDir, getLoadCounter, getOption, getServletContext, getWebappBase, getWebInfPath, incLockCounter, isDevelopment, service
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INIT_PROPERTY_TRANSPORT_NAME

public static final java.lang.String INIT_PROPERTY_TRANSPORT_NAME
See Also:
Constant Field Values (src)

INIT_PROPERTY_USE_SECURITY

public static final java.lang.String INIT_PROPERTY_USE_SECURITY
See Also:
Constant Field Values (src)

INIT_PROPERTY_ENABLE_LIST

public static final java.lang.String INIT_PROPERTY_ENABLE_LIST
See Also:
Constant Field Values (src)

INIT_PROPERTY_JWS_CLASS_DIR

public static final java.lang.String INIT_PROPERTY_JWS_CLASS_DIR
See Also:
Constant Field Values (src)
Constructor Detail

AxisServlet

public AxisServlet()
create a new servlet instance

Method Detail

getJWSClassDir

protected java.lang.String getJWSClassDir()

init

public void init()
Initialization method.

Overrides:
init in class AxisServletBase (src)

doGet

public void doGet(HttpServletRequest request,
                  HttpServletResponse response)
           throws ServletException,
                  java.io.IOException
Process GET requests. This includes handoff of pseudo-SOAP requests

Parameters:
request - request in
response - request out
Throws:
ServletException
java.io.IOException

reportTrouble

protected void reportTrouble(java.lang.Exception exception,
                             HttpServletResponse response,
                             java.io.PrintWriter writer)
when we get an exception or an axis fault in a GET, we handle it almost identically: we go 'something went wrong', set the response code to 500 and then dump info. But we dump different info for an axis fault or subclass thereof.

Parameters:
exception - what went wrong
response - current response
writer - open writer to response

setupHTMLResponseHeader

protected void setupHTMLResponseHeader(HttpServletResponse response,
                                       java.io.PrintWriter writer)

processAxisFault

protected void processAxisFault(AxisFault (src)  fault)
routine called whenever an axis fault is caught; where they are logged and any other business. The method may modify the fault in the process

Parameters:
fault - what went wrong.

logException

protected void logException(java.lang.Exception e)
log any exception to our output log, at our chosen level

Parameters:
e - what went wrong

processMethodRequest

protected void processMethodRequest(MessageContext (src)  msgContext,
                                    HttpServletRequest request,
                                    HttpServletResponse response,
                                    java.io.PrintWriter writer)
                             throws AxisFault (src)
scan through the request for parameters, invoking the endpoint if we get a method param. If there was no method param then the response is set to a 400 Bad Request and some error text

Parameters:
msgContext - current message
request - incoming requests
response - response to generate
writer - output stream
Throws:
AxisFault (src) - if anything goes wrong during method execution

processWsdlRequest

protected void processWsdlRequest(MessageContext (src)  msgContext,
                                  HttpServletResponse response,
                                  java.io.PrintWriter writer)
                           throws AxisFault (src)
handle a ?wsdl request

Parameters:
msgContext - message context so far
response - response to write to
writer - output stream
Throws:
AxisFault (src) - when anything other than a Server.NoService fault is reported during WSDL generation

invokeEndpointFromGet

protected void invokeEndpointFromGet(MessageContext (src)  msgContext,
                                     HttpServletResponse response,
                                     java.io.PrintWriter writer,
                                     java.lang.String method,
                                     java.lang.String args)
                              throws AxisFault (src)
invoke an endpoint from a get request by building an XML request and handing it down. If anything goes wrong, we generate an XML formatted axis fault

Parameters:
msgContext - current message
response - to return data
writer - output stream
method - method to invoke (may be null)
args - argument list in XML form
Throws:
AxisFault (src) - iff something goes wrong when turning the response message into a SOAP string.

reportServiceInfo

protected void reportServiceInfo(HttpServletResponse response,
                                 java.io.PrintWriter writer,
                                 SOAPService (src)  service,
                                 java.lang.String serviceName)
print a snippet of service info.

Parameters:
service - service
writer - output channel
serviceName - where to put stuff

reportNoWSDL

protected void reportNoWSDL(HttpServletResponse res,
                            java.io.PrintWriter writer,
                            java.lang.String moreDetailCode,
                            AxisFault (src)  axisFault)
report that we have no WSDL

Parameters:
res -
writer -
moreDetailCode - optional name of a message to provide more detail
axisFault - optional fault string, for extra info at debug time only

reportAvailableServices

protected void reportAvailableServices(HttpServletResponse response,
                                       java.io.PrintWriter writer,
                                       HttpServletRequest request)
                                throws ConfigurationException (src) ,
                                       AxisFault (src)
This method lists the available services; it is called when there is nothing to execute on a GET

Parameters:
response -
writer -
request -
Throws:
ConfigurationException (src)
AxisFault (src)

reportCantGetAxisService

protected void reportCantGetAxisService(HttpServletRequest request,
                                        HttpServletResponse response,
                                        java.io.PrintWriter writer)
generate the error response to indicate that there is apparently no endpoint there

Parameters:
request - the request that didnt have an edpoint
response - response we are generating
writer - open writer for the request

reportCantGetJWSService

protected void reportCantGetJWSService(HttpServletRequest request,
                                       HttpServletResponse response,
                                       java.io.PrintWriter writer)
probe for a JWS page and report 'no service' if one is not found there

Parameters:
request - the request that didnt have an edpoint
response - response we are generating
writer - open writer for the request

doPost

public void doPost(HttpServletRequest req,
                   HttpServletResponse res)
            throws ServletException,
                   java.io.IOException
Process a POST to the servlet by handing it off to the Axis Engine. Here is where SOAP messages are received

1. get the Axis server engine 2. create the MessageContext and populate it with the req/res objects 3. set security provider 4. create request SOAPMessage 5. set the SOAPAction in the message context 6. invoke the engine 7. get response SOAPMessage 8. get the response content type 9. send the response

Parameters:
req - posted request
res - respose
Throws:
ServletException - trouble
java.io.IOException - different trouble

getServiceName

protected java.lang.String getServiceName(HttpServletRequest request)
Assumes that the service name is the first token in the path info

getHttpServletResponseStatus

protected int getHttpServletResponseStatus(AxisFault (src)  af)
Extract information from AxisFault and map it to a HTTP Status code.

Parameters:
af - Axis Fault
Returns:
HTTP Status code.

createMessageContext

protected MessageContext (src)  createMessageContext(AxisEngine (src)  engine,
                                              HttpServletRequest req,
                                              HttpServletResponse res)
Place the Request message in the MessagContext object - notice that we just leave it as a 'ServletRequest' object and let the Message processing routine convert it - we don't do it since we don't know how it's going to be used - perhaps it might not even need to be parsed.

Returns:
a message context

getDefaultJWSClassDir

protected java.lang.String getDefaultJWSClassDir()
Provided to allow overload of default JWSClassDir by derived class.

Returns:
directory for JWS files

getProtocolVersion

protected java.lang.String getProtocolVersion(HttpServletRequest req)
Return the HTTP protocol level 1.1 or 1.0 by derived class.

Returns:
one of the HTTPConstants values
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD