com.softwareag.security.jaas.principals

Class AbstractSagPrincipal

java.lang.Object

com.softwareag.security.jaas.principals.AbstractSagPrincipal

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SagUserPrincipal

public abstract class AbstractSagPrincipal
extends java.lang.Object
implements java.io.Serializable

The base class for all the principal's implementations. Should be extended by every new implementation. This class implements SagPrincipal and Serializable.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractSagPrincipal()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Compares this object with the specified object.
java.lang.String	getDomain() Returns the domain of this principal.
java.lang.String	getName() Returns the name of this principal.
java.lang.String	getPropertyAttribute(java.lang.String aKey) Gets the property attribute that corresponds with the specified key.
java.util.Enumeration	getPropertyKeys() Gets all property keys in Set.
java.lang.String	getQualifiedName() Returns the qualified name of the principal.
abstract java.lang.String	getType() Gets the type of the principals.
int	hashCode() Returns a hash code value for the object.
boolean	isPropertyWritable() Indicates whether the properties of this principal can be written to a persistent store.
void	setDomain(java.lang.String aDomain) Sets the domain of the principal.
void	setName(java.lang.String aName) Sets the name of the principal.
void	setProperties(java.util.Properties properties) Sets the properties.
void	setProperty(java.lang.String aKey, java.lang.String aValue) Sets a property.
java.lang.String	toString() String representation of a principal.
void	writeProperties() Can be overwritten by subclasses to write the properties to a persistent store.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractSagPrincipal

public AbstractSagPrincipal()

Method Detail

getName

public java.lang.String getName()

Returns the name of this principal.

Returns:

A String that contains the name of the principal.

setName

public void setName(java.lang.String aName)

Sets the name of the principal. The name can only be set once. If you attempt to set it again, you will receive an IllegalArgumentException. The name can contain the domain name in the domain\name format, but the recommended practice is to use setDomain().

Parameters:

aName - The name of the principal.

Throws:

java.lang.IllegalArgumentException - If you try to overwrite the name.

getDomain

public java.lang.String getDomain()

Returns the domain of this principal.

Returns:

A String that contains the domain of this principal.

setDomain

public void setDomain(java.lang.String aDomain)

Sets the domain of the principal.

Parameters:

aDomain - A String that contains the domain of the principal.

getQualifiedName

public java.lang.String getQualifiedName()

Returns the qualified name of the principal. This consists of a concatenation of the domain, the DOMAIN_SEPARATOR, and the name.

Returns:

A String that contains the qualified name of the principal.

getPropertyAttribute

public java.lang.String getPropertyAttribute(java.lang.String aKey)

Gets the property attribute that corresponds with the specified key.

Parameters:

aKey - The key for which the given property attribute corresponds.

Returns:

A String that contains the value of the property attribute.

getPropertyKeys

public java.util.Enumeration getPropertyKeys()

Gets all property keys in Set.

Returns:

All keys from Set.

setProperties

public void setProperties(java.util.Properties properties)

Sets the properties.

Parameters:

properties - The properties to be set.

setProperty

public void setProperty(java.lang.String aKey,
                        java.lang.String aValue)

Sets a property.

Note: This property could be volatile if the properties are not writable for this type of principal.

Parameters:

aKey - The key for the property.

aValue - The value of the property.

getType

public abstract java.lang.String getType()

Gets the type of the principals. This should be overridden.

Returns:

A String that contains the type of the principals.

isPropertyWritable

public boolean isPropertyWritable()

Indicates whether the properties of this principal can be written to a persistent store.

Returns:

A boolean that indicates whether the properties of this principal can be written to a persistent store. The default value is false, meaning that the properties cannot be written to the store.

writeProperties

public void writeProperties()
                     throws SagGeneralSecurityException

Can be overwritten by subclasses to write the properties to a persistent store.

Throws:

UnsupportedOperationException - object unless overwritten.

SagGeneralSecurityException

equals

public boolean equals(java.lang.Object object)

Compares this object with the specified object.

Overrides:

equals in class java.lang.Object

Returns:

True if the specified object is an instance of the same class and has the same name as this object.

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

String representation of a principal.

Overrides:

toString in class java.lang.Object

Returns:

A String that represents the principal.