AbstractSupportingTokenPolicyValidator (Apache CXF Runtime WS Security 3.0.3 API)

java.lang.Object
- org.apache.cxf.ws.security.wss4j.policyvalidators.AbstractTokenPolicyValidator
- - org.apache.cxf.ws.security.wss4j.policyvalidators.AbstractSupportingTokenPolicyValidator

All Implemented Interfaces:

SupportingTokenPolicyValidator

Direct Known Subclasses:

ConcreteSupportingTokenPolicyValidator, EncryptedTokenPolicyValidator, EndorsingEncryptedTokenPolicyValidator, EndorsingTokenPolicyValidator, SignedEncryptedTokenPolicyValidator, SignedEndorsingEncryptedTokenPolicyValidator, SignedEndorsingTokenPolicyValidator, SignedTokenPolicyValidator
```
public abstract class AbstractSupportingTokenPolicyValidator
extends AbstractTokenPolicyValidator
implements SupportingTokenPolicyValidator
```
A base class to use to validate various SupportingToken policies.

Constructor Summary

Constructors
Constructor and Description

AbstractSupportingTokenPolicyValidator()

Constructors
Constructor and Description
`AbstractSupportingTokenPolicyValidator()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`assertSecurePartsIfTokenNotRequired(org.apache.wss4j.policy.model.AbstractSecurityAssertion securedPart, String localName, org.apache.cxf.ws.policy.AssertionInfoMap aim)`
`protected void`	`assertSecurePartsIfTokenNotRequired(org.apache.wss4j.policy.model.SupportingTokens supportingToken, org.apache.cxf.ws.policy.AssertionInfoMap aim)`
`protected boolean`	`processKerberosTokens()` Process Kerberos Tokens.
`protected boolean`	`processKeyValueTokens()` Process KeyValue Tokens.
`protected boolean`	`processSAMLTokens()` Process SAML Tokens.
`protected boolean`	`processSCTokens()` Process Security Context Tokens.
`protected boolean`	`processUsernameTokens()` Process UsernameTokens.
`protected boolean`	`processX509Tokens()` Process X509 Tokens.
`void`	`setDerived(boolean derived)`
`void`	`setEncrypted(boolean encrypted)`
`void`	`setEncryptedElements(org.apache.wss4j.policy.model.EncryptedElements encryptedElements)`
`void`	`setEncryptedParts(org.apache.wss4j.policy.model.EncryptedParts encryptedParts)`
`void`	`setEncryptedResults(List<org.apache.wss4j.dom.WSSecurityEngineResult> encryptedResults)`
`void`	`setEndorsed(boolean endorsed)`
`void`	`setMessage(org.apache.cxf.message.Message msg)`
`void`	`setResults(List<org.apache.wss4j.dom.WSSecurityEngineResult> results)`
`void`	`setSAMLTokenResults(List<org.apache.wss4j.dom.WSSecurityEngineResult> samlResultsList)` Set the list of SAMLToken results
`void`	`setSigned(boolean signed)`
`void`	`setSignedElements(org.apache.wss4j.policy.model.SignedElements signedElements)`
`void`	`setSignedParts(org.apache.wss4j.policy.model.SignedParts signedParts)`
`void`	`setSignedResults(List<org.apache.wss4j.dom.WSSecurityEngineResult> signedResults)`
`void`	`setTimestamp(Element timestamp)`
`void`	`setTimestampElement(Element timestampElement)` Set the Timestamp element
`void`	`setUsernameTokenResults(List<org.apache.wss4j.dom.WSSecurityEngineResult> utResultsList, boolean valUsernameToken)` Set the list of UsernameToken results
`void`	`setUtResults(List<org.apache.wss4j.dom.WSSecurityEngineResult> utResults)`
`void`	`setValidateUsernameToken(boolean validateUsernameToken)`

Methods inherited from class org.apache.cxf.ws.security.wss4j.policyvalidators.AbstractTokenPolicyValidator
assertPolicy, assertPolicy, getAllAssertionsByLocalname, isTokenRequired

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.cxf.ws.security.wss4j.policyvalidators.SupportingTokenPolicyValidator
validatePolicy

Constructor Detail
- AbstractSupportingTokenPolicyValidator
```
public AbstractSupportingTokenPolicyValidator()
```

Method Detail

setUsernameTokenResults

public void setUsernameTokenResults(List<org.apache.wss4j.dom.WSSecurityEngineResult> utResultsList,
                           boolean valUsernameToken)

Set the list of UsernameToken results

Specified by:: setUsernameTokenResults in interface SupportingTokenPolicyValidator

setSAMLTokenResults
```
public void setSAMLTokenResults(List<org.apache.wss4j.dom.WSSecurityEngineResult> samlResultsList)
```
Set the list of SAMLToken results

Specified by:

setSAMLTokenResults in interface SupportingTokenPolicyValidator

setTimestampElement
```
public void setTimestampElement(Element timestampElement)
```
Set the Timestamp element

Specified by:

setTimestampElement in interface SupportingTokenPolicyValidator

setMessage

public void setMessage(org.apache.cxf.message.Message msg)

setResults

public void setResults(List<org.apache.wss4j.dom.WSSecurityEngineResult> results)

setSignedResults

public void setSignedResults(List<org.apache.wss4j.dom.WSSecurityEngineResult> signedResults)

setEncryptedResults

public void setEncryptedResults(List<org.apache.wss4j.dom.WSSecurityEngineResult> encryptedResults)

setSigned

public void setSigned(boolean signed)

setEncrypted

public void setEncrypted(boolean encrypted)

setDerived

public void setDerived(boolean derived)

setEndorsed

public void setEndorsed(boolean endorsed)

processUsernameTokens
```
protected boolean processUsernameTokens()
```
Process UsernameTokens.

processSAMLTokens
```
protected boolean processSAMLTokens()
```
Process SAML Tokens. Only signed results are supported.

processKerberosTokens
```
protected boolean processKerberosTokens()
```
Process Kerberos Tokens.

processX509Tokens
```
protected boolean processX509Tokens()
```
Process X509 Tokens.

processKeyValueTokens
```
protected boolean processKeyValueTokens()
```
Process KeyValue Tokens.

processSCTokens
```
protected boolean processSCTokens()
```
Process Security Context Tokens.

setUtResults

public void setUtResults(List<org.apache.wss4j.dom.WSSecurityEngineResult> utResults)

setValidateUsernameToken

public void setValidateUsernameToken(boolean validateUsernameToken)

setTimestamp

public void setTimestamp(Element timestamp)

setSignedElements

public void setSignedElements(org.apache.wss4j.policy.model.SignedElements signedElements)

setEncryptedElements

public void setEncryptedElements(org.apache.wss4j.policy.model.EncryptedElements encryptedElements)

setSignedParts

public void setSignedParts(org.apache.wss4j.policy.model.SignedParts signedParts)

setEncryptedParts

public void setEncryptedParts(org.apache.wss4j.policy.model.EncryptedParts encryptedParts)

assertSecurePartsIfTokenNotRequired

protected void assertSecurePartsIfTokenNotRequired(org.apache.wss4j.policy.model.SupportingTokens supportingToken,
                                       org.apache.cxf.ws.policy.AssertionInfoMap aim)

assertSecurePartsIfTokenNotRequired

protected void assertSecurePartsIfTokenNotRequired(org.apache.wss4j.policy.model.AbstractSecurityAssertion securedPart,
                                       String localName,
                                       org.apache.cxf.ws.policy.AssertionInfoMap aim)

Class AbstractSupportingTokenPolicyValidator

Constructor Summary

Method Summary

Methods inherited from class org.apache.cxf.ws.security.wss4j.policyvalidators.AbstractTokenPolicyValidator

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.cxf.ws.security.wss4j.policyvalidators.SupportingTokenPolicyValidator

Constructor Detail

AbstractSupportingTokenPolicyValidator

Method Detail

setUsernameTokenResults

setSAMLTokenResults

setTimestampElement

setMessage

setResults

setSignedResults

setEncryptedResults

setSigned

setEncrypted

setDerived

setEndorsed

processUsernameTokens

processSAMLTokens

processKerberosTokens

processX509Tokens

processKeyValueTokens

processSCTokens

setUtResults

setValidateUsernameToken

setTimestamp

setSignedElements

setEncryptedElements

setSignedParts

setEncryptedParts

assertSecurePartsIfTokenNotRequired

assertSecurePartsIfTokenNotRequired