UsernameTokenValidator (Apache CXF JavaDoc 3.1.0 API)

java.lang.Object
- org.apache.cxf.sts.token.validator.UsernameTokenValidator

All Implemented Interfaces:

TokenValidator
```
public class UsernameTokenValidator
extends Object
implements TokenValidator
```
This class validates a wsse UsernameToken.

Constructor Summary

Constructors
Constructor and Description

UsernameTokenValidator()

Constructors
Constructor and Description
`UsernameTokenValidator()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canHandleToken(ReceivedToken validateTarget)` Return true if this TokenValidator implementation is capable of validating the ReceivedToken argument.
`boolean`	`canHandleToken(ReceivedToken validateTarget, String realm)` Return true if this TokenValidator implementation is capable of validating the ReceivedToken argument.
`SubjectRoleParser`	`getRoleParser()`
`void`	`setRoleParser(SubjectRoleParser roleParser)`
`void`	`setUsernameTokenRealmCodec(UsernameTokenRealmCodec usernameTokenRealmCodec)` Set the UsernameTokenRealmCodec instance to use to return a realm from a validated token
`void`	`setValidator(org.apache.wss4j.dom.validate.Validator validator)` Set the WSS4J Validator instance to use to validate the token.
`TokenValidatorResponse`	`validateToken(TokenValidatorParameters tokenParameters)` Validate a Token using the given TokenValidatorParameters.

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

- Constructor Detail
  - UsernameTokenValidator
```
public UsernameTokenValidator()
```
- Method Detail
  - setValidator
```
public void setValidator(org.apache.wss4j.dom.validate.Validator validator)
```
    Set the WSS4J Validator instance to use to validate the token.
    
    Parameters:
    validator - the WSS4J Validator instance to use to validate the token
  - setUsernameTokenRealmCodec
```
public void setUsernameTokenRealmCodec(UsernameTokenRealmCodec usernameTokenRealmCodec)
```
    Set the UsernameTokenRealmCodec instance to use to return a realm from a validated token
    
    Parameters:
    usernameTokenRealmCodec - the UsernameTokenRealmCodec instance to use to return a realm from a validated token
  - canHandleToken
```
public boolean canHandleToken(ReceivedToken validateTarget)
```
    Return true if this TokenValidator implementation is capable of validating the ReceivedToken argument.
    
    Specified by:
    
    canHandleToken in interface TokenValidator
  - canHandleToken
```
public boolean canHandleToken(ReceivedToken validateTarget,
                     String realm)
```
    Return true if this TokenValidator implementation is capable of validating the ReceivedToken argument. The realm is ignored in this token Validator.
    
    Specified by:
    
    canHandleToken in interface TokenValidator
  - validateToken
```
public TokenValidatorResponse validateToken(TokenValidatorParameters tokenParameters)
```
    Validate a Token using the given TokenValidatorParameters.
    
    Specified by:
    
    validateToken in interface TokenValidator
  - getRoleParser
```
public SubjectRoleParser getRoleParser()
```
  - setRoleParser
```
public void setRoleParser(SubjectRoleParser roleParser)
```

Class UsernameTokenValidator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UsernameTokenValidator

Method Detail

setValidator

setUsernameTokenRealmCodec

canHandleToken

canHandleToken

validateToken

getRoleParser

setRoleParser