Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Apache CXF API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.cxf.transport.http
Class AbstractHTTPDestination

java.lang.Object
  extended by org.apache.cxf.transport.AbstractObservable
      extended by org.apache.cxf.transport.AbstractDestination
          extended by org.apache.cxf.transport.AbstractMultiplexDestination
              extended by org.apache.cxf.transport.http.AbstractHTTPDestination
All Implemented Interfaces:
Configurable, Assertor, Destination, DestinationWithEndpoint, MultiplexDestination, Observable
Direct Known Subclasses:
JettyHTTPDestination, NettyHttpDestination, ServletDestination
public abstract class AbstractHTTPDestination
extends AbstractMultiplexDestination
implements Configurable, Assertor

Common base for HTTP Destination implementations.

Nested Class Summary
 class AbstractHTTPDestination.BackChannelConduit
          Backchannel conduit.
static class AbstractHTTPDestination.PrincipalAuthorizationPolicy
           
 
Nested classes/interfaces inherited from class org.apache.cxf.transport.AbstractDestination
AbstractDestination.AbstractBackChannelConduit
 
Field Summary
protected  Bus bus
           
protected  CertConstraints certConstraints
           
protected  String contextMatchStrategy
           
protected  ContinuationProviderFactory cproviderFactory
           
static String CXF_ASYNC_CONTEXT
           
static String CXF_CONTINUATION_MESSAGE
           
protected  boolean enableWebSocket
           
protected  boolean fixedParameterOrder
           
static String HTTP_CONFIG
           
static String HTTP_CONTEXT
           
static String HTTP_CONTEXT_MATCH_STRATEGY
           
static String HTTP_REQUEST
           
static String HTTP_RESPONSE
           
protected  boolean isServlet3
           
protected  boolean multiplexWithAddress
           
protected  String path
           
protected  DestinationRegistry registry
           
static String REQUEST_REDIRECTED
           
static String RESPONSE_COMMITED
           
static String RESPONSE_HEADERS_COPIED
           
protected  HTTPServerPolicy serverPolicy
           
static String SERVICE_REDIRECTION
           
 
Fields inherited from class org.apache.cxf.transport.AbstractDestination
endpointInfo, reference
 
Fields inherited from class org.apache.cxf.transport.AbstractObservable
incomingObserver
 
Constructor Summary
AbstractHTTPDestination(Bus b, DestinationRegistry registry, EndpointInfo ei, String path, boolean dp)
          Constructor
 
Method Summary
protected  void activate()
          Activate messages flow.
 void assertMessage(Message message)
           
 boolean canAssert(QName type)
           
protected  boolean contextMatchOnExact()
           
protected  void deactivate()
          Deactivate messages flow.
 void finalizeConfig()
           
protected  OutputStream flushHeaders(Message outMessage)
           
protected  OutputStream flushHeaders(Message outMessage, boolean getStream)
           
protected static EndpointInfo getAddressValue(EndpointInfo ei)
           
protected static EndpointInfo getAddressValue(EndpointInfo ei, boolean dp)
           
 EndpointReferenceType getAddressWithId(String id)
          Builds an new endpoint reference using the current target reference as a template.
protected  String getBasePath(String contextPath)
           
 String getBeanName()
          Get the configurable object's Bean name
 Bus getBus()
           
 String getContextMatchStrategy()
           
 String getId(Map<String,Object> context)
          Obtain id from reference parameters of the ws-a to address Requires the existance of ws-a interceptors on dispatch path to provide access to the ws-a headers
