com.attivio.sdk.security

Class AttivioPrincipalKey

java.lang.Object

com.attivio.sdk.security.AttivioPrincipalKey

All Implemented Interfaces:

Serializable, Cloneable

public class AttivioPrincipalKey
extends Object
implements Serializable, Cloneable

Represents a key that uniquely identifies a given principal (user or group).

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AttivioPrincipalKey() The default constructor.
	AttivioPrincipalKey(String realmId, String principalId) Constructs a principal key.

Method Summary

Modifier and Type	Method and Description
AttivioPrincipalKey	clone()
boolean	equals(Object obj)
String	getGuid()
String	getPrincipalId()
String	getRealmId()
int	hashCode()
void	setPrincipalId(String principalId) Sets the principal ID.
void	setRealmId(String realmId) Sets the security realm ID.
String	toString()
static AttivioPrincipalKey	valueOf(String principalGuid) Create an AttivioPrincipalKey from the String returned from getGuid().

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttivioPrincipalKey

protected AttivioPrincipalKey()

The default constructor.

AttivioPrincipalKey

public AttivioPrincipalKey(String realmId,
                           String principalId)

Constructs a principal key.

Parameters:

realmId - the security realm ID

principalId - the principal ID

Method Detail

getRealmId

public String getRealmId()

Returns:

the security realm ID

setRealmId

public void setRealmId(String realmId)

Sets the security realm ID.

Parameters:

realmId - the security realm ID; may not be null or empty

getPrincipalId

public String getPrincipalId()

Returns:

the principal ID

setPrincipalId

public void setPrincipalId(String principalId)

Sets the principal ID.

Parameters:

principalId - the principal ID; may not be null or empty

getGuid

public String getGuid()

Returns:

a globally unique principal ID based on the realm ID and the principal ID.

valueOf

public static AttivioPrincipalKey valueOf(String principalGuid)

Create an AttivioPrincipalKey from the String returned from getGuid().

Parameters:

principalGuid - - format of "realm-id:principal-id"

Returns:

the AttivioPrincipalKey

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

clone

public AttivioPrincipalKey clone()
                          throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException