Package com.sun.xml.wss.jaxws.impl

Class SecurityClientTube

java.lang.Object

com.sun.xml.ws.api.pipe.helper.AbstractTubeImpl

com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl

com.sun.xml.wss.jaxws.impl.SecurityTubeBase

com.sun.xml.wss.jaxws.impl.SecurityClientTube

All Implemented Interfaces:

Pipe, Tube, SecureConversationInitiator

public class SecurityClientTube
extends SecurityTubeBase
implements SecureConversationInitiator

Author:

Vbkumar.Jayanti@Sun.COM, shyam.rao@sun.com

Field Summary

Fields inherited from class com.sun.xml.wss.jaxws.impl.SecurityTubeBase

allowMissingTimestamp, bindingLevelAlgSuite, bpMSP, bsp10, cachedOperation, debug, disableIncPrefix, disablePayloadBuffer, EMPTY_LIST, encHeaderContent, encRMLifecycleMsg, isCertValid, isCertValidityVerified, isEPREnabled, isSOAP12, issuedTokenContextMap, iterationsForPDK, jaxbContext, log, marshaller, mcVer, optimized, policyAlternatives, rmVer, secEnv, securityMUValue, securityPolicyNamespaces, serverCert, soapFactory, soapVersion, spVersion, timestampTimeOut, transportOptimization, tubeConfig, unmarshaller, WSDLPORT, WSENDPOINT, wsitConfig, wsPolicyMap, wsscVer, wsTrustVer

Fields inherited from class com.sun.xml.ws.api.pipe.helper.AbstractFilterTubeImpl

next

Constructor Summary

Constructors

Modifier	Constructor	Description
	SecurityClientTube(ClientTubelineAssemblyContext wsitContext, Tube nextTube)
protected	SecurityClientTube(SecurityClientTube that, TubeCloner cloner)

Method Summary

Modifier and Type	Method	Description
protected void	addIncomingFaultPolicy(Policy effectivePolicy, SecurityPolicyHolder sph, WSDLFault fault)
protected SecurityPolicyHolder	addIncomingMP(WSDLBoundOperation operation, Policy policy, PolicyAlternativeHolder ph)
protected void	addIncomingProtocolPolicy(Policy effectivePolicy, String protocol, PolicyAlternativeHolder ph)
protected void	addOutgoingFaultPolicy(Policy effectivePolicy, SecurityPolicyHolder sph, WSDLFault fault)
protected SecurityPolicyHolder	addOutgoingMP(WSDLBoundOperation operation, Policy policy, PolicyAlternativeHolder ph)
protected void	addOutgoingProtocolPolicy(Policy effectivePolicy, String protocol, PolicyAlternativeHolder ph)
AbstractTubeImpl	copy(TubeCloner cloner)	Creates an identical clone of this Tube.
protected String	getAction(WSDLOperation operation, boolean inComming)
protected List<PolicyAssertion>	getIssuedTokenPolicies(Packet packet, String scope)
protected void	populateKerberosContext(Packet packet, ProcessingContextImpl ctx, boolean isSCMessage)
void	preDestroy()	Invoked before the last copy of the pipeline is about to be discarded, to give Tubes a chance to clean up any resources.
Packet	processClientRequestPacket(Packet packet)
Packet	processClientResponsePacket(Packet ret)
NextAction	processException(Throwable t)	Default no-op implementation.
NextAction	processRequest(Packet packet)	Default no-op implementation.
NextAction	processResponse(Packet ret)	Default no-op implementation.
jakarta.xml.bind.JAXBElement	startSecureConversation(Packet packet)

Methods inherited from class com.sun.xml.wss.jaxws.impl.SecurityTubeBase

