com.sun.xml.wss
Class ProcessingContext

java.lang.Object
  extended by com.sun.xml.wss.ProcessingContext
All Implemented Interfaces:
SecurityProcessingContext
Direct Known Subclasses:
ProcessingContextImpl

public class ProcessingContext
extends Object
implements SecurityProcessingContext

This class represents a Context that is used by the XWS-Security Runtime to apply/verify Security Policies on an Outgoing/Incoming SOAP Message. The context contains among other things


Field Summary
static String OPERATION_RESOLVER
           
protected  Map properties
           
protected  SecurableSoapMessage secureMessage
           
protected  MessageLayout securityHeaderLayout
           
 
Constructor Summary
ProcessingContext()
          Default constructor
ProcessingContext(StaticPolicyContext context, SecurityPolicy securityPolicy, SOAPMessage message)
          Constructor
 
Method Summary
static void copy(Map p1, Map p2)
           
 void copy(ProcessingContext ctx1, ProcessingContext ctx2)
          copy operator
 void copy(SecurityProcessingContext ctx1, SecurityProcessingContext ctx2)
          copy operator
 int getConfigType()
          This method is used for internal purposes
 Map getExtraneousProperties()
          Properties extraneously defined by XWSS runtime - can contain application's runtime context (like JAXRPCContext etc)
 Object getExtraneousProperty(String name)
           
 CallbackHandler getHandler()
           
 String getMessageIdentifier()
           
 StaticPolicyContext getPolicyContext()
           
protected  SecurableSoapMessage getSecureMessage()
           
 SecurityEnvironment getSecurityEnvironment()
           
 MessageLayout getSecurityHeaderLayout()
           
 SecurityPolicy getSecurityPolicy()
           
 SOAPMessage getSOAPMessage()
           
 boolean isClient()
           
 void isClient(boolean isClient)
           
 boolean isExpired()
           
 void isExpired(boolean value)
           
 boolean isInboundMessage()
           
 void isInboundMessage(boolean inBound)
          set the message flow direction (to true if inbound, false if outbound)
 void removeExtraneousProperty(String name)
          remove the named extraneous property if present
 void reset()
          This method is used for internal purposes
 boolean resetMustUnderstand()
           
 void resetMustUnderstand(boolean b)
           
 boolean retainSecurityHeader()
           
 void retainSecurityHeader(boolean arg)
           
 void setConfigType(int type)
          This method is used for internal purposes
 void setExtraneousProperty(String name, Object value)
          set the extraneous property into the context Extraneous Properties are properties extraneously defined by XWSS runtime and can contain application's runtime context (like JAXRPCContext etc)
 void setHandler(CallbackHandler handler)
          set the CallbackHandler for the context
 void setMessageIdentifier(String identifier)
          Allow for message identifier to be generated externally
 void setPolicyContext(StaticPolicyContext context)
          set the StaticPolicyContext for this ProcessingContext.
protected  void setSecureMessage(SecurableSoapMessage msg)
           
 void setSecurityEnvironment(SecurityEnvironment handler)
          set the SecurityEnvironment Handler for the context
 void setSecurityHeaderLayout(MessageLayout layout)
           
 void setSecurityPolicy(SecurityPolicy securityPolicy)
          set the SecurityPolicy for the context
 void setSOAPMessage(SOAPMessage message)
          set the SOAP Message into the ProcessingContext.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

secureMessage

protected SecurableSoapMessage secureMessage

properties

protected Map properties

securityHeaderLayout

protected MessageLayout securityHeaderLayout

OPERATION_RESOLVER

public static final String OPERATION_RESOLVER
See Also:
Constant Field Values
Constructor Detail

ProcessingContext

public ProcessingContext()
Default constructor


ProcessingContext

public ProcessingContext(StaticPolicyContext context,
                         SecurityPolicy securityPolicy,
                         SOAPMessage message)
                  throws XWSSecurityException
Constructor

Parameters:
context - the static policy context for this request
securityPolicy - the SecurityPolicy to be applied for this request
message - the SOAPMessage
Throws:
XWSSecurityException - if there was an error in creating the ProcessingContext
Method Detail

resetMustUnderstand

public void resetMustUnderstand(boolean b)

resetMustUnderstand

public boolean resetMustUnderstand()

setSecurityPolicy

public void setSecurityPolicy(SecurityPolicy securityPolicy)
                       throws XWSSecurityException
set the SecurityPolicy for the context

Specified by:
setSecurityPolicy in interface SecurityProcessingContext
Parameters:
securityPolicy - SecurityPolicy
Throws:
XWSSecurityException - if the securityPolicy is of invalid type

getSecurityPolicy

public SecurityPolicy getSecurityPolicy()
Specified by:
getSecurityPolicy in interface SecurityProcessingContext
Returns:
SecurityPolicy for this context

setPolicyContext

public void setPolicyContext(StaticPolicyContext context)
set the StaticPolicyContext for this ProcessingContext.

Specified by:
setPolicyContext in interface SecurityProcessingContext
Parameters:
context - StaticPolicyContext for this context

getPolicyContext

public StaticPolicyContext getPolicyContext()
Specified by:
getPolicyContext in interface SecurityProcessingContext
Returns:
StaticPolicyContext associated with this ProcessingContext, null otherwise

