WSSecurityEngineResult (Red Hat JBoss Enterprise Application Platform 7.1.0.GA public API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap<String,Object>
  - - org.apache.wss4j.dom.WSSecurityEngineResult
    - - org.apache.wss4j.dom.engine.WSSecurityEngineResult

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>
```
public class WSSecurityEngineResult
extends WSSecurityEngineResult
```
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`TAG_ACTION` Tag denoting the cryptographic operation performed The value under this tag is of type java.lang.Integer
`static String`	`TAG_BINARY_SECURITY_TOKEN` Tag denoting the BinarySecurityToken found, if applicable.
`static String`	`TAG_CANONICALIZATION_METHOD` Tag denoting the algorithm that was used to do canonicalization The value under this tag is of type String.
`static String`	`TAG_DATA_REF_URIS` Tag denoting references to a List of Data ref URIs.
`static String`	`TAG_DELEGATION_CREDENTIAL` Tag denoting a delegation credential found, if applicable.
`static String`	`TAG_DERIVED_KEY_TOKEN` Tag denoting a DerivedKeyToken object
`static String`	`TAG_ENCRYPTED_EPHEMERAL_KEY` Tag denoting the encrypted key bytes The value under this tag is a byte array
`static String`	`TAG_ENCRYPTED_KEY_TRANSPORT_METHOD` Tag denoting the encrypted key transport algorithm.
`static String`	`TAG_ID` The (wsu) Id of the token corresponding to this result.
`static String`	`TAG_PRINCIPAL` Tag denoting the security principal found, if applicable.
`static String`	`TAG_PUBLIC_KEY` Tag denoting a PublicKey associated with this token
`static String`	`TAG_SAML_ASSERTION` Tag denoting the SAML Assertion found, if applicable.
`static String`	`TAG_SECRET` Tag denoting a byte[] secret associated with this token
`static String`	`TAG_SECURITY_CONTEXT_TOKEN` Tag denoting references to the DOM elements that have been cryptographically protected.
`static String`	`TAG_SIGNATURE_CONFIRMATION` Tag denoting the signature confirmation of a signed element, if applicable.
`static String`	`TAG_SIGNATURE_METHOD` Tag denoting the algorithm that was used to sign the message The value under this tag is of type String.
`static String`	`TAG_SIGNATURE_VALUE` Tag denoting the signature value of a signed element, if applicable.
`static String`	`TAG_SUBJECT` Tag denoting the security subject found, if applicable.
`static String`	`TAG_TIMESTAMP` Tag denoting the timestamp found, if applicable.
`static String`	`TAG_TOKEN_ELEMENT` Tag denoting the DOM Element of the processed token (if a token has been processed).
`static String`	`TAG_TRANSFORMED_TOKEN` Tag denoting a Transformed Token.
`static String`	`TAG_USERNAME_TOKEN` Tag denoting a UsernameToken object
`static String`	`TAG_VALIDATED_TOKEN` Tag denoting that the TAG_*_TOKEN result has been validated by a Validator implementation.
`static String`	`TAG_X509_CERTIFICATE` Tag denoting the X.509 certificate found, if applicable.
`static String`	`TAG_X509_CERTIFICATES` Tag denoting the X.509 certificate chain found, if applicable.
`static String`	`TAG_X509_REFERENCE_TYPE` Tag denoting how the X.509 certificate (chain) was referenced, if applicable.

Constructor Summary

Constructors
Constructor and Description
`WSSecurityEngineResult(int act)`
`WSSecurityEngineResult(int act, BinarySecurity token, X509Certificate[] certs)`
`WSSecurityEngineResult(int act, byte[] decryptedKey, byte[] encryptedKeyBytes, List<WSDataRef> dataRefUris)`
`WSSecurityEngineResult(int act, byte[] decryptedKey, byte[] encryptedKeyBytes, List<WSDataRef> dataRefUris, X509Certificate[] certs)`
`WSSecurityEngineResult(int act, List<WSDataRef> dataRefUris)`
`WSSecurityEngineResult(int act, Principal princ, X509Certificate[] certs, byte[] sv)`
`WSSecurityEngineResult(int act, Principal princ, X509Certificate[] certs, List<WSDataRef> dataRefs, byte[] sv)`
`WSSecurityEngineResult(int act, SamlAssertionWrapper ass)`
`WSSecurityEngineResult(int act, SecurityContextToken sct)`
`WSSecurityEngineResult(int act, SignatureConfirmation sc)`
`WSSecurityEngineResult(int act, Timestamp tstamp)`
`WSSecurityEngineResult(int act, UsernameToken usernameToken)`
`WSSecurityEngineResult(int act, UsernameToken usernameToken, Principal principal)`

Method Summary
- Methods inherited from class java.util.HashMap
  clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, 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_SAML_ASSERTION
```
public static final String TAG_SAML_ASSERTION
```
    Tag denoting the SAML Assertion found, if applicable. The value under this tag is of type SamlAssertionWrapper.
    
    See Also:
    
    Constant Field Values
  - TAG_TIMESTAMP
```
public static final String TAG_TIMESTAMP
```
    Tag denoting the timestamp found, if applicable. The value under this tag is of type org.apache.wss4j.dom.message.token.Timestamp.
    
    See Also:
    
    Constant Field Values
  - TAG_SECURITY_CONTEXT_TOKEN
```
public static final 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_USERNAME_TOKEN
```
public static final String TAG_USERNAME_TOKEN
```
    Tag denoting a UsernameToken object
    
    See Also:
    
    Constant Field Values
  - TAG_DERIVED_KEY_TOKEN
```
public static final String TAG_DERIVED_KEY_TOKEN
```
    Tag denoting a DerivedKeyToken object
    
    See Also:
    
    Constant Field Values
  - TAG_SIGNATURE_CONFIRMATION
```
public static final 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.wss4j.dom.message.token.SignatureConfirmation.
    
    See Also:
    
    Constant Field Values
  - TAG_BINARY_SECURITY_TOKEN
```
public static final String TAG_BINARY_SECURITY_TOKEN
```
    Tag denoting the BinarySecurityToken found, if applicable. The value under this tag is of type BinarySecurity.
    
    See Also:
    
    Constant Field Values
  - TAG_TRANSFORMED_TOKEN
```
public static final String TAG_TRANSFORMED_TOKEN
```
    Tag denoting a Transformed Token. For certain tokens, the Validator may return an SamlAssertionWrapper instance which corresponds to a transformed version of the initial token. For example, a Username Token credential might be validated by an STS and transformed into a SAML Assertion. This tag then holds the transformed SamlAssertionWrapper instance, as a component of the Result corresponding to the Username Token. The value under this tag is of type SamlAssertionWrapper.
    
    See Also:
    
    Constant Field Values
  - TAG_VALIDATED_TOKEN
```
public static final String TAG_VALIDATED_TOKEN
```
    Tag denoting that the TAG_*_TOKEN result has been validated by a Validator implementation. Some of the processors do not have a default validator implementation, and so this is not set. Note that this is set for the NoOpValidator if it is configured. The value under this tag is a Boolean instance.
    
    See Also:
    
    Constant Field Values
  - TAG_TOKEN_ELEMENT
```
public static final String TAG_TOKEN_ELEMENT
```
    Tag denoting the DOM Element of the processed token (if a token has been processed). The value under this tag is of type org.w3c.dom.Element
    
    See Also:
    
    Constant Field Values
  - TAG_X509_CERTIFICATE
```
public static final 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_SIGNATURE_VALUE
```
public static final 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_X509_CERTIFICATES
```
public static final 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_X509_REFERENCE_TYPE
```
public static final String TAG_X509_REFERENCE_TYPE
```
    Tag denoting how the X.509 certificate (chain) was referenced, if applicable. The value under this tag is of type STRParser.REFERENCE_TYPE.
    
    See Also:
    
    Constant Field Values
  - TAG_ENCRYPTED_EPHEMERAL_KEY
```
public static final String TAG_ENCRYPTED_EPHEMERAL_KEY
```
    Tag denoting the encrypted key bytes The value under this tag is a byte array
    
    See Also:
    
    Constant Field Values
  - TAG_SECRET
```
public static final String TAG_SECRET
```
    Tag denoting a byte[] secret associated with this token
    
    See Also:
    
    Constant Field Values
  - TAG_PUBLIC_KEY
```
public static final String TAG_PUBLIC_KEY
```
    Tag denoting a PublicKey associated with this token
    
    See Also:
    
    Constant Field Values
  - TAG_ACTION
```
public static final 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 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_SUBJECT
```
public static final String TAG_SUBJECT
```
    Tag denoting the security subject found, if applicable. The value under this tag is of type javax.security.auth.Subject.
    
    See Also:
    
    Constant Field Values
  - TAG_DATA_REF_URIS
```
public static final 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_ENCRYPTED_KEY_TRANSPORT_METHOD
```
public static final String TAG_ENCRYPTED_KEY_TRANSPORT_METHOD
```
    Tag denoting the encrypted key transport algorithm. The value under this tag is of type String.
    
    See Also:
    
    Constant Field Values
  - TAG_SIGNATURE_METHOD
```
public static final String TAG_SIGNATURE_METHOD
```
    Tag denoting the algorithm that was used to sign the message The value under this tag is of type String.
    
    See Also:
    
    Constant Field Values
  - TAG_CANONICALIZATION_METHOD
```
public static final String TAG_CANONICALIZATION_METHOD
```
    Tag denoting the algorithm that was used to do canonicalization The value under this tag is of type String.
    
    See Also:
    
    Constant Field Values
  - TAG_DELEGATION_CREDENTIAL
```
public static final String TAG_DELEGATION_CREDENTIAL
```
    Tag denoting a delegation credential found, if applicable. For Kerberos (if delegation is enabled), the value under this tag is of type GSSCredential
    
    See Also:
    
    Constant Field Values
  - TAG_ID
```
public static final String TAG_ID
```
    The (wsu) Id of the token corresponding to this result.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WSSecurityEngineResult
```
public WSSecurityEngineResult(int act)
```
  - WSSecurityEngineResult
```
public WSSecurityEngineResult(int act,
                              SamlAssertionWrapper ass)
```
  - WSSecurityEngineResult
```
public WSSecurityEngineResult(int act,
                              Principal princ,
                              X509Certificate[] certs,
                              byte[] sv)
```
  - WSSecurityEngineResult
```
public WSSecurityEngineResult(int act,
                              Principal princ,
                              X509Certificate[] certs,
                              List<WSDataRef> dataRefs,
                              byte[] sv)
```
  - WSSecurityEngineResult
```
public WSSecurityEngineResult(int act,
                              byte[] decryptedKey,
                              byte[] encryptedKeyBytes,
                              List<WSDataRef> dataRefUris)
```
  - WSSecurityEngineResult
```
public WSSecurityEngineResult(int act,
                              byte[] decryptedKey,
                              byte[] encryptedKeyBytes,
                              List<WSDataRef> dataRefUris,
                              X509Certificate[] certs)
```
  - WSSecurityEngineResult
```
public WSSecurityEngineResult(int act,
                              List<WSDataRef> 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,
                              UsernameToken usernameToken)
```
  - WSSecurityEngineResult
```
public WSSecurityEngineResult(int act,
                              UsernameToken usernameToken,
                              Principal principal)
```
  - WSSecurityEngineResult
```
public WSSecurityEngineResult(int act,
                              BinarySecurity token,
                              X509Certificate[] certs)
```

Class WSSecurityEngineResult

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

TAG_SAML_ASSERTION

TAG_TIMESTAMP

TAG_SECURITY_CONTEXT_TOKEN

TAG_USERNAME_TOKEN

TAG_DERIVED_KEY_TOKEN

TAG_SIGNATURE_CONFIRMATION

TAG_BINARY_SECURITY_TOKEN

TAG_TRANSFORMED_TOKEN

TAG_VALIDATED_TOKEN

TAG_TOKEN_ELEMENT

TAG_X509_CERTIFICATE

TAG_SIGNATURE_VALUE

TAG_X509_CERTIFICATES

TAG_X509_REFERENCE_TYPE

TAG_ENCRYPTED_EPHEMERAL_KEY

TAG_SECRET

TAG_PUBLIC_KEY

TAG_ACTION

TAG_PRINCIPAL

TAG_SUBJECT

TAG_DATA_REF_URIS

TAG_ENCRYPTED_KEY_TRANSPORT_METHOD

TAG_SIGNATURE_METHOD

TAG_CANONICALIZATION_METHOD

TAG_DELEGATION_CREDENTIAL

TAG_ID

Constructor Detail

WSSecurityEngineResult

WSSecurityEngineResult

WSSecurityEngineResult

WSSecurityEngineResult

WSSecurityEngineResult

WSSecurityEngineResult

WSSecurityEngineResult

WSSecurityEngineResult

WSSecurityEngineResult

WSSecurityEngineResult

WSSecurityEngineResult

WSSecurityEngineResult

WSSecurityEngineResult