org.apache.nifi.authorization

Class DownloadAuthorization

java.lang.Object

org.apache.nifi.authorization.DownloadAuthorization

public class DownloadAuthorization
extends Object

Represents a decision whether authorization is granted to download content.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DownloadAuthorization.Result

Field Summary

Fields

Modifier and Type	Field and Description
private static DownloadAuthorization	APPROVED
private String	explanation
private DownloadAuthorization.Result	result

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
static DownloadAuthorization	approved()
static DownloadAuthorization	denied(String explanation) Creates a new denied DownloadAuthorization with the specified explanation.
String	getExplanation()
boolean	isApproved()

Methods inherited from class java.lang.Object

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

Field Detail

APPROVED

private static final DownloadAuthorization APPROVED

result

private final DownloadAuthorization.Result result

explanation

private final String explanation

Constructor Detail

DownloadAuthorization

private DownloadAuthorization(DownloadAuthorization.Result result,
                     String explanation)

Creates a new DownloadAuthorization with the specified result and explanation.

Parameters:

result - of the authorization

explanation - for the authorization attempt

Method Detail

isApproved

public boolean isApproved()

Returns:

Whether or not the download request is approved

getExplanation

public String getExplanation()

Returns:

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

approved

public static DownloadAuthorization approved()

Returns:

a new approved DownloadAuthorization

denied

public static DownloadAuthorization denied(String explanation)

Creates a new denied DownloadAuthorization with the specified explanation.

Parameters:

explanation - for why it was denied

Returns:

a new denied DownloadAuthorization with the specified explanation

Throws:

IllegalArgumentException - if explanation is null