org.apache.axis2.security.handler.config
Class OutflowConfiguration

java.lang.Object
  extended byorg.apache.axis2.security.handler.config.OutflowConfiguration

public class OutflowConfiguration
extends Object

This is the representation of the outflow configurations of the security module.


Constructor Summary
OutflowConfiguration()
          Creates a default outflow configuration instance with an action.
OutflowConfiguration(int actionCount)
          Creates a new outflow configuration instance with the given number of actions.
 
Method Summary
 String getActionItems()
          Returns the action items.
 String getAddUTElements()
          Returns the additional elements to be added to the username token element.
 String getEmbeddedKeyCallbackClass()
          Returns the embedded key callback class of the current action.
 String getEmbeddedKeyName()
          Returns the text of the key name that needs to be sent.
 String getEnableSignatureConfirmation()
          Returns whether signature confirmation should be enabled or not
 String getEncryptionKeyIdentifier()
          Returns the encrypted key identifier of the current action.
 String getEncryptionKeyTransportAlgorithm()
          Returns the encryption key transport algorithm of the current action.
 String getEncryptionParts()
          Returns the encryption parts of the current action.
 String getEncryptionPropFile()
          Returns the encryption property file.
 String getEncryptionSymAlgorithm()
          Returns the encryption symmetric algorithm of the current action.
 String getEncryptionUser()
          Returns the encryption user of the current action.
 String getOptimizeParts()
          Returns the Path expression to selecte the elements with content of the current action to be MTOM optimized.
 String getPasswordCallbackClass()
          Returns the name of the password callback class of the current action.
 String getPasswordType()
          Returns the password type of the current action.
 String getPreserveOriginalEnvelope()
          Returns whether signature confirmation should be enabled or not.
 Parameter getProperty()
          Returns the configuration as an Parameter
 String getSamlPropFile()
          Returns the SAML property file of the current action.
 String getSignatureKeyIdentifier()
          Returns the signatue key identifier of the current action.
 String getSignatureParts()
          Returns the signature parts of the current action.
 String getSignaturePropFile()
          Returns the signature property file of the current action.
 String getUser()
          Returns the user of the current action.
 void nextAction()
          Moves to the next action.
 void previousAction()
          Moves to previous action.
 void setActionItems(String actionItems)
          Sets the action items.
 void setAddUTElements(String addUTElements)
          Option to add additional elements in the username token element.
 void setEmbeddedKeyCallbackClass(String embeddedKeyCallbackClass)
          Sets the embedded key callback class of the current action
 void setEmbeddedKeyName(String embeddedKeyName)
          Sets the text of the key name that needs to be sent.
 void setEnableSignatureConfirmation(boolean value)
          Sets whether signature confirmation should be enabled or not.
 void setEncryptionKeyIdentifier(String encryptionKeyIdentifier)
          Sets the encrypted key identifier of the current action.
 void setEncryptionKeyTransportAlgorithm(String encryptionKeyTransportAlgorithm)
          Sets the encryption key transport algorithm of the current action
 void setEncryptionParts(String encryptionParts)
          Sets the encryption parts of the current action.
 void setEncryptionPropFile(String encPropFile)
          Sets the encryption property file.
 void setEncryptionSymAlgorithm(String encryptionSymAlgorithm)
          Sets the encryption symmetric algorithm of the current action
 void setEncryptionUser(String encryptionUser)
          Sets the encryption user of the current action.
 void setOptimizeParts(String optimizePartsXPathExpr)
          Sets the XPath expression to selecte the elements with content of the current action to be MTOM optimized.
 void setPasswordCallbackClass(String passwordCallbackClass)
          Sets the name of the password callback class of the current action.
 void setPasswordType(String passwordType)
          Sets the password type of the current action
 void setPreserveOriginalEnvelope(boolean value)
          Sets whether signature confirmation should be enabled or not
 void setSamlPropFile(String samlPropFile)
          Sets the SAML property file of the current action.
 void setSignatureKeyIdentifier(String signatureKeyIdentifier)
          Sets the signatue key identifier of the current action.
 void setSignatureParts(String signatureParts)
          Sets the signature parts of the current action.
 void setSignaturePropFile(String signaturePropFile)
          Sets the signature property file of the current action.
 void setUser(String user)
          Sets the user of the current action.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OutflowConfiguration

public OutflowConfiguration()
Creates a default outflow configuration instance with an action.


OutflowConfiguration

public OutflowConfiguration(int actionCount)
Creates a new outflow configuration instance with the given number of actions.

Parameters:
actionCount -
Method Detail

getProperty

public Parameter getProperty()
Returns the configuration as an Parameter

Returns:
Returns Parameter.

nextAction

public void nextAction()
Moves to the next action. If this is called when the current action is the last action then the current action will not change.

Throws:
Exception

previousAction

public void previousAction()
Moves to previous action. If this is called when the current action is the first option then then the current action will not change.

Throws:
Exception

setActionItems

public void setActionItems(String actionItems)
Sets the action items.

Parameters:
actionItems -

getActionItems

public String getActionItems()
Returns the action items.

Returns:
Returns String.

setUser

public void setUser(String user)
Sets the user of the current action.

Parameters:
user -

getUser

public String getUser()
Returns the user of the current action.

Returns:
Returns String.

setPasswordCallbackClass

public void setPasswordCallbackClass(String passwordCallbackClass)
Sets the name of the password callback class of the current action.

Parameters:
passwordCallbackClass -