bindingHasIssuedTokenPolicy, bindingHasRMPolicy, bindingHasSecureConversationPolicy, buildProtocolPolicy, cacheMessage, cacheOperation, collectPolicies, constructPolicyHolder, constructPolicyHolder, generateInternalError, getAction, getAlgoSuite, getBindingAlgorithmSuite, getEffectiveBootstrapPolicy, getInBoundSCP, getInboundXWSBootstrapPolicy, getIssuedTokenPoliciesFromBootstrapPolicy, getKerberosTokenPoliciesFromBootstrapPolicy, getOperation, getOperationKey, getOutBoundKTP, getOutBoundSCP, getOutgoingXWSBootstrapPolicy, getOutgoingXWSSecurityPolicy, getSecureConversationPolicies, getSOAPFault, getSOAPFaultException, getSOAPFaultException, getTokens, getWSDLOpFromAction, getWSDLOpFromAction, getWssAssertion, hasKerberosTokenPolicy, initializeInboundProcessingContext, initializeOutgoingProcessingContext, isAddressingEnabled, isMakeConnectionMessage, isRMMessage, isSCCancel, isSCMessage, isSCRenew, isTrustMessage, loadClass, populateConfigProperties, resetCachedOperation, resolveAlternative, secureOutboundMessage, secureOutboundMessage, unmarshalPolicy, verifyInboundMessage, verifyInboundMessage

Methods inherited from class com.sun.xml.ws.api.pipe.helper.AbstractTubeImpl

copy, doInvoke, doInvokeAndForget, doReturnWith, doSuspend, doSuspend, doSuspend, doSuspend, doThrow, doThrow, process

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityClientTube

public SecurityClientTube(ClientTubelineAssemblyContext wsitContext,
                          Tube nextTube)

SecurityClientTube

protected SecurityClientTube(SecurityClientTube that,
                             TubeCloner cloner)

Method Detail

copy

public AbstractTubeImpl copy(TubeCloner cloner)

Description copied from interface: Tube

Creates an identical clone of this Tube.

This method creates an identical pipeline that can be used concurrently with this pipeline. When the caller of a pipeline is multi-threaded and need concurrent use of the same pipeline, it can do so by creating copies through this method.

Implementation Note

It is the implementation's responsibility to call TubeCloner.add(Tube,Tube) to register the copied pipe with the original. This is required before you start copying the other Tube references you have, or else there's a risk of infinite recursion.

For most Tube implementations that delegate to another Tube, this method requires that you also copy the Tube that you delegate to.

