PrincipalAuthorizeCallback (WildFly Elytron Parent 2.1.0.Final API)

java.lang.Object
- org.wildfly.security.auth.callback.PrincipalAuthorizeCallback

All Implemented Interfaces:

Callback, ExtendedCallback
```
public class PrincipalAuthorizeCallback
extends Object
implements ExtendedCallback
```
An authorization callback similar to javase AuthorizeCallback but using a generic principal.

Author:

rmartinc

Field Summary

Fields
Modifier and Type Field Description

private boolean authorized

private Principal principal

Constructor Summary

Constructors
Constructor	Description
`PrincipalAuthorizeCallback(String name)`	Creates a new instance to authorize the associated `name`.
`PrincipalAuthorizeCallback(Principal principal)`	Creates a new instance to authorize the associated `principal`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Principal`	`getPrincipal()`	Returns the `Principal`.
`boolean`	`isAuthorized()`	Indicates if the principal was successfully authorized.
`void`	`setAuthorized(boolean authorized)`	Sets whether the authorization is allowed for the principal.

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

Methods inherited from interface org.wildfly.security.auth.callback.ExtendedCallback
isOptional, needsInformation

- Field Detail
  - principal
```
private final Principal principal
```
  - authorized
```
private boolean authorized
```
- Constructor Detail
  - PrincipalAuthorizeCallback
```
public PrincipalAuthorizeCallback(String name)
```
    Creates a new instance to authorize the associated name. It will be transformed in a NamePrincipal.
    
    Parameters:
    
    name - the name to authorize
  - PrincipalAuthorizeCallback
```
public PrincipalAuthorizeCallback(Principal principal)
```
    Creates a new instance to authorize the associated principal.
    
    Parameters:
    
    principal - the principal to authorize
- Method Detail
  - isAuthorized
```
public boolean isAuthorized()
```
    Indicates if the principal was successfully authorized.
    
    Returns:
    
    true if the principal was successfully authorized. Otherwise, false
  - setAuthorized
```
public void setAuthorized(boolean authorized)
```
    Sets whether the authorization is allowed for the principal.
    
    Parameters:
    
    authorized - authorization result
  - getPrincipal
```
public Principal getPrincipal()
```
    Returns the Principal.
    
    Returns:
    
    the principal (not null)