com.sun.xml.rpc.server

Class StreamingHandler

java.lang.Object

com.sun.xml.rpc.server.StreamingHandler

All Implemented Interfaces:

Handler, StreamingHandler

Direct Known Subclasses:

TieBase

public abstract class StreamingHandler
extends Object
implements Handler, StreamingHandler

A base class for streaming-oriented handlers (such as ties).

Author:

JAX-RPC Development Team

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StreamingHandler()

Method Summary

Modifier and Type	Method and Description
protected void	callFaultHandlers(StreamingHandlerState state)
protected boolean	callRequestHandlers(StreamingHandlerState state) This method has a number of different exit points.
protected void	callResponseHandlers(StreamingHandlerState state)
protected String	getActor()
protected String	getDefaultEnvelopeEncodingStyle()
protected HandlerChainImpl	getHandlerChain()
protected String	getImplicitEnvelopeEncodingStyle()
Method	getMethodForOpcode(int opcode)
protected String[]	getNamespaceDeclarations()
int	getOpcodeForFirstBodyElementName(QName name)
int	getOpcodeForRequestMessage(SOAPMessage request)
int	getOpcodeForSOAPAction(String s)
protected String	getPreferredCharacterEncoding()
QName[]	getUnderstoodHeaders()
protected XMLReaderFactory	getXMLReaderFactory(StreamingHandlerState state) Return an FI reader if request is FI
protected XMLWriterFactory	getXMLWriterFactory(StreamingHandlerState state) Return an FI writer if request is FI or FI is accept by client
void	handle(SOAPMessageContext spiContext)
protected void	handleEmptyBody(XMLReader reader, SOAPDeserializationContext deserializationContext, StreamingHandlerState state)
protected void	peekFirstBodyElement(XMLReader reader, SOAPDeserializationContext deserializationContext, StreamingHandlerState state)
protected void	postBodyReadingHook(StreamingHandlerState state)
protected void	postEnvelopeReadingHook(StreamingHandlerState state)
protected void	postHandlingHook(StreamingHandlerState state)
protected void	postHeaderReadingHook(StreamingHandlerState state)
protected void	postResponseWritingHook(StreamingHandlerState state)
protected void	preBodyReadingHook(StreamingHandlerState state)
protected void	preEnvelopeReadingHook(StreamingHandlerState state)
protected boolean	preHandlingHook(StreamingHandlerState state)
protected void	preHeaderReadingHook(StreamingHandlerState state)
protected void	preResponseWritingHook(StreamingHandlerState state)
protected boolean	processHeaderElement(XMLReader reader, SOAPDeserializationContext deserializationContext, StreamingHandlerState state)
protected void	processHeaders(XMLReader reader, SOAPDeserializationContext deserializationContext, StreamingHandlerState state)
protected void	processingHook(StreamingHandlerState state)
protected void	readFirstBodyElement(XMLReader reader, SOAPDeserializationContext deserializationContext, StreamingHandlerState state)
protected boolean	readHeaderElement(SOAPHeaderBlockInfo headerInfo, XMLReader reader, SOAPDeserializationContext deserializationContext, StreamingHandlerState state)
protected void	reportFault(SOAPFaultInfo fault, StreamingHandlerState state) Note that a call to StreamingHandlerState.resetResponse() creates a new SAAJ SOAPMessage for the response with the FI flag based on the SOAPMessageContext state.
boolean	usesSOAPActionForDispatching()
protected void	writeResponse(StreamingHandlerState state)

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamingHandler

protected StreamingHandler()

Method Detail

getActor

protected String getActor()

handle

public void handle(SOAPMessageContext spiContext)

Specified by:

handle in interface Handler

processHeaders

protected void processHeaders(XMLReader reader,
                              SOAPDeserializationContext deserializationContext,
                              StreamingHandlerState state)
                       throws Exception

Throws:

Exception

processHeaderElement

protected boolean processHeaderElement(XMLReader reader,
                                       SOAPDeserializationContext deserializationContext,
                                       StreamingHandlerState state)
                                throws Exception

Throws:

Exception

readHeaderElement

protected boolean readHeaderElement(SOAPHeaderBlockInfo headerInfo,
                                    XMLReader reader,
                                    SOAPDeserializationContext deserializationContext,
                                    StreamingHandlerState state)
                             throws Exception

Throws:

Exception

handleEmptyBody

