Package se.curity.identityserver.sdk.authorization

Class AuthorizationResult<T extends Obligation>

Object

se.curity.identityserver.sdk.authorization.AuthorizationResult<T>

All Implemented Interfaces:

Closeable, AutoCloseable

@Experimental
public class AuthorizationResult<T extends Obligation>
extends Object
implements Closeable

Represents the result of an authorization policy decision performed by an AuthorizationManager

Since:

7.0

Method Summary

Modifier and Type	Method	Description
static <T extends Obligation> AuthorizationResult<T>	allow()	Creates a AuthorizationDecision.ALLOW authorization result without any obligation
static <T extends Obligation> AuthorizationResult<T>	allow(T obligation)	Creates a AuthorizationDecision.ALLOW authorization result subject to an obligation that will need to be enforced.
void	close()
static <T extends Obligation> AuthorizationResult<T>	deny()	Creates a AuthorizationDecision.DENY authorization result.
static <T extends Obligation> AuthorizationResult<T>	deny(String decisionJustification)	Creates a AuthorizationDecision.DENY authorization result.
static <T extends Obligation> AuthorizationResult<T>	fromDecision(AuthorizationDecision decision)	Creates an authorization result from a decision
AuthorizationDecision	getAuthorizationDecision()	Gets the enclosed AuthorizationDecision.
Optional<String>	getDecisionJustification()	Gets the optional decision justification.
Optional<T>	getObligation()	Gets the optional obligation, that may exist on AuthorizationDecision.ALLOW results.
static <T extends Obligation> AuthorizationResult<T>	notApplicable()	Creates a AuthorizationDecision.NOT_APPLICABLE authorization result.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

notApplicable

public static <T extends Obligation>
AuthorizationResult<T> notApplicable()

Creates a AuthorizationDecision.NOT_APPLICABLE authorization result.

Returns:

a "not-applicable" authorization result.

deny

public static <T extends Obligation>
AuthorizationResult<T> deny()

Creates a AuthorizationDecision.DENY authorization result.

Returns:

a "deny" authorization result.

deny

public static <T extends Obligation>
AuthorizationResult<T> deny(String decisionJustification)

Creates a AuthorizationDecision.DENY authorization result.

Parameters:

decisionJustification - the justification for the deny result.

Returns:

a "deny" authorization result.

allow

public static <T extends Obligation>
AuthorizationResult<T> allow()

Creates a AuthorizationDecision.ALLOW authorization result without any obligation

Returns:

an "allow" authorization result.

allow

public static <T extends Obligation>
AuthorizationResult<T> allow(T obligation)

Creates a AuthorizationDecision.ALLOW authorization result subject to an obligation that will need to be enforced.

Parameters:

obligation - the obligation that will also be enforced.

Returns:

an "allow" authorization result.

fromDecision

public static <T extends Obligation>
AuthorizationResult<T> fromDecision(AuthorizationDecision decision)

Creates an authorization result from a decision

Parameters:

decision - the decision.

Returns:

the created authorization result.

getAuthorizationDecision

public AuthorizationDecision getAuthorizationDecision()

Gets the enclosed AuthorizationDecision.

Returns:

the enclosed authorization decision

getObligation

public Optional<T> getObligation()

Gets the optional obligation, that may exist on AuthorizationDecision.ALLOW results.

Returns:

the optional obligation

getDecisionJustification

public Optional<String> getDecisionJustification()

Gets the optional decision justification.

Returns:

the optional decision justification

toString

public String toString()

Overrides:

toString in class Object

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException