UserSubject (Apache CXF JavaDoc 3.6.1 API)

java.lang.Object
- org.apache.cxf.rs.security.oauth2.common.UserSubject

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

JwtUserSubject, OidcUserSubject, SamlUserSubject
```
@Entity
public class UserSubject
extends Object
implements Serializable
```
Represents a login name which AuthorizationService may capture after the end user approved a given third party request

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`UserSubject()`
`UserSubject(String login)`
`UserSubject(String login, String id)`
`UserSubject(String login, String id, List<String> roles)`
`UserSubject(String login, List<String> roles)`
`UserSubject(UserSubject sub)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AuthenticationMethod`	`getAuthenticationMethod()`
`String`	`getId()`	Get the user's unique id
`String`	`getLogin()`	Return the user login name
`Map<String,String>`	`getProperties()`	Get the list of additional user subject properties
`List<String>`	`getRoles()`	Return the optional list of user roles which may have been captured during the authentication process
`void`	`setAuthenticationMethod(AuthenticationMethod method)`
`void`	`setId(String id)`	Set the users unique id
`void`	`setLogin(String login)`	Set the user login name
`void`	`setProperties(Map<String,String> properties)`	Set the list of additional user subject properties
`void`	`setRoles(List<String> roles)`	Set the optional list of user roles which may have been captured during the authentication process

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

Constructor Detail

UserSubject
```
public UserSubject()
```

UserSubject
```
public UserSubject(String login)
```

UserSubject

public UserSubject(String login,
                   List<String> roles)

UserSubject

public UserSubject(String login,
                   String id)

UserSubject

public UserSubject(String login,
                   String id,
                   List<String> roles)

UserSubject

public UserSubject(UserSubject sub)

Method Detail
- getLogin
```
public String getLogin()
```
  Return the user login name
  
  Returns:
  
  the login name
- setLogin
```
public void setLogin(String login)
```
  Set the user login name
  
  Parameters:
  
  login - the login name
- getRoles
```
public List<String> getRoles()
```
  Return the optional list of user roles which may have been captured during the authentication process
  
  Returns:
  
  the list of roles
- setRoles
```
public void setRoles(List<String> roles)
```
  Set the optional list of user roles which may have been captured during the authentication process
  
  Parameters:
  
  roles - the list of roles
- getProperties
```
public Map<String,String> getProperties()
```
  Get the list of additional user subject properties
  
  Returns:
  
  the list of properties
- setProperties
```
public void setProperties(Map<String,String> properties)
```
  Set the list of additional user subject properties
  
  Parameters:
  
  properties - the properties
- getId
```
public String getId()
```
  Get the user's unique id
  
  Returns:
  
  the user's id
- setId
```
public void setId(String id)
```
  Set the users unique id
  
  Parameters:
  
  id - the user's id
- getAuthenticationMethod
```
public AuthenticationMethod getAuthenticationMethod()
```
- setAuthenticationMethod
```
public void setAuthenticationMethod(AuthenticationMethod method)
```