Package weblogic.security.principal

Class WLSAbstractPrincipal

java.lang.Object

weblogic.security.principal.WLSAbstractPrincipal

All Implemented Interfaces:

java.io.Serializable, java.security.Principal, IdentityDomainPrincipal, WLSPrincipal

Direct Known Subclasses:

IDCSAppRoleImpl, IDCSClientImpl, IDCSScopeImpl, WLSGroupImpl, WLSUserImpl

public abstract class WLSAbstractPrincipal
extends java.lang.Object
implements WLSPrincipal, IdentityDomainPrincipal

The WLSAbstractPrincipal class is a convenience abstract class that implements a principal whose name field will be signed by the weblogic.security.provider.PrincipalValidatorImpl class. To use this class, you should make the PrincipalValidatorImpl class the runtime class for your Principal Validation provider, or extend that class and make the extended class your Principal Validation provider.

Note: Use of this class is not required by WebLogic Server. It is simply a convenience class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	principalFactoryCreated

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object another)	Compares this principal to the principal in the specified object.
java.lang.String	getDn()	Gets the principal's distinguished name.
java.lang.String	getGuid()	Gets the principal's unique id.
java.lang.String	getName()	Gets the name of this principal.
byte[]	getSalt()	Gets the principal's salt.
byte[]	getSignature()	Gets the derived principal's trust signature.
byte[]	getSignedData()	Gets the derived principal's signing data, which is used to generate the trust signature.
int	hashCode()	Returns a hashcode for the name of this principal.
boolean	isEqualsCaseInsensitive()
boolean	isEqualsCompareDnAndGuid()
boolean	isPrincipalFactoryCreated()
protected void	setDn(java.lang.String dn)
void	setEqualsCaseInsensitive(boolean equalsCaseInsensitive)
void	setEqualsCompareDnAndGuid(boolean equalsCompareDnAndGuid)
protected void	setGuid(java.lang.String guid)
void	setIdentityDomain(java.lang.String identityDomain)	Sets the identity domain of this principal.
protected void	setName(java.lang.String name)	Sets the name of this principal.
void	setSalt(byte[] salt)	Sets the principal's salt.
void	setSignature(byte[] signature)	Sets the derived principal's trust signature.
java.lang.String	toString()	Returns a String representation of this principal.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

implies

Field Detail

principalFactoryCreated

protected boolean principalFactoryCreated

Method Detail

isEqualsCaseInsensitive

public boolean isEqualsCaseInsensitive()

isEqualsCompareDnAndGuid

public boolean isEqualsCompareDnAndGuid()

setEqualsCaseInsensitive

public void setEqualsCaseInsensitive(boolean equalsCaseInsensitive)

setEqualsCompareDnAndGuid

public void setEqualsCompareDnAndGuid(boolean equalsCompareDnAndGuid)

getName

public java.lang.String getName()

Gets the name of this principal.

Specified by:

getName in interface java.security.Principal

Returns:

the name of this principal, represented as a String.

See Also:

setName(java.lang.String)

setName

protected void setName(java.lang.String name)

Sets the name of this principal.

Parameters:

name - the name of this principal, represented as a String.

See Also:

getName()

equals

public boolean equals(java.lang.Object another)

Compares this principal to the principal in the specified object.

Specified by:

equals in interface java.security.Principal

Overrides:

equals in class java.lang.Object

Parameters:

another - the other principal with which to compare this principal.

Returns:

TRUE if the principal passed in matches the principal passed in, and FALSE otherwise.

toString

public java.lang.String toString()

Returns a String representation of this principal.

Specified by:

toString in interface java.security.Principal

Overrides:

toString in class java.lang.Object

Returns:

this principal, represented as a String.

hashCode

public int hashCode()

Returns a hashcode for the name of this principal.

Specified by:

hashCode in interface java.security.Principal

Overrides:

hashCode in class java.lang.Object

Returns:

the name of this principal, represented as an int.

getSignature

public byte[] getSignature()

Gets the derived principal's trust signature.

Specified by:

getSignature in interface WLSPrincipal

Returns:

the derived principal's trust signature, represented as an array of bytes.

See Also:

setSignature(byte[])

setSignature

public void setSignature(byte[] signature)

Sets the derived principal's trust signature.

Specified by:

setSignature in interface WLSPrincipal

Parameters:

signature - the derived principal's trust signsture, represented as an array of bytes.

See Also:

getSignature()

getSalt

public byte[] getSalt()

Gets the principal's salt.

Specified by:

getSalt in interface WLSPrincipal

Returns:

the principal's salt, represented as an array of bytes.

See Also:

setSalt(byte[])

setSalt

public void setSalt(byte[] salt)

Sets the principal's salt.

Parameters:

salt - the principal's salt, represented as an array of bytes.

See Also:

getSalt()

getSignedData

public byte[] getSignedData()

Gets the derived principal's signing data, which is used to generate the trust signature.

Specified by:

getSignedData in interface WLSPrincipal

Returns:

the derived principal's signing data, represented as a sequence of bytes in the platform's default charset.

getGuid

public java.lang.String getGuid()

Description copied from interface: WLSPrincipal

Gets the principal's unique id.

Specified by:

getGuid in interface WLSPrincipal

Returns:

the principal's unique id.

setGuid

protected void setGuid(java.lang.String guid)

getDn

public java.lang.String getDn()

Description copied from interface: WLSPrincipal

Gets the principal's distinguished name.

Specified by:

getDn in interface WLSPrincipal

Returns:

the principal's distinguished name.

setDn

protected void setDn(java.lang.String dn)

isPrincipalFactoryCreated

public boolean isPrincipalFactoryCreated()

setIdentityDomain

public void setIdentityDomain(java.lang.String identityDomain)

Sets the identity domain of this principal.

Parameters:

identityDomain - the identity domain of this principal, represented as a String. Set only if not previously set

See Also:

getIdentityDomain()