Novell exteNd Web Services SDK API

com.sssw.jbroker.web.portable
Class ServletSkeleton

java.lang.Object
  extended byjavax.servlet.GenericServlet
      extended byjavax.servlet.http.HttpServlet
          extended bycom.sssw.jbroker.web.portable.ServletSkeleton
All Implemented Interfaces:
InvokeHandler, Referenceable, Serializable, ServiceObject, Servlet, ServletConfig, Skeleton

public abstract class ServletSkeleton
extends HttpServlet
implements Skeleton

Servlet skeleton is the base class of all Service Servlets.

See Also:
Serialized Form

Nested Class Summary
static interface ServletSkeleton.ServletDelegate
          The base class delegates the HTTP methods to this Interface.
 
Field Summary
 
Fields inherited from interface com.sssw.jbroker.web.portable.Skeleton
TEST_DISABLE
 
Method Summary
 Binding[] _getBindings()
          Get the bindings set on this skeleton
 ClassInfo _getClassInfo()
          Get dispatch information for this service object
 Binding _getCurrentBinding()
          Get the binding currently used by this skeleton
 List _getHandlerChain()
          Get the handler chain set on this servlet skeleton
 QName _getOperationName()
          Get the operations's QName
 QName _getPortType()
          Get the port's QName
 Object _getProperty(String propName)
          Get a property
 Stub _getStub()
          Get servlet as stub
 TypeMapper _getTypeMapper()
          Deprecated. As of jBroker Web 2.0, use _getTypeMappingRegistry instead
 TypeMappingRegistry _getTypeMappingRegistry()
          Get the type mapping registry set on this serlvet skeleton
 ServerResponse _invoke(Properties httpHeaders, InputStream is)
          Implementation of InvokeHandler.invoke(Properties httpHeaders, InputStream is)
 void _setClassInfo(ClassInfo info)
          Set dispatch information for this service object
 void _setCurrentBinding(Binding binding)
          Set the binding on this skeleton
 void _setHandlerChain(HandlerChain chain)
          Set the HandlerChain for the Stub
 void _setHandlerChain(List handlerChain)
          Set the handler chain on this servlet skeleton.
 Object _setProperty(String propName, Object propValue)
          Set a property
 String _setProperty(String propName, String propValue)
          Set a property
 void _setTypeMapper(TypeMapper typeMapper)
          Deprecated. As of jBroker Web 2.0, use _setTypeMappingRegistry instead
 void _setTypeMappingRegistry(TypeMappingRegistry typeMapper)
          Set the type mapping registry on this serlvet skeleton
 void doGet(HttpServletRequest req, HttpServletResponse res)
          The HTTP servlet doGet method is delegated to the delegate.
 void doPost(HttpServletRequest req, HttpServletResponse res)
          The HTTP servlet doPost method is delegated to the delegate.
 Reference getReference()
           
 void init()
          The HTTP servlet init method is delegated to the delegate.
 void init(ServletConfig config)
          The HTTP servlet init method.
 boolean isDocument(String action)
          Determine if a method with specified SOAP action is document style
 
Methods inherited from class javax.servlet.http.HttpServlet
service
 
Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, log, log
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.sssw.jbroker.web.portable.InvokeHandler
_invoke
 

Method Detail

_getTypeMapper

public TypeMapper _getTypeMapper()
Deprecated. As of jBroker Web 2.0, use _getTypeMappingRegistry instead

Get the type mapper set on this serlvet skeleton

Specified by:
_getTypeMapper in interface ServiceObject
Returns:
a TypeMapper object
See Also:
_getTypeMappingRegistry()

_setTypeMapper

public void _setTypeMapper(TypeMapper typeMapper)
Deprecated. As of jBroker Web 2.0, use _setTypeMappingRegistry instead

Set the type mapper on this serlvet skeleton

Specified by:
_setTypeMapper in interface ServiceObject
Parameters:
typeMapper - a TypeMapper object with type mappings to be used by this servlet skeleton
See Also:
_setTypeMappingRegistry(TypeMappingRegistry)

_getTypeMappingRegistry

public TypeMappingRegistry _getTypeMappingRegistry()
Get the type mapping registry set on this serlvet skeleton

Specified by:
_getTypeMappingRegistry in interface ServiceObject
Returns:
a TypeMappingRegistry object
Since:
jBroker Web 2.0

_setTypeMappingRegistry

public void _setTypeMappingRegistry(TypeMappingRegistry typeMapper)
Set the type mapping registry on this serlvet skeleton

Specified by:
_setTypeMappingRegistry in interface ServiceObject
Parameters:
typeMapper - a TypeMappingRegistry object with type mappings to be used by this servlet skeleton
Since:
jBroker Web 2.0