getPasswordCallbackClass

public String getPasswordCallbackClass()
Returns the name of the password callback class of the current action.

Returns:
Returns String.

setSignaturePropFile

public void setSignaturePropFile(String signaturePropFile)
Sets the signature property file of the current action.

Parameters:
signaturePropFile -

getSignaturePropFile

public String getSignaturePropFile()
Returns the signature property file of the current action.

Returns:
Returns String.

setSignatureKeyIdentifier

public void setSignatureKeyIdentifier(String signatureKeyIdentifier)
Sets the signatue key identifier of the current action.

Parameters:
signatureKeyIdentifier -

getSignatureKeyIdentifier

public String getSignatureKeyIdentifier()
Returns the signatue key identifier of the current action.

Returns:
Returns String.

setEncryptionKeyIdentifier

public void setEncryptionKeyIdentifier(String encryptionKeyIdentifier)
Sets the encrypted key identifier of the current action.

Parameters:
encryptionKeyIdentifier -

getEncryptionKeyIdentifier

public String getEncryptionKeyIdentifier()
Returns the encrypted key identifier of the current action.

Returns:
Returns String.

setEncryptionUser

public void setEncryptionUser(String encryptionUser)
Sets the encryption user of the current action.

Parameters:
encryptionUser -

getEncryptionUser

public String getEncryptionUser()
Returns the encryption user of the current action.

Returns:
Returns String.

setSignatureParts

public void setSignatureParts(String signatureParts)
Sets the signature parts of the current action.

Parameters:
signatureParts -

getSignatureParts

public String getSignatureParts()
Returns the signature parts of the current action.

Returns:
Returns String.

setEncryptionParts

public void setEncryptionParts(String encryptionParts)
Sets the encryption parts of the current action.

Parameters:
encryptionParts -

getEncryptionParts

public String getEncryptionParts()
Returns the encryption parts of the current action.

Returns:
Returns String.

setPasswordType

public void setPasswordType(String passwordType)
Sets the password type of the current action

Parameters:
passwordType -

getPasswordType

public String getPasswordType()
Returns the password type of the current action.

Returns:
Returns String.

setEncryptionSymAlgorithm

public void setEncryptionSymAlgorithm(String encryptionSymAlgorithm)
Sets the encryption symmetric algorithm of the current action

Parameters:
encryptionSymAlgorithm -

getEncryptionSymAlgorithm

public String getEncryptionSymAlgorithm()
Returns the encryption symmetric algorithm of the current action.

Returns:
Returns String.

setEncryptionKeyTransportAlgorithm

public void setEncryptionKeyTransportAlgorithm(String encryptionKeyTransportAlgorithm)
Sets the encryption key transport algorithm of the current action

Parameters:
encryptionKeyTransportAlgorithm -

getEncryptionKeyTransportAlgorithm

public String getEncryptionKeyTransportAlgorithm()
Returns the encryption key transport algorithm of the current action.

Returns:
Returns String.

setEmbeddedKeyCallbackClass

public void setEmbeddedKeyCallbackClass(String embeddedKeyCallbackClass)
Sets the embedded key callback class of the current action

Parameters:
embeddedKeyCallbackClass -

getEmbeddedKeyCallbackClass

public String getEmbeddedKeyCallbackClass()
Returns the embedded key callback class of the current action.

Returns:
Returns String.

setOptimizeParts

public void setOptimizeParts(String optimizePartsXPathExpr)
Sets the XPath expression to selecte the elements with content of the current action to be MTOM optimized.

Parameters:
optimizePartsXPathExpr -

getOptimizeParts

public String getOptimizeParts()
Returns the Path expression to selecte the elements with content of the current action to be MTOM optimized.

Returns:
Returns String.

setSamlPropFile

public void setSamlPropFile(String samlPropFile)
Sets the SAML property file of the current action.

Parameters:
samlPropFile -

getSamlPropFile

public String getSamlPropFile()
Returns the SAML property file of the current action.

Returns:
Returns String.

setEncryptionPropFile

public void setEncryptionPropFile(String encPropFile)
Sets the encryption property file.

Parameters:
encPropFile -

getEncryptionPropFile

public String getEncryptionPropFile()
Returns the encryption property file.

Returns:
Returns String.

setAddUTElements

public void setAddUTElements(String addUTElements)
Option to add additional elements in the username token element. Example: Nonce and Create elements

Parameters:
addUTElements -

getAddUTElements

public String getAddUTElements()
Returns the additional elements to be added to the username token element.


setEmbeddedKeyName

public void setEmbeddedKeyName(String embeddedKeyName)
Sets the text of the key name that needs to be sent.

Parameters:
embeddedKeyName -

getEmbeddedKeyName

public String getEmbeddedKeyName()
Returns the text of the key name that needs to be sent.

Returns:
Returns String.

setEnableSignatureConfirmation

public void setEnableSignatureConfirmation(boolean value)
Sets whether signature confirmation should be enabled or not.

Parameters:
value -

getEnableSignatureConfirmation

public String getEnableSignatureConfirmation()
Returns whether signature confirmation should be enabled or not

Returns:
Returns String.

setPreserveOriginalEnvelope

public void setPreserveOriginalEnvelope(boolean value)
Sets whether signature confirmation should be enabled or not

Parameters:
value -

getPreserveOriginalEnvelope

public String getPreserveOriginalEnvelope()
Returns whether signature confirmation should be enabled or not.

Returns:
Returns String.