com.webmethods.portal.service.dir

Interface IDirPrincipal

All Superinterfaces:

IView, Serializable

All Known Subinterfaces:

IDirGroup, IDirRole, IDirUser

public interface IDirPrincipal
extends IView

An IDirPrincipal will expose a common set of attributes as well as any registered namespaces exposed by any registered IPrincipalAttributeProfiles for this type

Field Summary

Fields inherited from interface com.webmethods.portal.service.view.IView

PROP_DESCRIPTION, PROP_NAME, PROP_TYPE, PROP_URI

Method Summary

Modifier and Type	Method and Description
IThingID	getDirectoryPrincipalID() get the IThingID associated with this IDir Principal.
String	getDirectoryServiceName() The principal's directory service name
IThingID	getDirectoryServiceThingID() get the IThingID for the IDirService associated with this principal
IURI	getDirectoryURI() The directory uri differs from what is returned by IView.getURI().
String	getDN() The principal's dn
String	getEmail() Get the email attribute for this principal
String	getName() Get the name of this directory principal, meaning the identifying attribute.
int	getType()
default boolean	isDirectoryServiceEnabled() Get the directoryServiceEnabled attribute for this principal
default boolean	isInitialized()

Methods inherited from interface com.webmethods.portal.service.view.IView

getProperties, getProperty, getPropertyNames, getURI

Method Detail

getDirectoryURI

IURI getDirectoryURI()
              throws PortalException

The directory uri differs from what is returned by IView.getURI(). The directory uri has the principal's dn encoded into it, where the other uri has the metadata service's thingid encoded into it.

Returns:

Throws:

PortalException

getDirectoryPrincipalID

IThingID getDirectoryPrincipalID()
                          throws PortalException

get the IThingID associated with this IDir Principal. Note, this may return null, if the user hasn't yet been initialized by the metadata store. In that case you should call IDirServiceBizPolicy.initializePrincipal(com.webmethods.portal.bizPolicy.IContext, com.webmethods.portal.system.IURI)

Returns:

thing id of this principal

Throws:

PortalException

getDirectoryServiceThingID

IThingID getDirectoryServiceThingID()
                             throws PortalException

get the IThingID for the IDirService associated with this principal

Returns:

thingid (or null for Roles) for this principal

Throws:

PortalException

getDirectoryServiceName

String getDirectoryServiceName()
                        throws PortalException

The principal's directory service name

Returns:

the principal's directory service name

Throws:

PortalException

getDN

String getDN()
      throws PortalException

The principal's dn

Returns:

the principal's dn

Throws:

PortalException

getType

int getType()
     throws PortalException

Returns:

a IDirConstants.TYPE_USER or IDirConstants.TYPE_GROUP or IDirConstants.TYPE_ROLE

Throws:

PortalException

getName

String getName()
        throws PortalException

Get the name of this directory principal, meaning the identifying attribute. No assumption should be made about which attribute is returned

Returns:

a readable name for this directory principal

Throws:

PortalException

getEmail

String getEmail()
         throws PortalException

Get the email attribute for this principal

Returns:

the value of the email attribute, or null if no value exists

Throws:

PortalException

isDirectoryServiceEnabled

default boolean isDirectoryServiceEnabled()
                                   throws PortalException

Get the directoryServiceEnabled attribute for this principal

Returns:

if the directory service is enabled or not

Throws:

PortalException

isInitialized

default boolean isInitialized()
                       throws PortalException

Throws:

PortalException