Skip navigation links

oracle.security.jps.service.policystore.info
Interface PrincipalEntry

All Known Subinterfaces:

AppRoleEntry, RoleMemberEntry

public interface PrincipalEntry

A representation of a principal in policystore.

Note: This interface is defined as a mechanism to exchange information only. The consumer must not implement this interface. Rather, the consumer should rely upon the existing public classes that implement this interface.

Method Summary

java.lang.String	getAppID() Returns the name of the application to which the principal is scoped to.
java.lang.String	getClassName() Return the name of the class implementing the principal.
java.lang.String	getDescription() Returns the description (if any).
java.lang.String	getDisplayName() Returns the display name
java.lang.String	getGuid() Returns the GUID (if any) associated with this principal.
java.lang.String	getName() Name of the entry.
java.security.Principal	getPrincipal() Return the underlying Java Principal object.
java.lang.String	getPrincipalName() Returns the name of the principal.
java.lang.String	getType() Return the type of the Principal.
java.lang.String	getUniqueName() Returns the name of the principal that uniquely identifies the principal in its underlying policy or identity store (i.e.

Method Detail

getType

java.lang.String getType()

Return the type of the Principal.

If the principal is a JpsPrincipalType, then the value returned is the toString() value of the PrincipalType defined by JpsPrincipalType.

For a principal entry representing a custom principal (i.e. not a JpsPrincipalType), then a null string must be returned.

Returns:

the principal type.

getClassName

java.lang.String getClassName()

Return the name of the class implementing the principal. null will be retruned if a PrincipalConstraint is present.

Returns:

the name of the class implementing the principal.

getPrincipalName

java.lang.String getPrincipalName()

Returns the name of the principal. null will be returned if a PrincipalConstraint is present.

Returns:

the name of the principal.

getPrincipal

java.security.Principal getPrincipal()

Return the underlying Java Principal object.

Returns:

the underlying Principal object.

getUniqueName

java.lang.String getUniqueName()

Returns the name of the principal that uniquely identifies the principal in its underlying policy or identity store (i.e. whereever the principal is defined).

Returns:

unique name.

getAppID

java.lang.String getAppID()

Returns the name of the application to which the principal is scoped to. This is an optional attribute and all principals may not have this value set.

Returns:

app name.

getName

java.lang.String getName()

Name of the entry.

Returns:

the name of the entry.

getGuid

java.lang.String getGuid()

Returns the GUID (if any) associated with this principal. The GUID is an immutable reference to the principal.

Returns:

guid

getDisplayName

java.lang.String getDisplayName()

Returns the display name

getDescription

java.lang.String getDescription()

Returns the description (if any).

Skip navigation links