com.esri.gpt.framework.security.principal
Class SecurityPrincipal

java.lang.Object
  com.esri.gpt.framework.security.principal.SecurityPrincipal

Direct Known Subclasses:

Group, Role, User

public class SecurityPrincipal
extends Object

Super-class for a security principal.

Constructor Summary

SecurityPrincipal()
Default constructor.

SecurityPrincipal(String key)
Construct with a supplied key.

Method Summary

String	getDistinguishedName() Gets the distinguished name for this principal.
String	getKey() Gets the key.
int	getLocalID() Gets the local ID for this principal.
String	getName() Gets the name for this principal.
void	reset() Reset.
void	setDistinguishedName(String name) Sets the distinguished name for this principal.
void	setKey(String key) Sets the key.
void	setLocalID(int localID) Sets the local ID for this principal.
void	setName(String name) Sets the name for this principal.
String	toString() Returns the string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityPrincipal

public SecurityPrincipal()

Default constructor.

SecurityPrincipal

public SecurityPrincipal(String key)

Construct with a supplied key.

Parameters:

key - the key

Method Detail

getDistinguishedName

public String getDistinguishedName()

Gets the distinguished name for this principal.
The distinguished name is typically used for an LDAP reference.

Returns:

the distinguished name

setDistinguishedName

public void setDistinguishedName(String name)

Sets the distinguished name for this principal.
The distinguished name is typically used for an LDAP reference.
The name is trimmed and stored in lower-case.

Parameters:

name - the distinguished name

getKey

public String getKey()

Gets the key.

Returns:

the key

setKey

public void setKey(String key)

Sets the key.
The key will be trimmed. A null key is treated as an empty string.

Parameters:

key - the key

getLocalID

public int getLocalID()

Gets the local ID for this principal.
The local ID is the primary key for a principal

Returns:

the local ID

setLocalID

public void setLocalID(int localID)

Sets the local ID for this principal.
The local ID is the primary key for a principal

Parameters:

localID - the local id

getName

public String getName()

Gets the name for this principal.

Returns:

the name

setName

public void setName(String name)

Sets the name for this principal.

Parameters:

name - the name

reset

public void reset()

Reset.

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Object

Returns:

the string