Package org.apache.nifi.authorization

Class AuthorizationResult

java.lang.Object

org.apache.nifi.authorization.AuthorizationResult

public class AuthorizationResult
extends Object

Represents a decision whether authorization is granted.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AuthorizationResult.Result

Field Summary

Fields

Modifier and Type	Field	Description
private static final AuthorizationResult	APPROVED
private final String	explanation
private static final AuthorizationResult	RESOURCE_NOT_FOUND
private final AuthorizationResult.Result	result

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AuthorizationResult(AuthorizationResult.Result result, String explanation)	Creates a new AuthorizationResult with the specified result and explanation.

Method Summary

Modifier and Type	Method	Description
static AuthorizationResult	approved()
static AuthorizationResult	denied()	Creates a new denied AuthorizationResult with a message indicating 'Access is denied'.
static AuthorizationResult	denied(String explanation)	Creates a new denied AuthorizationResult with the specified explanation.
String	getExplanation()
AuthorizationResult.Result	getResult()
static AuthorizationResult	resourceNotFound()	Resource not found will indicate that there are no specific authorization rules for this resource.

Methods inherited from class java.lang.Object

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

Field Details

APPROVED

private static final AuthorizationResult APPROVED

RESOURCE_NOT_FOUND

private static final AuthorizationResult RESOURCE_NOT_FOUND

result

private final AuthorizationResult.Result result

explanation

private final String explanation

Constructor Details

AuthorizationResult

private AuthorizationResult(AuthorizationResult.Result result,
 String explanation)

Creates a new AuthorizationResult with the specified result and explanation.

Parameters:

result - of the authorization

explanation - for the authorization attempt

Method Details

getResult

public AuthorizationResult.Result getResult()

Returns:

Whether or not the request is approved

getExplanation

public String getExplanation()

Returns:

If the request is denied, the reason why. Null otherwise

approved

public static AuthorizationResult approved()

Returns:

a new approved AuthorizationResult

resourceNotFound

public static AuthorizationResult resourceNotFound()

Resource not found will indicate that there are no specific authorization rules for this resource.

Returns:

a new resource not found AuthorizationResult

denied

public static AuthorizationResult denied()

Creates a new denied AuthorizationResult with a message indicating 'Access is denied'.

Returns:

a new denied AuthorizationResult

denied

public static AuthorizationResult denied(String explanation)

Creates a new denied AuthorizationResult with the specified explanation.

Parameters:

explanation - for why it was denied

Returns:

a new denied AuthorizationResult with the specified explanation

Throws:

IllegalArgumentException - if explanation is null