org.apache.ambari.server.security.credential

Class PrincipalKeyCredential

java.lang.Object

org.apache.ambari.server.security.credential.PrincipalKeyCredential

All Implemented Interfaces:

Credential

public class PrincipalKeyCredential
extends Object
implements Credential

PrincipalKeyCredential encapsulates a credential consisting of a principal (or username) and a (secret) key.

Constructor Summary

Constructors

Constructor and Description
PrincipalKeyCredential() Creates an empty PrincipalKeyCredential
PrincipalKeyCredential(String principal, char[] key) Creates a new PrincipalKeyCredential
PrincipalKeyCredential(String principal, String key) Creates a new PrincipalKeyCredential

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static PrincipalKeyCredential	fromValue(String value) Renders a new PrincipalKeyCredential from its value representation
char[]	getKey()
String	getPrincipal()
int	hashCode()
static boolean	isValidValue(String value)
void	setKey(char[] key)
void	setPrincipal(String principal)
char[]	toValue() Returns a value representation of this PrincipalKeyCredential

Methods inherited from class java.lang.Object

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

Constructor Detail

PrincipalKeyCredential

public PrincipalKeyCredential()

Creates an empty PrincipalKeyCredential

PrincipalKeyCredential

public PrincipalKeyCredential(String principal,
                              String key)

Creates a new PrincipalKeyCredential

Parameters:

principal - a String containing the principal name for this credential

key - a String containing the secret key for this credential

PrincipalKeyCredential

public PrincipalKeyCredential(String principal,
                              char[] key)

Creates a new PrincipalKeyCredential

Parameters:

principal - a String containing the principal name for this credential

key - a char array containing the secret key for this credential

Method Detail

getPrincipal

public String getPrincipal()

Returns:

a String containing the principal name for this credential

setPrincipal

public void setPrincipal(String principal)

Parameters:

principal - a String containing the principal name for this credential

getKey

public char[] getKey()

Returns:

a char array containing the secret key for this credential

setKey

public void setKey(char[] key)

Parameters:

key - a char array containing the secret key for this credential

toValue

public char[] toValue()

Returns a value representation of this PrincipalKeyCredential

Specified by:

toValue in interface Credential

Returns:

a String containing the value representation of this PrincipalKeyCredential

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

fromValue

public static PrincipalKeyCredential fromValue(String value)
                                        throws InvalidCredentialValueException

Renders a new PrincipalKeyCredential from its value representation

Parameters:

value - a String containing the value representation of this PrincipalKeyCredential

Returns:

a new PrincipalKeyCredential or null if a new PrincipalKeyCredential cannot be created

Throws:

InvalidCredentialValueException

isValidValue

public static boolean isValidValue(String value)