org.jboss.as.controller.access

Class AuthorizationResult

java.lang.Object

org.jboss.as.controller.access.AuthorizationResult

public class AuthorizationResult
extends Object

The result of an access control decision.

Author:

Brian Stansberry (c) 2013 Red Hat Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthorizationResult.Decision

Field Summary

Fields

Modifier and Type	Field and Description
static AuthorizationResult	PERMITTED

Constructor Summary

Constructors

Constructor and Description
AuthorizationResult(AuthorizationResult.Decision decision) Creates an authorization result with no explanation.
AuthorizationResult(AuthorizationResult.Decision decision, org.jboss.dmr.ModelNode explanation) Creates an authorization result with an optional explanation.

Method Summary

Modifier and Type	Method and Description
void	failIfDenied(org.jboss.dmr.ModelNode operation) Utility method to throw a standard failure if getDecision() is AuthorizationResult.Decision.DENY.
void	failIfDenied(org.jboss.dmr.ModelNode operation, PathAddress targetAddress) Utility method to throw a standard failure if getDecision() is AuthorizationResult.Decision.DENY.
AuthorizationResult.Decision	getDecision() Gets the authorization decision.
org.jboss.dmr.ModelNode	getExplanation() Gets the explanation for the authorization decision.

Methods inherited from class java.lang.Object

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

Field Detail

PERMITTED

public static final AuthorizationResult PERMITTED

Constructor Detail

AuthorizationResult

public AuthorizationResult(AuthorizationResult.Decision decision)

Creates an authorization result with no explanation.

Parameters:

decision - the authorization decision. Cannot be null

AuthorizationResult

public AuthorizationResult(AuthorizationResult.Decision decision,
                           org.jboss.dmr.ModelNode explanation)

Creates an authorization result with an optional explanation.

Parameters:

decision - the authorization decision. Cannot be null

explanation - the explanation for the decision. May be null

Method Detail

getDecision

public AuthorizationResult.Decision getDecision()

Gets the authorization decision.

Returns:

the decision. Will not be null

getExplanation

public org.jboss.dmr.ModelNode getExplanation()

Gets the explanation for the authorization decision. Will be an undefined node if no explanation was passed to the constructor.

Returns:

the explanation, an immutable model node. Will not be null, but may be an undefined node

failIfDenied

public void failIfDenied(org.jboss.dmr.ModelNode operation)
                  throws OperationFailedException

Utility method to throw a standard failure if getDecision() is AuthorizationResult.Decision.DENY.

This variant extracts the target address from the address field in the operation param and then calls the overloaded variant.

Parameters:

operation - the operation the triggered this authorization result. Cannot be null

Throws:

OperationFailedException - if getDecision() is AuthorizationResult.Decision.DENY

failIfDenied

public void failIfDenied(org.jboss.dmr.ModelNode operation,
                         PathAddress targetAddress)
                  throws OperationFailedException

Utility method to throw a standard failure if getDecision() is AuthorizationResult.Decision.DENY.

Parameters:

operation - the operation the triggered this authorization result. Cannot be null

targetAddress - the target address of the request that triggered this authorization result. Cannot be null

Throws:

OperationFailedException - if getDecision() is AuthorizationResult.Decision.DENY