For limited number of Tubes that do not maintain any thread unsafe resource, it is allowed to simply return this from this method (notice that even if you are stateless, if you got a delegating Tube and that one isn't stateless, you still have to copy yourself.)

Note that this method might be invoked by one thread while another thread is executing the other process method. See the Codec.copy() for more discussion about this.

Specified by:

copy in interface Tube

Specified by:

copy in class AbstractTubeImpl

Parameters:

cloner - Use this object (in particular its TubeCloner.copy(Tube) method to clone other pipe references you have in your pipe. See TubeCloner for more discussion about why.

Returns:

always non-null Tube.

processRequest

public NextAction processRequest(Packet packet)

Description copied from class: AbstractFilterTubeImpl

Default no-op implementation.

Specified by:

processRequest in interface Tube

Overrides:

processRequest in class AbstractFilterTubeImpl

Parameters:

packet - The packet that represents a request message. If the packet has a non-null message, it must be a valid unconsumed Message. This message represents the SOAP message to be sent as a request.

The packet is also allowed to carry no message, which indicates that this is an output-only request. (that's called "solicit", right? - KK)

Returns:

A NextAction object that represents the next action to be taken by the JAX-WS runtime.

processClientRequestPacket

public Packet processClientRequestPacket(Packet packet)

processResponse

public NextAction processResponse(Packet ret)

Description copied from class: AbstractFilterTubeImpl

Default no-op implementation.

Specified by:

processResponse in interface Tube

Overrides:

processResponse in class AbstractFilterTubeImpl

Parameters:

ret - If the packet has a non-null message, it must be a valid unconsumed Message. This message represents a response to the request message passed to Tube.processRequest(Packet) earlier.

The packet is also allowed to carry no message, which indicates that there was no response. This is used for things like one-way message and/or one-way transports. TODO: exception handling semantics need more discussion

Returns:

A NextAction object that represents the next action to be taken by the JAX-WS runtime.

processClientResponsePacket

public Packet processClientResponsePacket(Packet ret)

processException

public NextAction processException(Throwable t)

Description copied from class: AbstractFilterTubeImpl

Default no-op implementation.

Specified by:

processException in interface Tube

Overrides:

processException in class AbstractFilterTubeImpl

Returns:

A NextAction object that represents the next action to be taken by the JAX-WS runtime.

getIssuedTokenPolicies

protected List<PolicyAssertion> getIssuedTokenPolicies(Packet packet,
                                                       String scope)

startSecureConversation

public jakarta.xml.bind.JAXBElement startSecureConversation(Packet packet)
                                                     throws WSSecureConversationException

Specified by:

startSecureConversation in interface SecureConversationInitiator

Throws:

WSSecureConversationException

preDestroy

public void preDestroy()

Description copied from interface: Tube

Invoked before the last copy of the pipeline is about to be discarded, to give Tubes a chance to clean up any resources.

This can be used to invoke PreDestroy lifecycle methods on user handler. The invocation of it is optional on the client side, but mandatory on the server side.

When multiple copies of pipelines are created, this method is called only on one of them.

Specified by:

preDestroy in interface Pipe

Specified by:

preDestroy in interface Tube

Overrides:

preDestroy in class AbstractFilterTubeImpl

addOutgoingMP

protected SecurityPolicyHolder addOutgoingMP(WSDLBoundOperation operation,
                                             Policy policy,
                                             PolicyAlternativeHolder ph)
                                      throws PolicyException

Specified by:

addOutgoingMP in class SecurityTubeBase

Throws:

PolicyException

addIncomingMP

protected SecurityPolicyHolder addIncomingMP(WSDLBoundOperation operation,
                                             Policy policy,
                                             PolicyAlternativeHolder ph)
                                      throws PolicyException

Specified by:

addIncomingMP in class SecurityTubeBase

Throws:

PolicyException

addIncomingProtocolPolicy

protected void addIncomingProtocolPolicy(Policy effectivePolicy,
                                         String protocol,
                                         PolicyAlternativeHolder ph)
                                  throws PolicyException

Specified by:

addIncomingProtocolPolicy in class SecurityTubeBase

Throws:

PolicyException

addOutgoingProtocolPolicy

protected void addOutgoingProtocolPolicy(Policy effectivePolicy,
                                         String protocol,
                                         PolicyAlternativeHolder ph)
                                  throws PolicyException

Specified by:

addOutgoingProtocolPolicy in class SecurityTubeBase

Throws:

PolicyException

addIncomingFaultPolicy

protected void addIncomingFaultPolicy(Policy effectivePolicy,
                                      SecurityPolicyHolder sph,
                                      WSDLFault fault)
                               throws PolicyException

Specified by:

addIncomingFaultPolicy in class SecurityTubeBase

Throws:

PolicyException

addOutgoingFaultPolicy

protected void addOutgoingFaultPolicy(Policy effectivePolicy,
                                      SecurityPolicyHolder sph,
                                      WSDLFault fault)
                               throws PolicyException

Specified by:

addOutgoingFaultPolicy in class SecurityTubeBase

Throws:

PolicyException

getAction

protected String getAction(WSDLOperation operation,
                           boolean inComming)

Specified by:

getAction in class SecurityTubeBase

populateKerberosContext

protected void populateKerberosContext(Packet packet,
                                       ProcessingContextImpl ctx,
                                       boolean isSCMessage)
                                throws XWSSecurityException

Throws:

XWSSecurityException