protected  Conduit getInbuiltBackChannel(Message inMessage)
           
 String getPath()
           
 HTTPServerPolicy getServer()
           
 void invoke(javax.servlet.ServletConfig config, javax.servlet.ServletContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
           
protected  void invokeComplete(javax.servlet.ServletContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, Message m)
           
 boolean isFixedParameterOrder()
           
 boolean isMultiplexWithAddress()
           
protected  boolean isOneWay(Message message)
           
 void releaseRegistry()
           
protected  Message retrieveFromContinuation(javax.servlet.http.HttpServletRequest req)
           
protected  Message retrieveFromServlet3Async(javax.servlet.http.HttpServletRequest req)
           
 void setContextMatchStrategy(String contextMatchStrategy)
           
 void setFixedParameterOrder(boolean fixedParameterOrder)
           
 void setMultiplexWithAddress(boolean multiplexWithAddress)
           
 void setServer(HTTPServerPolicy server)
           
protected  void setupContinuation(Message inMessage, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
           
protected  void setupMessage(Message inMessage, javax.servlet.ServletConfig config, javax.servlet.ServletContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
           
 void shutdown()
          Shutdown the Destination, i.e.
 
Methods inherited from class org.apache.cxf.transport.AbstractDestination
getAddress, getBackChannel, getEndpointInfo
 
Methods inherited from class org.apache.cxf.transport.AbstractObservable
getLogger, getMessageObserver, getTargetReference, getTargetReference, setMessageObserver
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.cxf.transport.Destination
getAddress, getBackChannel, getMessageObserver
 
Methods inherited from interface org.apache.cxf.transport.Observable
setMessageObserver
 

Field Detail

HTTP_REQUEST

public static final String HTTP_REQUEST
See Also:
Constant Field Values

HTTP_RESPONSE

public static final String HTTP_RESPONSE
See Also:
Constant Field Values

HTTP_CONTEXT

public static final String HTTP_CONTEXT
See Also:
Constant Field Values

HTTP_CONFIG

public static final String HTTP_CONFIG
See Also:
Constant Field Values

HTTP_CONTEXT_MATCH_STRATEGY

public static final String HTTP_CONTEXT_MATCH_STRATEGY
See Also:
Constant Field Values

RESPONSE_HEADERS_COPIED

public static final String RESPONSE_HEADERS_COPIED
See Also:
Constant Field Values

RESPONSE_COMMITED

public static final String RESPONSE_COMMITED
See Also:
Constant Field Values

REQUEST_REDIRECTED

public static final String REQUEST_REDIRECTED
See Also:
Constant Field Values

CXF_CONTINUATION_MESSAGE

public static final String CXF_CONTINUATION_MESSAGE
See Also:
Constant Field Values

CXF_ASYNC_CONTEXT

public static final String CXF_ASYNC_CONTEXT
See Also:
Constant Field Values

SERVICE_REDIRECTION

public static final String SERVICE_REDIRECTION
See Also:
Constant Field Values

bus

protected final Bus bus

registry

protected DestinationRegistry registry

path

protected final String path

serverPolicy

protected HTTPServerPolicy serverPolicy

contextMatchStrategy

protected String contextMatchStrategy

fixedParameterOrder

protected boolean fixedParameterOrder

multiplexWithAddress

protected boolean multiplexWithAddress

certConstraints

protected CertConstraints certConstraints

isServlet3

protected boolean isServlet3

cproviderFactory

protected ContinuationProviderFactory cproviderFactory

enableWebSocket

protected boolean enableWebSocket
Constructor Detail

AbstractHTTPDestination

public AbstractHTTPDestination(Bus b,
                               DestinationRegistry registry,
                               EndpointInfo ei,
                               String path,
                               boolean dp)
                        throws IOException
Constructor

Parameters:
b - the associated Bus
ci - the associated conduit initiator
ei - the endpoint info of the destination
dp - true for adding the default port if it is missing
Throws:
IOException
Method Detail

getBus

public Bus getBus()

isOneWay

protected final boolean isOneWay(Message message)
Parameters:
message - the message under consideration
Returns:
true iff the message has been marked as oneway

invoke

public void invoke(javax.servlet.ServletConfig config,
                   javax.servlet.ServletContext context,
                   javax.servlet.http.HttpServletRequest req,
                   javax.servlet.http.HttpServletResponse resp)
            throws IOException
Throws:
IOException

invokeComplete

protected void invokeComplete(javax.servlet.ServletContext context,
                              javax.servlet.http.HttpServletRequest req,
                              javax.servlet.http.HttpServletResponse resp,
                              Message m)
                       throws IOException
Throws:
IOException

setupMessage

protected void setupMessage(Message inMessage,
                            javax.servlet.ServletConfig config,
                            javax.servlet.ServletContext context,
                            javax.servlet.http.HttpServletRequest req,
                            javax.servlet.http.HttpServletResponse resp)
                     throws IOException
Throws:
IOException

retrieveFromContinuation

protected Message retrieveFromContinuation(javax.servlet.http.HttpServletRequest req)

retrieveFromServlet3Async

protected Message retrieveFromServlet3Async(javax.servlet.http.HttpServletRequest req)

setupContinuation

protected void setupContinuation(Message inMessage,
                                 javax.servlet.http.HttpServletRequest req,
                                 javax.servlet.http.HttpServletResponse resp)

getBasePath

protected String getBasePath(String contextPath)
                      throws IOException
Throws:
IOException

getAddressValue

protected static EndpointInfo getAddressValue(EndpointInfo ei)

getAddressValue

protected static EndpointInfo getAddressValue(EndpointInfo ei,
                                              boolean dp)

getInbuiltBackChannel

protected Conduit getInbuiltBackChannel(Message inMessage)
Specified by:
getInbuiltBackChannel in class AbstractDestination
Parameters:
inMessage - the incoming message
Returns:
the inbuilt backchannel

flushHeaders

protected OutputStream flushHeaders(Message outMessage)
                             throws IOException
Throws:
IOException

flushHeaders

protected OutputStream flushHeaders(Message outMessage,
                                    boolean getStream)
                             throws IOException
Throws:
IOException

contextMatchOnExact

protected boolean contextMatchOnExact()

finalizeConfig

public void finalizeConfig()

getBeanName

public String getBeanName()
Description copied from interface: Configurable
Get the configurable object's Bean name

Specified by:
getBeanName in interface Configurable
Returns:
the bean name

getAddressWithId

public EndpointReferenceType getAddressWithId(String id)
Description copied from class: AbstractMultiplexDestination
Builds an new endpoint reference using the current target reference as a template. The supplied id is endcoded using a reference parameter. This requires the ws-a interceptors to propagate the reference parameters on subsequent invokes using the returned reference.

Specified by:
getAddressWithId in interface MultiplexDestination
Overrides:
getAddressWithId in class AbstractMultiplexDestination
Parameters:
id - the id to encode in the new reference
Returns:
the new reference with the id encoded as a reference parameter
See Also:
MultiplexDestination.getAddressWithId(java.lang.String)

getId

public String getId(Map<String,Object> context)
Description copied from class: AbstractMultiplexDestination
Obtain id from reference parameters of the ws-a to address Requires the existance of ws-a interceptors on dispatch path to provide access to the ws-a headers

Specified by:
getId in interface MultiplexDestination
Overrides:
getId in class AbstractMultiplexDestination
Parameters:
context - the current invocation or message context
Returns:
the id from the reference parameters of the ws-a-to address or null if not found
See Also:
MultiplexDestination.getId(java.util.Map)

getContextMatchStrategy

public String getContextMatchStrategy()

setContextMatchStrategy

public void setContextMatchStrategy(String contextMatchStrategy)

isFixedParameterOrder

public boolean isFixedParameterOrder()

setFixedParameterOrder

public void setFixedParameterOrder(boolean fixedParameterOrder)

isMultiplexWithAddress

public boolean isMultiplexWithAddress()

setMultiplexWithAddress

public void setMultiplexWithAddress(boolean multiplexWithAddress)

getServer

public HTTPServerPolicy getServer()

setServer

public void setServer(HTTPServerPolicy server)

assertMessage

public void assertMessage(Message message)
Specified by:
assertMessage in interface Assertor

canAssert

public boolean canAssert(QName type)
Specified by:
canAssert in interface Assertor

releaseRegistry

public void releaseRegistry()

getPath

public String getPath()

activate

protected void activate()
Description copied from class: AbstractObservable
Activate messages flow.

Overrides:
activate in class AbstractObservable

deactivate

protected void deactivate()
Description copied from class: AbstractObservable
Deactivate messages flow.

Overrides:
deactivate in class AbstractObservable

shutdown

public void shutdown()
Description copied from class: AbstractDestination
Shutdown the Destination, i.e. stop accepting incoming messages.

Specified by:
shutdown in interface Destination
Overrides:
shutdown in class AbstractDestination
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Apache CXF API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Apache CXF