com.hortonworks.registries.auth

Class KerberosLogin

java.lang.Object

com.hortonworks.registries.auth.AbstractLogin

com.hortonworks.registries.auth.KerberosLogin

All Implemented Interfaces:

Login

public class KerberosLogin
extends AbstractLogin

This class is responsible for logging in to Kerberos and refreshing credentials for login corresponding to a login context section in jaas config

Nested Class Summary

Nested classes/interfaces inherited from class com.hortonworks.registries.auth.AbstractLogin

AbstractLogin.LoginCallbackHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KINIT_CMD
static java.lang.String	MIN_TIME_BEFORE_RELOGIN
static java.lang.String	TICKET_RENEW_JITTER
static java.lang.String	TICKET_RENEW_WINDOW_FACTOR

Fields inherited from class com.hortonworks.registries.auth.AbstractLogin

JAAS_CONFIG_SYSTEM_PROPERTY, jaasConfiguration, loginContext, loginContextName

Constructor Summary

Constructors

Constructor and Description
KerberosLogin()
KerberosLogin(long tgtRenewalTimeoutMS)

Method Summary

Modifier and Type	Method and Description
void	close() Closes this instance.
void	configure(java.util.Map<java.lang.String,?> configs, java.lang.String loginContextName) Method to configure this instance with specific properties
void	configure(java.util.Map<java.lang.String,?> configs, java.lang.String loginContextName, javax.security.auth.login.Configuration jaasConfig) Method to configure this instance with specific properties
<T> T	doAction(java.security.PrivilegedAction<T> action) Execute a privileged action which respect to the login context of this instance.
javax.security.auth.login.LoginContext	login() Method called once initially to login.

Methods inherited from class java.lang.Object

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

Field Detail

KINIT_CMD

public static final java.lang.String KINIT_CMD

See Also:

Constant Field Values

TICKET_RENEW_WINDOW_FACTOR

public static final java.lang.String TICKET_RENEW_WINDOW_FACTOR

See Also:

Constant Field Values

TICKET_RENEW_JITTER

public static final java.lang.String TICKET_RENEW_JITTER

See Also:

Constant Field Values

MIN_TIME_BEFORE_RELOGIN

public static final java.lang.String MIN_TIME_BEFORE_RELOGIN

See Also:

Constant Field Values

Constructor Detail

KerberosLogin

public KerberosLogin()

KerberosLogin

public KerberosLogin(long tgtRenewalTimeoutMS)

Method Detail

configure

public void configure(java.util.Map<java.lang.String,?> configs,
                      java.lang.String loginContextName)

Method to configure this instance with specific properties

Specified by:

configure in interface Login

Overrides:

configure in class AbstractLogin

Parameters:

loginContextName - name of section in JAAS file that will be used to login. Passed as first param to javax.security.auth.login.LoginContext().

configs - configure Login with the given key-value pairs.

configure

public void configure(java.util.Map<java.lang.String,?> configs,
                      java.lang.String loginContextName,
                      javax.security.auth.login.Configuration jaasConfig)

Method to configure this instance with specific properties

Overrides:

configure in class AbstractLogin

Parameters:

loginContextName - name of section in JAAS file that will be used to login. Passed as first param to javax.security.auth.login.LoginContext().

configs - configure Login with the given key-value pairs.

login

public javax.security.auth.login.LoginContext login()
                                             throws javax.security.auth.login.LoginException

Method called once initially to login. It also starts the thread used to periodically re-login to the Kerberos Authentication Server.

Specified by:

login in interface Login

Overrides:

login in class AbstractLogin

Returns:

the login context

Throws:

javax.security.auth.login.LoginException - if login fails

close

public void close()

Description copied from interface: Login

Closes this instance.

doAction

public <T> T doAction(java.security.PrivilegedAction<T> action)
               throws javax.security.auth.login.LoginException

Description copied from interface: Login

Execute a privileged action which respect to the login context of this instance.

Specified by:

doAction in interface Login

Overrides:

doAction in class AbstractLogin

Throws:

javax.security.auth.login.LoginException