wt.org
Class WTPrincipal

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.org.WTPrincipal

All Implemented Interfaces:

Externalizable, Serializable, Principal, AccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, wt.fc.BusinessInformation, NetFactor, ObjectMappable, Persistable, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, DisplayIdentification, wt.recent.RecentlyVisited, wt.ufid.Federatable

Direct Known Subclasses:

WTGroup, WTUser

public abstract class WTPrincipal
extends Item
implements wt.fc.BusinessInformation, wt.ufid.Federatable, Principal, wt.recent.RecentlyVisited, Externalizable

Abstract class that represents a user or a group of users.

Supported API: true

Extendable: false

See Also:

Serialized Form

Method Summary

boolean	equals(Object obj) Determines if the current principal is equal to the one passed as argument.
String	getPrincipalDisplayIdentifier() This method returns display identifier of a principal.
String	getUniqueDisplayIdentifier() The method provides one unique display format of a principal for user: Last Name, First Name (uid: orgname) or Last Name, First Name (email) for external group: Group Name (org name) for internal group: Group Name (team name) for organization: Org Name (orgid) Supported API: true

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

toString

Method Detail

equals

public boolean equals(Object obj)

Determines if the current principal is equal to the one passed as argument. Two principals are considered equal if they have the same name.

Supported API: true

Specified by:

equals in interface Principal

Parameters:

obj -

Returns:

boolean

getUniqueDisplayIdentifier

public String getUniqueDisplayIdentifier()
                                  throws WTException

The method provides one unique display format of a principal for user: Last Name, First Name (uid: orgname) or Last Name, First Name (email) for external group: Group Name (org name) for internal group: Group Name (team name) for organization: Org Name (orgid)

Supported API: true

Returns:

String

Throws:

WTException

getPrincipalDisplayIdentifier

public String getPrincipalDisplayIdentifier()
                                     throws WTException

This method returns display identifier of a principal. If it is WTUser, the fullName is returned. If it is WTGroup or WTOrganization, its name is returned.

Supported API: true

Returns:

String

Throws:

WTException