org.apache.ws.security
Class WSSecurityEngineResult

java.lang.Object
  extended byjava.util.AbstractMap
      extended byjava.util.HashMap
          extended byorg.apache.ws.security.WSSecurityEngineResult
All Implemented Interfaces:
java.lang.Cloneable, java.util.Map, java.io.Serializable

public class WSSecurityEngineResult
extends java.util.HashMap

Author:
Werner Dittmann (Werner.Dittmann@t-online.de)
See Also:
Serialized Form

Field Summary
static java.lang.String TAG_ACTION
          Tag denoting the cryptographic operation performed The value under this tag is of type java.lang.Integer
static java.lang.String TAG_BINARY_SECURITY_TOKEN
          Tag denoting the X.509 certificate found, if applicable.
static java.lang.String TAG_DATA_REF_URIS
          Tag denoting references to a List of Data ref URIs.
static java.lang.String TAG_DECRYPTED_KEY
          Tag denoting a reference to the decrypted key The value under this tag is of type byte[].
static java.lang.Object TAG_ENCRYPTED_EPHEMERAL_KEY
          Tag denoting the encrypted key bytes The value under this tag is a byte array
static java.lang.String TAG_ENCRYPTED_KEY_ID
          Tag denoting references to the encrypted key id.
static java.lang.String TAG_PRINCIPAL
          Tag denoting the security principal found, if applicable.
static java.lang.String TAG_PROTECTED_ELEMENTS
          Tag denoting references to the DOM elements that have been cryptographically protected.
static java.lang.String TAG_SAML_ASSERTION
          Tag denoting the SAML Assertion found, if applicable.
static java.lang.String TAG_SECURITY_CONTEXT_TOKEN
          Tag denoting references to the DOM elements that have been cryptographically protected.
static java.lang.String TAG_SIGNATURE_CONFIRMATION
          Tag denoting the signature confirmation of a signed element, if applicable.
static java.lang.String TAG_SIGNATURE_VALUE
          Tag denoting the signature value of a signed element, if applicable.
static java.lang.String TAG_SIGNED_ELEMENT_IDS
          Tag denoting the wsu:Ids of signed elements, if applicable.
static java.lang.String TAG_TIMESTAMP
          Tag denoting the timestamp found, if applicable.
static java.lang.String TAG_X509_CERTIFICATE
          Tag denoting the X.509 certificate found, if applicable.
static java.lang.String TAG_X509_CERTIFICATES
          Tag denoting the X.509 certificate chain found, if applicable.
 
Constructor Summary
WSSecurityEngineResult(int act, java.util.ArrayList dataRefUris)
           
WSSecurityEngineResult(int act, BinarySecurity token, java.security.cert.X509Certificate[] certificates)
           
WSSecurityEngineResult(int act, byte[] decryptedKey, byte[] encryptedKeyBytes, java.lang.String encyptedKeyId, java.util.List dataRefUris)
           
WSSecurityEngineResult(int act, java.security.Principal princ, java.security.cert.X509Certificate certificate, java.util.Set elements, byte[] sv)
           
WSSecurityEngineResult(int act, java.security.Principal princ, java.security.cert.X509Certificate certificate, java.util.Set elements, java.util.Set protectedElements, byte[] sv)
           
WSSecurityEngineResult(int act, org.opensaml.SAMLAssertion ass)
           
WSSecurityEngineResult(int act, SecurityContextToken sct)
           
WSSecurityEngineResult(int act, SignatureConfirmation sc)
           
