org.apache.nifi.security.krb

Interface KerberosUser

public interface KerberosUser

A keytab-based user that can login/logout and perform actions as the given user.

Method Summary

Modifier and Type	Method and Description
boolean	checkTGTAndRelogin() Performs a re-login if the TGT is close to expiration.
<T> T	doAs(PrivilegedAction<T> action) Executes the given action as the given user.
default <T> T	doAs(PrivilegedAction<T> action, ClassLoader contextClassLoader) Executes the given action as the given user.
<T> T	doAs(PrivilegedExceptionAction<T> action) Executes the given action as the given user.
default <T> T	doAs(PrivilegedExceptionAction<T> action, ClassLoader contextClassLoader) Executes the given action as the given user.
AppConfigurationEntry	getConfigurationEntry()
String	getPrincipal()
boolean	isLoggedIn()
void	login() Performs a login for the given user.
void	logout() Performs a logout for the given user.

Method Detail

login

void login()

Performs a login for the given user.

Throws:

KerberosLoginException - if the login fails

logout

void logout()

Performs a logout for the given user.

Throws:

KerberosLoginException - if the logout fails

doAs

<T> T doAs(PrivilegedAction<T> action)
    throws IllegalStateException

Executes the given action as the given user.

Type Parameters:

T - the type of response

Parameters:

action - the action to execute

Returns:

the result of the action

Throws:

IllegalStateException - if attempting to execute an action before performing a login

doAs

default <T> T doAs(PrivilegedAction<T> action,
                   ClassLoader contextClassLoader)
            throws IllegalStateException

Executes the given action as the given user.

Type Parameters:

T - the type of response

Parameters:

action - the action to execute

contextClassLoader - the class loader to set as the current thread's context class loader

Returns:

the result of the action

Throws:

IllegalStateException - if attempting to execute an action before performing a login

doAs

<T> T doAs(PrivilegedExceptionAction<T> action)
    throws IllegalStateException,
           PrivilegedActionException

Executes the given action as the given user.

Type Parameters:

T - the type of response

Parameters:

action - the action to execute

Returns:

the result of the action

Throws:

IllegalStateException - if attempting to execute an action before performing a login

PrivilegedActionException - if the action itself threw an exception

doAs

default <T> T doAs(PrivilegedExceptionAction<T> action,
                   ClassLoader contextClassLoader)
            throws IllegalStateException,
                   PrivilegedActionException

Executes the given action as the given user.

Type Parameters:

T - the type of response

Parameters:

action - the action to execute

contextClassLoader - the class loader to set as the current thread's context class loader

Returns:

the result of the action

Throws:

IllegalStateException - if attempting to execute an action before performing a login

PrivilegedActionException - if the action itself threw an exception

checkTGTAndRelogin

boolean checkTGTAndRelogin()

Performs a re-login if the TGT is close to expiration.

Returns:

true if a relogin was performed, false otherwise

Throws:

KerberosLoginException - if the relogin fails

isLoggedIn

boolean isLoggedIn()

Returns:

true if this user is currently logged in, false otherwise

getPrincipal

String getPrincipal()

Returns:

the principal for this user

getConfigurationEntry

AppConfigurationEntry getConfigurationEntry()

Returns:

the configuration entry used to perform the login