org.apache.nifi.provenance.authorization

Interface EventAuthorizer

All Known Implementing Classes:

UserEventAuthorizer

public interface EventAuthorizer

Field Summary

Fields

Modifier and Type	Field and Description
static EventAuthorizer	DENY_ALL
static EventAuthorizer	GRANT_ALL

Method Summary

Modifier and Type	Method and Description
void	authorize(ProvenanceEventRecord event) Authorizes the current user for the specified action on the specified resource.
default java.util.List<ProvenanceEventRecord>	filterUnauthorizedEvents(java.util.List<ProvenanceEventRecord> events) Filters out any events that the user is not authorized to access
boolean	isAuthorized(ProvenanceEventRecord event) Determines whether or not the has access to the given Provenance Event.
default java.util.Set<ProvenanceEventRecord>	replaceUnauthorizedWithPlaceholders(java.util.Set<ProvenanceEventRecord> events) Returns a Set of provenance events for which any of the given events that the user does not have access to has been replaced by a placeholder event

Field Detail

GRANT_ALL

static final EventAuthorizer GRANT_ALL

DENY_ALL

static final EventAuthorizer DENY_ALL

Method Detail

isAuthorized

boolean isAuthorized(ProvenanceEventRecord event)

Determines whether or not the has access to the given Provenance Event. This method does not imply the user is directly attempting to access the specified resource. If the user is attempting a direct access use Authorizable.authorize().

Parameters:

event - the event to authorize

Returns:

is authorized

authorize

void authorize(ProvenanceEventRecord event)
        throws AccessDeniedException

Authorizes the current user for the specified action on the specified resource. This method does imply the user is directly accessing the specified resource.

Parameters:

event - the event to authorize

Throws:

AccessDeniedException - if the user is not authorized

filterUnauthorizedEvents

default java.util.List<ProvenanceEventRecord> filterUnauthorizedEvents(java.util.List<ProvenanceEventRecord> events)

Filters out any events that the user is not authorized to access

Parameters:

events - the events to filtered

Returns:

a List that contains only events from the original, for which the user has access

replaceUnauthorizedWithPlaceholders

default java.util.Set<ProvenanceEventRecord> replaceUnauthorizedWithPlaceholders(java.util.Set<ProvenanceEventRecord> events)

Returns a Set of provenance events for which any of the given events that the user does not have access to has been replaced by a placeholder event

Parameters:

events - the events to filter

Returns:

a Set containing only provenance events that the user has access to