DefaultSubjectRoleParser (Apache CXF JavaDoc 3.1.0 API)

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

All Implemented Interfaces:

SubjectRoleParser

Direct Known Subclasses:

DefaultSAMLRoleParser
```
public class DefaultSubjectRoleParser
extends Object
implements SubjectRoleParser
```
A default implementation to extract roles from a Subject

Constructor Summary

Constructors
Constructor and Description

DefaultSubjectRoleParser()

Constructors
Constructor and Description
`DefaultSubjectRoleParser()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getRoleClassifier()`
`String`	`getRoleClassifierType()`
`Set<Principal>`	`parseRolesFromSubject(Principal principal, Subject subject)` Return the set of User/Principal roles from the Subject.
`void`	`setRoleClassifier(String roleClassifier)` Set the Subject Role Classifier to use.
`void`	`setRoleClassifierType(String roleClassifierType)` Set the Subject Role Classifier Type to use.

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

- Constructor Detail
  - DefaultSubjectRoleParser
```
public DefaultSubjectRoleParser()
```
- Method Detail
  - parseRolesFromSubject
```
public Set<Principal> parseRolesFromSubject(Principal principal,
                                   Subject subject)
```
    Return the set of User/Principal roles from the Subject.
    
    Specified by:
    
    parseRolesFromSubject in interface SubjectRoleParser
    
    Parameters:
    principal - the optional Principal
    subject - the JAAS Subject
    
    Returns:
    the set of User/Principal roles from the Subject.
  - getRoleClassifier
```
public String getRoleClassifier()
```
  - setRoleClassifier
```
public void setRoleClassifier(String roleClassifier)
```
    Set the Subject Role Classifier to use. If this value is not specified, then it tries to get roles from the supplied JAAS Subject (if not null) using the DefaultSecurityContext in cxf-rt-core. Otherwise it uses this value in combination with the SUBJECT_ROLE_CLASSIFIER_TYPE to get the roles from the Subject.
    
    Parameters:
    roleClassifier - the Subject Role Classifier to use
  - getRoleClassifierType
```
public String getRoleClassifierType()
```
  - setRoleClassifierType
```
public void setRoleClassifierType(String roleClassifierType)
```
    Set the Subject Role Classifier Type to use. Currently accepted values are "prefix" or "classname". Must be used in conjunction with the SUBJECT_ROLE_CLASSIFIER. The default value is "prefix".
    
    Parameters:
    roleClassifierType - the Subject Role Classifier Type to use

Class DefaultSubjectRoleParser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultSubjectRoleParser

Method Detail

parseRolesFromSubject

getRoleClassifier

setRoleClassifier

getRoleClassifierType

setRoleClassifierType