_getStub

public Stub _getStub()
Get servlet as stub

Returns:
a Stub object for self

getReference

public Reference getReference()
                       throws NamingException
Specified by:
getReference in interface Referenceable
Throws:
NamingException

_getPortType

public QName _getPortType()
Get the port's QName

Specified by:
_getPortType in interface ServiceObject
Returns:
a QName for the port that defined this skeleton

_getBindings

public Binding[] _getBindings()
Get the bindings set on this skeleton

Specified by:
_getBindings in interface ServiceObject
Returns:
an array of Binding objects

_getCurrentBinding

public Binding _getCurrentBinding()
                           throws ServiceException
Get the binding currently used by this skeleton

Specified by:
_getCurrentBinding in interface ServiceObject
Returns:
the current Binding object
Throws:
ServiceException - if serlvet is not activated yet

_setCurrentBinding

public void _setCurrentBinding(Binding binding)
                        throws MalformedURLException
Set the binding on this skeleton

Specified by:
_setCurrentBinding in interface ServiceObject
Parameters:
binding - a Binding object
Throws:
MalformedURLException - always raises this exception since the binding can not be changed on a skeleton

_getProperty

public Object _getProperty(String propName)
Get a property

Specified by:
_getProperty in interface ServiceObject
Parameters:
propName - the property name
Returns:
the property value

_setProperty

public String _setProperty(String propName,
                           String propValue)
Set a property

Specified by:
_setProperty in interface ServiceObject
Parameters:
propName - the property name
propValue - the property value
Returns:
previous property value (if any)

_setProperty

public Object _setProperty(String propName,
                           Object propValue)
Set a property

Parameters:
propName - the property name
propValue - the property value
Returns:
previous property value (if any)
Since:
WSSDK 5.0

init

public void init()
          throws ServletException
The HTTP servlet init method is delegated to the delegate.

Throws:
ServletException

init

public void init(ServletConfig config)
          throws ServletException
The HTTP servlet init method. Calls the init() method.

Specified by:
init in interface Servlet
Throws:
ServletException

doGet

public void doGet(HttpServletRequest req,
                  HttpServletResponse res)
           throws ServletException,
                  IOException
The HTTP servlet doGet method is delegated to the delegate.

Throws:
ServletException
IOException

doPost

public void doPost(HttpServletRequest req,
                   HttpServletResponse res)
            throws ServletException,
                   IOException
The HTTP servlet doPost method is delegated to the delegate.

Throws:
ServletException
IOException

isDocument

public boolean isDocument(String action)
Determine if a method with specified SOAP action is document style

Specified by:
isDocument in interface InvokeHandler
Parameters:
action - the SOAP action
Returns:
TRUE if document style, false if RPC style
Since:
jBroker Web 1.1

_setHandlerChain

public void _setHandlerChain(List handlerChain)
Set the handler chain on this servlet skeleton.

Specified by:
_setHandlerChain in interface Skeleton
Parameters:
handlerChain - a standard handler chain
Since:
jBroker Web 2.0

_getHandlerChain

public List _getHandlerChain()
Get the handler chain set on this servlet skeleton

Returns:
a standard handler chain
Since:
jBroker Web 2.0

_invoke

public ServerResponse _invoke(Properties httpHeaders,
                              InputStream is)
                       throws IOException
Implementation of InvokeHandler.invoke(Properties httpHeaders, InputStream is)

Specified by:
_invoke in interface InvokeHandler
Parameters:
httpHeaders - transport header iformation
is - input stream to read
Returns:
a specialized server response output stream
Throws:
IOException - if an I/O exception occurred during invoke

_setClassInfo

public void _setClassInfo(ClassInfo info)
Set dispatch information for this service object

Specified by:
_setClassInfo in interface ServiceObject
Parameters:
info - the class info
Since:
jBroker Web 2.0

_getClassInfo

public ClassInfo _getClassInfo()
Description copied from interface: ServiceObject
Get dispatch information for this service object

Specified by:
_getClassInfo in interface ServiceObject
Returns:
the class info
Since:
jBroker Web 2.0

_getOperationName

public QName _getOperationName()
Description copied from interface: ServiceObject
Get the operations's QName

Specified by:
_getOperationName in interface ServiceObject
Returns:
the operation Name
Since:
jBroker Web 2.0

_setHandlerChain

public void _setHandlerChain(HandlerChain chain)
Description copied from interface: ServiceObject
Set the HandlerChain for the Stub

Specified by:
_setHandlerChain in interface ServiceObject
Parameters:
chain - the HandlerChain.

Novell exteNd Web Services SDK API

exteNd is a registered trademark of Novell, Inc.
Copyright 1998-2003 Novell, Inc. All Rights Reserved.