com.sun.xml.ws.assembler.dev
Interface ServerTubelineAssemblyContext

All Superinterfaces:
TubelineAssemblyContext

public interface ServerTubelineAssemblyContext
extends TubelineAssemblyContext


Method Summary
 Codec getCodec()
          Gets the Codec that is set by setCodec(com.sun.xml.ws.api.pipe.Codec) or the default codec based on the binding.
 WSEndpoint getEndpoint()
          The created pipeline is used to serve this WSEndpoint.
 com.sun.xml.ws.policy.PolicyMap getPolicyMap()
           
 SEIModel getSEIModel()
          The created pipeline will use seiModel to get java concepts for the endpoint
 Tube getTerminalTube()
          The last Pipe in the pipeline.
 ServerTubeAssemblerContext getWrappedContext()
           
 WSDLPort getWsdlPort()
          The created pipeline will be used to serve this port.
 boolean isPolicyAvailable()
           
 boolean isSynchronous()
          If this server pipeline is known to be used for serving synchronous transport, then this method returns true.
 void setCodec(Codec codec)
          Interception point to change Codec during Tubeline assembly.
 
Methods inherited from interface com.sun.xml.ws.assembler.dev.TubelineAssemblyContext
getAdaptedTubelineHead, getImplementation, getTubelineHead
 

Method Detail

getCodec

@NotNull
Codec getCodec()
Gets the Codec that is set by setCodec(com.sun.xml.ws.api.pipe.Codec) or the default codec based on the binding. The codec is a full codec that is responsible for encoding/decoding entire protocol message(for e.g: it is responsible to encode/decode entire MIME messages in SOAP binding)

Returns:
codec to be used for web service requests
See Also:
Codecs

getEndpoint

@NotNull
WSEndpoint getEndpoint()
The created pipeline is used to serve this WSEndpoint. Specifically, its WSBinding should be of interest to many Pipes.

Returns:
Always non-null.

getPolicyMap

com.sun.xml.ws.policy.PolicyMap getPolicyMap()

getSEIModel

@Nullable
SEIModel getSEIModel()
The created pipeline will use seiModel to get java concepts for the endpoint

Returns:
Null if the service doesn't have SEI model e.g. Provider endpoints, and otherwise non-null.

getTerminalTube

@NotNull
Tube getTerminalTube()
The last Pipe in the pipeline. The assembler is expected to put additional Pipes in front of it.

(Just to give you the idea how this is used, normally the terminal pipe is the one that invokes the user application or Provider.)

Returns:
always non-null terminal pipe

getWrappedContext

ServerTubeAssemblerContext getWrappedContext()

getWsdlPort

@Nullable
WSDLPort getWsdlPort()
The created pipeline will be used to serve this port.

Returns:
Null if the service isn't associated with any port definition in WSDL, and otherwise non-null.

isPolicyAvailable

boolean isPolicyAvailable()

isSynchronous

boolean isSynchronous()
If this server pipeline is known to be used for serving synchronous transport, then this method returns true. This can be potentially use as an optimization hint, since often synchronous versions are cheaper to execute than asycnhronous versions.


setCodec

void setCodec(@NotNull
              Codec codec)
Interception point to change Codec during Tubeline assembly. The new codec will be used by jax-ws server runtime for encoding/decoding web service request/response messages. WSEndpoint.createCodec() will return a copy of this new codec and will be used in the server runtime.

The codec is a full codec that is responsible for encoding/decoding entire protocol message(for e.g: it is responsible to encode/decode entire MIME messages in SOAP binding)

the codec should correctly implement Codec.copy() since it is used while serving requests concurrently.

Parameters:
codec - codec to be used for web service requests
See Also:
Codecs


Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.