org.apache.ws.security.policy.parser
Class SecurityProcessorContext

java.lang.Object
  extended byorg.apache.ws.security.policy.parser.SecurityProcessorContext

public class SecurityProcessorContext
extends java.lang.Object


Field Summary
static int ABORT
           
static java.lang.String[] ACTION_NAMES
           
static int COMMIT
           
static int NONE
           
static int START
           
 
Constructor Summary
SecurityProcessorContext()
           
 
Method Summary
 PolicyEngineData commitPolicyEngineData()
           
 int getAction()
          Gets the action to perform in the processing method.
 org.apache.ws.policy.PrimitiveAssertion getAssertion()
          Get the current assertion that is being processed.
 java.util.ArrayList getPedStack()
           
 PolicyEngineData popPolicyEngineData()
          Pop a PolicyEngineData from the PED stack.
 SecurityPolicyToken popSecurityToken()
          Pop a SecurityPolicyToken from the token stack.
 void pushPolicyEngineData(PolicyEngineData ped)
          Push a PolicyEngineData onto the PED stack.
 void pushSecurityToken(SecurityPolicyToken spt)
          Push a SecurityPolicyToken onto the token stack.
 PolicyEngineData readCurrentPolicyEngineData()
          Reads and returns the current PolicyEngineData.
 SecurityPolicyToken readCurrentSecurityToken()
          Reads and returns the current SecurityPolicyToken.
 PolicyEngineData readPreviousPolicyEngineData()
           
 void setAction(int act)
          Sets to action to perform in the processing method.
 void setAssertion(org.apache.ws.policy.PrimitiveAssertion asrt)
          Set the current assertion that is being processed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NONE

public static final int NONE
See Also:
Constant Field Values

START

public static final int START
See Also:
Constant Field Values

COMMIT

public static final int COMMIT
See Also:
Constant Field Values

ABORT

public static final int ABORT
See Also:
Constant Field Values

ACTION_NAMES

public static final java.lang.String[] ACTION_NAMES
Constructor Detail

SecurityProcessorContext

public SecurityProcessorContext()
Method Detail

getAction

public int getAction()
Gets the action to perform in the processing method.

Returns:
The action

setAction

public void setAction(int act)
Sets to action to perform in the processing method.

Parameters:
act - The actio to set. Either NONE, START, COMMIT, or ABORT

getAssertion

public org.apache.ws.policy.PrimitiveAssertion getAssertion()
Get the current assertion that is being processed. This is always a PrimitiveAssertion.

Returns:
The current assertion.

setAssertion

public void setAssertion(org.apache.ws.policy.PrimitiveAssertion asrt)
Set the current assertion that is being processed. This is always a primitive assertion.

Parameters:
asrt - The assertion to set

pushSecurityToken

public void pushSecurityToken(SecurityPolicyToken spt)
Push a SecurityPolicyToken onto the token stack. The pushed token becomes the current token. The current token is the starting point for further parsing.

Parameters:
spt - The SecurityPolicyToken to push on the stack

popSecurityToken

public SecurityPolicyToken popSecurityToken()
Pop a SecurityPolicyToken from the token stack. If the stack contains at least one token the method pops the topmost token from the stack and returns it. If the stack is empty the method returns a null.

Returns:
The topmost SecurityPolicyToken or null if the stack is empty.

readCurrentSecurityToken

public SecurityPolicyToken readCurrentSecurityToken()
Reads and returns the current SecurityPolicyToken. If the stack contains at least one token the method reads the topmost token from the stack and returns it. If the stack is empty the method returns a null. The method does not remove the token from the stack.

Returns:
The topmost SecurityPolicyToken or null if the stack is empty.

pushPolicyEngineData

public void pushPolicyEngineData(PolicyEngineData ped)
Push a PolicyEngineData onto the PED stack. The pushed PED becomes the current PED. The current PED is the starting point for further processing.

Parameters:
ped - The PolicyEngineData to push on the stack

popPolicyEngineData

public PolicyEngineData popPolicyEngineData()
Pop a PolicyEngineData from the PED stack. If the stack contains at least one PolicyEngineData the method pops the topmost PolicyEngineData from the stack and returns it. If the stack is empty the method returns a null.

Returns:
The topmost PolicyEngineData or null if the stack is empty.

readCurrentPolicyEngineData

public PolicyEngineData readCurrentPolicyEngineData()
Reads and returns the current PolicyEngineData. If the stack contains at least one PolicyEngineData the method reads the topmost PolicyEngineData from the stack and returns it. If the stack is empty the method returns a null. The method does not remove the PolicyEngineData from the stack.

Returns:
The topmost PolicyEngineData or null if the stack is empty.

readPreviousPolicyEngineData

public PolicyEngineData readPreviousPolicyEngineData()

commitPolicyEngineData

public PolicyEngineData commitPolicyEngineData()

getPedStack

public java.util.ArrayList getPedStack()
Returns:
Returns the pedStack.


Copyright © 2004-2008 Apache Web Services. All Rights Reserved.