Login (Apache ZooKeeper 3.8.0 API)

java.lang.Object
- org.apache.zookeeper.Login

public class Login
extends java.lang.Object

Field Summary

Fields
Modifier and Type Field Description

javax.security.auth.callback.CallbackHandler callbackHandler

static java.lang.String SYSTEM_USER

Constructor Summary

Constructors
Constructor	Description
`Login(java.lang.String loginContextName, javax.security.auth.callback.CallbackHandler callbackHandler, ZKConfig zkConfig)`	LoginThread constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getLoginContextName()`
`javax.security.auth.Subject`	`getSubject()`
`java.lang.String`	`getUserName()`
`void`	`shutdown()`
`void`	`startThreadIfNeeded()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SYSTEM_USER
```
public static final java.lang.String SYSTEM_USER
```
  - callbackHandler
```
public javax.security.auth.callback.CallbackHandler callbackHandler
```
- Constructor Detail
  - Login
```
public Login(java.lang.String loginContextName,
             javax.security.auth.callback.CallbackHandler callbackHandler,
             ZKConfig zkConfig)
      throws javax.security.auth.login.LoginException
```
    LoginThread constructor. The constructor starts the thread used to periodically re-login to the Kerberos Ticket Granting Server.
    
    Parameters:
    
    loginContextName - name of section in JAAS file that will be use to login. Passed as first param to javax.security.auth.login.LoginContext().
    
    callbackHandler - Passed as second param to javax.security.auth.login.LoginContext().
    
    zkConfig - client or server configurations
    
    Throws:
    
    javax.security.auth.login.LoginException - Thrown if authentication fails.
- Method Detail
  - startThreadIfNeeded
```
public void startThreadIfNeeded()
```
  - shutdown
```
public void shutdown()
```
  - getSubject
```
public javax.security.auth.Subject getSubject()
```
  - getUserName
```
public java.lang.String getUserName()
```
  - getLoginContextName
```
public java.lang.String getLoginContextName()
```