protected void handleEmptyBody(XMLReader reader,
                               SOAPDeserializationContext deserializationContext,
                               StreamingHandlerState state)
                        throws Exception

Throws:

Exception

peekFirstBodyElement

protected void peekFirstBodyElement(XMLReader reader,
                                    SOAPDeserializationContext deserializationContext,
                                    StreamingHandlerState state)
                             throws Exception

Throws:

Exception

readFirstBodyElement

protected void readFirstBodyElement(XMLReader reader,
                                    SOAPDeserializationContext deserializationContext,
                                    StreamingHandlerState state)
                             throws Exception

Throws:

Exception

getOpcodeForRequestMessage

public int getOpcodeForRequestMessage(SOAPMessage request)

Specified by:

getOpcodeForRequestMessage in interface StreamingHandler

usesSOAPActionForDispatching

public boolean usesSOAPActionForDispatching()

getOpcodeForFirstBodyElementName

public int getOpcodeForFirstBodyElementName(QName name)

getOpcodeForSOAPAction

public int getOpcodeForSOAPAction(String s)

getMethodForOpcode

public Method getMethodForOpcode(int opcode)
                          throws ClassNotFoundException,
                                 NoSuchMethodException

Specified by:

getMethodForOpcode in interface StreamingHandler

Throws:

ClassNotFoundException

NoSuchMethodException

getNamespaceDeclarations

protected String[] getNamespaceDeclarations()

getUnderstoodHeaders

public QName[] getUnderstoodHeaders()

getDefaultEnvelopeEncodingStyle

protected String getDefaultEnvelopeEncodingStyle()

getImplicitEnvelopeEncodingStyle

protected String getImplicitEnvelopeEncodingStyle()

getPreferredCharacterEncoding

protected String getPreferredCharacterEncoding()

writeResponse

protected void writeResponse(StreamingHandlerState state)
                      throws Exception

Throws:

Exception

preHandlingHook

protected boolean preHandlingHook(StreamingHandlerState state)
                           throws Exception

Throws:

Exception

postHandlingHook

protected void postHandlingHook(StreamingHandlerState state)
                         throws Exception

Throws:

Exception

preEnvelopeReadingHook

protected void preEnvelopeReadingHook(StreamingHandlerState state)
                               throws Exception

Throws:

Exception

preHeaderReadingHook

protected void preHeaderReadingHook(StreamingHandlerState state)
                             throws Exception

Throws:

Exception

postHeaderReadingHook

protected void postHeaderReadingHook(StreamingHandlerState state)
                              throws Exception

Throws:

Exception

preBodyReadingHook

protected void preBodyReadingHook(StreamingHandlerState state)
                           throws Exception

Throws:

Exception

postBodyReadingHook

protected void postBodyReadingHook(StreamingHandlerState state)
                            throws Exception

Throws:

Exception

postEnvelopeReadingHook

protected void postEnvelopeReadingHook(StreamingHandlerState state)
                                throws Exception

Throws:

Exception

processingHook

protected void processingHook(StreamingHandlerState state)
                       throws Exception

Throws:

Exception

preResponseWritingHook

protected void preResponseWritingHook(StreamingHandlerState state)
                               throws Exception

Throws:

Exception

postResponseWritingHook

protected void postResponseWritingHook(StreamingHandlerState state)
                                throws Exception

Throws:

Exception

callFaultHandlers

protected void callFaultHandlers(StreamingHandlerState state)
                          throws Exception

Throws:

Exception

callRequestHandlers

protected boolean callRequestHandlers(StreamingHandlerState state)
                               throws Exception

This method has a number of different exit points. For all of them, except when true is returned, FI content negotiation must be carried out.

Throws:

Exception

callResponseHandlers

protected void callResponseHandlers(StreamingHandlerState state)
                             throws Exception

Throws:

Exception

getHandlerChain

protected HandlerChainImpl getHandlerChain()

getXMLReaderFactory

protected XMLReaderFactory getXMLReaderFactory(StreamingHandlerState state)

Return an FI reader if request is FI

getXMLWriterFactory

protected XMLWriterFactory getXMLWriterFactory(StreamingHandlerState state)

Return an FI writer if request is FI or FI is accept by client

reportFault

protected void reportFault(SOAPFaultInfo fault,
                           StreamingHandlerState state)

Note that a call to StreamingHandlerState.resetResponse() creates a new SAAJ SOAPMessage for the response with the FI flag based on the SOAPMessageContext state. This is needed for content negotiation.