WSSecurityEngineResult(int act, Timestamp tstamp)
           
 
Method Summary
 int getAction()
          Deprecated. use ((java.lang.Integer) #get(#TAG_ACTION)).intValue() instead
 org.opensaml.SAMLAssertion getAssertion()
          Deprecated. use (SAMLAssertion) #get(#TAG_SAML_ASSERTION) instead
 java.security.cert.X509Certificate getCertificate()
          Deprecated. use (X509Certificate) #get(#TAG_X509_CERTIFICATE) instead
 java.util.ArrayList getDataRefUris()
          Deprecated. use #get(#TAG_DATA_REF_URIS) instead
 byte[] getDecryptedKey()
          Deprecated. use #get(#TAG_DECRYPTED_KEY) instead
 java.lang.String getEncryptedKeyId()
          Deprecated. use #get(#TAG_ENCRYPTED_KEY) instead
 java.security.Principal getPrincipal()
          Deprecated. use (Principal) #get(#TAG_PRINCIPAL) instead
 SecurityContextToken getSecurityContextToken()
          Deprecated. use #get(#TAG_SECURITY_CONTEXT_TOKEN) instead
 SignatureConfirmation getSigConf()
          Deprecated. use (SignatureConfirmation) #get(#TAG_SIGNATURE_CONFIRMATION) instead
 byte[] getSignatureValue()
          Deprecated. use (byte[]) #get(#TAG_SIGNATURE_VALUE) instead
 java.util.Set getSignedElements()
          Deprecated. use (java.util.Set) #get(#TAG_SIGNED_ELEMENT_IDS) instead
 Timestamp getTimestamp()
          Deprecated. use (Timestamp) #get(#TAG_TIMESTAMP) instead
 void setSignatureValue(byte[] signatureValue)
          Deprecated. use put(#TAG_SIGNATURE_VALUE, signatureValue) instead
 
Methods inherited from class java.util.HashMap
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from class java.util.AbstractMap
equals, hashCode, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Field Detail

TAG_ACTION

public static final java.lang.String TAG_ACTION
Tag denoting the cryptographic operation performed The value under this tag is of type java.lang.Integer

See Also:
Constant Field Values

TAG_PRINCIPAL

public static final java.lang.String TAG_PRINCIPAL
Tag denoting the security principal found, if applicable. The value under this tag is of type java.security.Principal.

See Also:
Constant Field Values

TAG_X509_CERTIFICATE

public static final java.lang.String TAG_X509_CERTIFICATE
Tag denoting the X.509 certificate found, if applicable. The value under this tag is of type java.security.cert.X509Certificate.

See Also:
Constant Field Values

TAG_SAML_ASSERTION

public static final java.lang.String TAG_SAML_ASSERTION
Tag denoting the SAML Assertion found, if applicable. The value under this tag is of type org.opensaml.SAMLAssertion.

See Also:
Constant Field Values

TAG_TIMESTAMP

public static final java.lang.String TAG_TIMESTAMP
Tag denoting the timestamp found, if applicable. The value under this tag is of type org.apache.ws.security.message.token.Timestamp.

See Also:
Constant Field Values

TAG_SIGNED_ELEMENT_IDS

public static final java.lang.String TAG_SIGNED_ELEMENT_IDS
Tag denoting the wsu:Ids of signed elements, if applicable. The value under this tag is of type java.util.Set, where each element of the set is of type java.lang.String.

See Also:
Constant Field Values

TAG_SIGNATURE_VALUE

public static final java.lang.String TAG_SIGNATURE_VALUE
Tag denoting the signature value of a signed element, if applicable. The value under this tag is of type byte[].

See Also:
Constant Field Values

TAG_SIGNATURE_CONFIRMATION

public static final java.lang.String TAG_SIGNATURE_CONFIRMATION
Tag denoting the signature confirmation of a signed element, if applicable. The value under this tag is of type org.apache.ws.security.message.token.SignatureConfirmation.

See Also:
Constant Field Values

TAG_PROTECTED_ELEMENTS

public static final java.lang.String TAG_PROTECTED_ELEMENTS
Tag denoting references to the DOM elements that have been cryptographically protected. The value under this tag is of type java.util.Set, where each element in the set is of type org.w3c.dom.Element.

See Also:
Constant Field Values

TAG_SECURITY_CONTEXT_TOKEN

public static final java.lang.String TAG_SECURITY_CONTEXT_TOKEN
Tag denoting references to the DOM elements that have been cryptographically protected. The value under this tag is of type SecurityContextToken.

See Also:
Constant Field Values

TAG_DECRYPTED_KEY

public static final java.lang.String TAG_DECRYPTED_KEY
Tag denoting a reference to the decrypted key The value under this tag is of type byte[].

See Also:
Constant Field Values

TAG_ENCRYPTED_KEY_ID

public static final java.lang.String TAG_ENCRYPTED_KEY_ID
Tag denoting references to the encrypted key id. The value under this tag is of type String.

See Also:
Constant Field Values

TAG_DATA_REF_URIS

public static final java.lang.String TAG_DATA_REF_URIS
Tag denoting references to a List of Data ref URIs. The value under this tag is of type List.

See Also:
Constant Field Values

TAG_X509_CERTIFICATES

public static final java.lang.String TAG_X509_CERTIFICATES
Tag denoting the X.509 certificate chain found, if applicable. The value under this tag is of type java.security.cert.X509Certificate[].

See Also:
Constant Field Values

TAG_BINARY_SECURITY_TOKEN

public static final java.lang.String TAG_BINARY_SECURITY_TOKEN
Tag denoting the X.509 certificate found, if applicable. The value under this tag is of type java.security.cert.X509Certificate.

See Also:
Constant Field Values

TAG_ENCRYPTED_EPHEMERAL_KEY

public static final java.lang.Object TAG_ENCRYPTED_EPHEMERAL_KEY
Tag denoting the encrypted key bytes The value under this tag is a byte array

Constructor Detail

WSSecurityEngineResult

public WSSecurityEngineResult(int act,
                              org.opensaml.SAMLAssertion ass)

WSSecurityEngineResult

public WSSecurityEngineResult(int act,
                              java.security.Principal princ,
                              java.security.cert.X509Certificate certificate,
                              java.util.Set elements,
                              byte[] sv)

WSSecurityEngineResult

public WSSecurityEngineResult(int act,
                              java.security.Principal princ,
                              java.security.cert.X509Certificate certificate,
                              java.util.Set elements,
                              java.util.Set protectedElements,
                              byte[] sv)

WSSecurityEngineResult

public WSSecurityEngineResult(int act,
                              byte[] decryptedKey,
                              byte[] encryptedKeyBytes,
                              java.lang.String encyptedKeyId,
                              java.util.List dataRefUris)

WSSecurityEngineResult

public WSSecurityEngineResult(int act,
                              java.util.ArrayList dataRefUris)

WSSecurityEngineResult

public WSSecurityEngineResult(int act,
                              Timestamp tstamp)

WSSecurityEngineResult

public WSSecurityEngineResult(int act,
                              SecurityContextToken sct)

WSSecurityEngineResult

public WSSecurityEngineResult(int act,
                              SignatureConfirmation sc)

WSSecurityEngineResult

public WSSecurityEngineResult(int act,
                              BinarySecurity token,
                              java.security.cert.X509Certificate[] certificates)
Method Detail

getAction

public int getAction()
Deprecated. use ((java.lang.Integer) #get(#TAG_ACTION)).intValue() instead

Returns:
the actions vector. These actions were performed by the the security engine.

getPrincipal

public java.security.Principal getPrincipal()
Deprecated. use (Principal) #get(#TAG_PRINCIPAL) instead

Returns:
the principals found if UsernameToken or Signature processing were done

getCertificate

public java.security.cert.X509Certificate getCertificate()
Deprecated. use (X509Certificate) #get(#TAG_X509_CERTIFICATE) instead

Returns:
the Certificate found if Signature processing were done

getAssertion

public org.opensaml.SAMLAssertion getAssertion()
Deprecated. use (SAMLAssertion) #get(#TAG_SAML_ASSERTION) instead

Returns:
Returns the assertion.

getTimestamp

public Timestamp getTimestamp()
Deprecated. use (Timestamp) #get(#TAG_TIMESTAMP) instead

Returns:
the timestamp found

getSignedElements

public java.util.Set getSignedElements()
Deprecated. use (java.util.Set) #get(#TAG_SIGNED_ELEMENT_IDS) instead

Returns:
Returns the signedElements.

getSignatureValue

public byte[] getSignatureValue()
Deprecated. use (byte[]) #get(#TAG_SIGNATURE_VALUE) instead

Returns:
Returns the signatureValue.

getSigConf

public SignatureConfirmation getSigConf()
Deprecated. use (SignatureConfirmation) #get(#TAG_SIGNATURE_CONFIRMATION) instead

Returns:
Returns the sigConf.

setSignatureValue

public void setSignatureValue(byte[] signatureValue)
Deprecated. use put(#TAG_SIGNATURE_VALUE, signatureValue) instead

Parameters:
signatureValue - The signatureValue to set.

getSecurityContextToken

public SecurityContextToken getSecurityContextToken()
Deprecated. use #get(#TAG_SECURITY_CONTEXT_TOKEN) instead

Returns:
the security context token acquired off the message

getDecryptedKey

public byte[] getDecryptedKey()
Deprecated. use #get(#TAG_DECRYPTED_KEY) instead

Returns:
the decrypted key

getEncryptedKeyId

public java.lang.String getEncryptedKeyId()
Deprecated. use #get(#TAG_ENCRYPTED_KEY) instead

Returns:
the encrypted key id

getDataRefUris

public java.util.ArrayList getDataRefUris()
Deprecated. use #get(#TAG_DATA_REF_URIS) instead

Returns:
the list of data ref URIs


Copyright © 2004-2008 The Apache Software Foundation. All Rights Reserved.