Package org.apache.hadoop.security.alias

Class UserProvider

java.lang.Object

org.apache.hadoop.security.alias.CredentialProvider

org.apache.hadoop.security.alias.UserProvider

@Private
public class UserProvider
extends CredentialProvider

A CredentialProvider for UGIs. It uses the credentials object associated with the current user to find credentials. This provider is created using a URI of "user:///".

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserProvider.Factory

Nested classes/interfaces inherited from class org.apache.hadoop.security.alias.CredentialProvider

CredentialProvider.CredentialEntry

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SCHEME_NAME

Fields inherited from class org.apache.hadoop.security.alias.CredentialProvider

CLEAR_TEXT_FALLBACK

Method Summary

Modifier and Type	Method	Description
CredentialProvider.CredentialEntry	createCredentialEntry(java.lang.String name, char[] credential)	Create a new credential.
void	deleteCredentialEntry(java.lang.String name)	Delete the given credential.
void	flush()	Ensures that any changes to the credentials are written to persistent store.
java.util.List<java.lang.String>	getAliases()	Get the aliases for all credentials.
CredentialProvider.CredentialEntry	getCredentialEntry(java.lang.String alias)	Get the credential entry for a specific alias.
boolean	isTransient()	Indicates whether this provider represents a store that is intended for transient use - such as the UserProvider is.
java.lang.String	toString()

Methods inherited from class org.apache.hadoop.security.alias.CredentialProvider

needsPassword, noPasswordError, noPasswordWarning

Methods inherited from class java.lang.Object

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

Field Detail

SCHEME_NAME

public static final java.lang.String SCHEME_NAME

See Also:

Constant Field Values

Method Detail

isTransient

public boolean isTransient()

Description copied from class: CredentialProvider

Indicates whether this provider represents a store that is intended for transient use - such as the UserProvider is. These providers are generally used to provide job access to passwords rather than for long term storage.

Overrides:

isTransient in class CredentialProvider

Returns:

true if transient, false otherwise

getCredentialEntry

public CredentialProvider.CredentialEntry getCredentialEntry(java.lang.String alias)

Description copied from class: CredentialProvider

Get the credential entry for a specific alias.

Specified by:

getCredentialEntry in class CredentialProvider

Parameters:

alias - the name of a specific credential

Returns:

the credentialEntry

createCredentialEntry

public CredentialProvider.CredentialEntry createCredentialEntry(java.lang.String name,
                                                                char[] credential)
                                                         throws java.io.IOException

Description copied from class: CredentialProvider

Create a new credential. The given alias must not already exist.

Specified by:

createCredentialEntry in class CredentialProvider

Parameters:

name - the alias of the credential

credential - the credential value for the alias.

Returns:

CredentialEntry.

Throws:

java.io.IOException - raised on errors performing I/O.

deleteCredentialEntry

public void deleteCredentialEntry(java.lang.String name)
                           throws java.io.IOException

Description copied from class: CredentialProvider

Delete the given credential.

Specified by:

deleteCredentialEntry in class CredentialProvider

Parameters:

name - the alias of the credential to delete

Throws:

java.io.IOException - raised on errors performing I/O.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

flush

public void flush()

Description copied from class: CredentialProvider

Ensures that any changes to the credentials are written to persistent store.

Specified by:

flush in class CredentialProvider

getAliases

public java.util.List<java.lang.String> getAliases()
                                            throws java.io.IOException

Description copied from class: CredentialProvider

Get the aliases for all credentials.

Specified by:

getAliases in class CredentialProvider

Returns:

the list of alias names

Throws:

java.io.IOException - raised on errors performing I/O.