org.apache.nifi.ranger.authorization

Class RangerNiFiAuthorizer

java.lang.Object

org.apache.nifi.ranger.authorization.RangerNiFiAuthorizer

All Implemented Interfaces:

AuthorizationAuditor, Authorizer

Direct Known Subclasses:

ManagedRangerAuthorizer

public class RangerNiFiAuthorizer
extends java.lang.Object
implements Authorizer, AuthorizationAuditor

Authorizer implementation that uses Apache Ranger to make authorization decisions.

Constructor Summary

Constructors

Constructor and Description
RangerNiFiAuthorizer()

Method Summary

Modifier and Type	Method and Description
void	auditAccessAttempt(AuthorizationRequest request, AuthorizationResult result) Audits an authorization request.
AuthorizationResult	authorize(AuthorizationRequest request) Determines if the specified user/entity is authorized to access the specified resource within the given context.
protected RangerBasePluginWithPolicies	createRangerBasePlugin(java.lang.String serviceType, java.lang.String appId)
void	initialize(AuthorizerInitializationContext initializationContext) Called immediately after instance creation for implementers to perform additional setup
void	onConfigured(AuthorizerConfigurationContext configurationContext) Called to configure the Authorizer.
void	preDestruction() Called immediately before instance destruction for implementers to release resources.
void	setNiFiProperties(NiFiProperties properties)

Methods inherited from class java.lang.Object

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

Constructor Detail

RangerNiFiAuthorizer

public RangerNiFiAuthorizer()

Method Detail

initialize

public void initialize(AuthorizerInitializationContext initializationContext)
                throws AuthorizerCreationException

Description copied from interface: Authorizer

Called immediately after instance creation for implementers to perform additional setup

Specified by:

initialize in interface Authorizer

Parameters:

initializationContext - in which to initialize

Throws:

AuthorizerCreationException

onConfigured

public void onConfigured(AuthorizerConfigurationContext configurationContext)
                  throws AuthorizerCreationException

Description copied from interface: Authorizer

Called to configure the Authorizer.

Specified by:

onConfigured in interface Authorizer

Parameters:

configurationContext - at the time of configuration

Throws:

AuthorizerCreationException - for any issues configuring the provider

createRangerBasePlugin

protected RangerBasePluginWithPolicies createRangerBasePlugin(java.lang.String serviceType,
                                                              java.lang.String appId)

authorize

public AuthorizationResult authorize(AuthorizationRequest request)
                              throws AuthorizationAccessException

Description copied from interface: Authorizer

Determines if the specified user/entity is authorized to access the specified resource within the given context. These details are all contained in the AuthorizationRequest. NOTE: This method will be called often and frequently. Because of this, if the underlying implementation needs to make remote calls or expensive calculations those should probably be done asynchronously and/or cache the results.

Specified by:

authorize in interface Authorizer

Parameters:

request - The authorization request

Returns:

the authorization result

Throws:

AuthorizationAccessException - if unable to access the policies

auditAccessAttempt

public void auditAccessAttempt(AuthorizationRequest request,
                               AuthorizationResult result)

Description copied from interface: AuthorizationAuditor

Audits an authorization request. Will be invoked for any Approved or Denied results. ResourceNotFound will either re-attempt authorization using a parent resource or will generate a failure result and audit that.

Specified by:

auditAccessAttempt in interface AuthorizationAuditor

Parameters:

request - the request for authorization

result - the authorization result

preDestruction

public void preDestruction()
                    throws AuthorizerDestructionException

Description copied from interface: Authorizer

Called immediately before instance destruction for implementers to release resources.

Specified by:

preDestruction in interface Authorizer

Throws:

AuthorizerDestructionException - If pre-destruction fails.

setNiFiProperties

@AuthorizerContext
public void setNiFiProperties(NiFiProperties properties)