setSOAPMessage

public void setSOAPMessage(SOAPMessage message)
                    throws XWSSecurityException
set the SOAP Message into the ProcessingContext.

Specified by:
setSOAPMessage in interface SecurityProcessingContext
Parameters:
message - SOAPMessage
Throws:
XWSSecurityException - if there was an error in setting the SOAPMessage

getSOAPMessage

public SOAPMessage getSOAPMessage()
Specified by:
getSOAPMessage in interface SecurityProcessingContext
Returns:
the SOAPMessage from the context

setHandler

public void setHandler(CallbackHandler handler)
set the CallbackHandler for the context

Specified by:
setHandler in interface SecurityProcessingContext
Parameters:
handler - The CallbackHandler

setSecurityEnvironment

public void setSecurityEnvironment(SecurityEnvironment handler)
set the SecurityEnvironment Handler for the context

Specified by:
setSecurityEnvironment in interface SecurityProcessingContext
Parameters:
handler - The SecurityEnvironment Handler

getHandler

public CallbackHandler getHandler()
Specified by:
getHandler in interface SecurityProcessingContext
Returns:
the CallbackHandler set for the context

getSecurityEnvironment

public SecurityEnvironment getSecurityEnvironment()
Specified by:
getSecurityEnvironment in interface SecurityProcessingContext
Returns:
The SecurityEnvironment Handler set for the context

getExtraneousProperties

public Map getExtraneousProperties()
Properties extraneously defined by XWSS runtime - can contain application's runtime context (like JAXRPCContext etc)

Specified by:
getExtraneousProperties in interface SecurityProcessingContext
Returns:
Map of extraneous properties

isInboundMessage

public void isInboundMessage(boolean inBound)
set the message flow direction (to true if inbound, false if outbound)

Specified by:
isInboundMessage in interface SecurityProcessingContext
Parameters:
inBound - message flow direction

isInboundMessage

public boolean isInboundMessage()
Specified by:
isInboundMessage in interface SecurityProcessingContext
Returns:
message flow direction, true if incoming, false otherwise

setMessageIdentifier

public void setMessageIdentifier(String identifier)
Allow for message identifier to be generated externally

Specified by:
setMessageIdentifier in interface SecurityProcessingContext
Parameters:
identifier - the Message Identifier value

getMessageIdentifier

public String getMessageIdentifier()
Specified by:
getMessageIdentifier in interface SecurityProcessingContext
Returns:
message identifier for the Message in the context

setExtraneousProperty

public void setExtraneousProperty(String name,
                                  Object value)
set the extraneous property into the context Extraneous Properties are properties extraneously defined by XWSS runtime and can contain application's runtime context (like JAXRPCContext etc)

Specified by:
setExtraneousProperty in interface SecurityProcessingContext
Parameters:
name - the property name
value - the property value

getExtraneousProperty

public Object getExtraneousProperty(String name)
Specified by:
getExtraneousProperty in interface SecurityProcessingContext
Returns:
the value for the named extraneous property.

removeExtraneousProperty

public void removeExtraneousProperty(String name)
remove the named extraneous property if present

Specified by:
removeExtraneousProperty in interface SecurityProcessingContext
Parameters:
name - the Extraneous Property to be removed

copy

public static void copy(Map p1,
                        Map p2)

copy

public void copy(ProcessingContext ctx1,
                 ProcessingContext ctx2)
          throws XWSSecurityException
copy operator

Parameters:
ctx1 - the ProcessingContext to which to copy
ctx2 - the ProcessingContext from which to copy
Throws:
XWSSecurityException - if there was an error during the copy operation

reset

public void reset()
This method is used for internal purposes

Specified by:
reset in interface SecurityProcessingContext

getConfigType

public int getConfigType()
This method is used for internal purposes

Specified by:
getConfigType in interface SecurityProcessingContext

setConfigType

public void setConfigType(int type)
This method is used for internal purposes

Specified by:
setConfigType in interface SecurityProcessingContext

getSecureMessage

protected SecurableSoapMessage getSecureMessage()

setSecureMessage

protected void setSecureMessage(SecurableSoapMessage msg)

copy

public void copy(SecurityProcessingContext ctx1,
                 SecurityProcessingContext ctx2)
          throws XWSSecurityException
Description copied from interface: SecurityProcessingContext
copy operator

Specified by:
copy in interface SecurityProcessingContext
Parameters:
ctx1 - the ProcessingContext to which to copy
ctx2 - the ProcessingContext from which to copy
Throws:
XWSSecurityException - if there was an error during the copy operation

setSecurityHeaderLayout

public void setSecurityHeaderLayout(MessageLayout layout)

getSecurityHeaderLayout

public MessageLayout getSecurityHeaderLayout()

retainSecurityHeader

public boolean retainSecurityHeader()

retainSecurityHeader

public void retainSecurityHeader(boolean arg)

isClient

public void isClient(boolean isClient)

isClient

public boolean isClient()

isExpired

public boolean isExpired()

isExpired

public void isExpired(boolean value)


Copyright © 2005-2015 Oracle Corporation. All Rights Reserved.