Package com.webmethods.portal.mech.dir

Interface IDirSystemMechanics

All Superinterfaces:

IComponent, IInitializable, IMechanics, ISystemHandler, IViewableMechanics

public interface IDirSystemMechanics
extends IViewableMechanics

Date: Aug 13, 2004

Field Summary

Fields inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

COMMENTS_LINK_TYPE, CONTENT_LINK_TYPE, DEFAULT_ORDER, DEFAULT_PAGE_SIZE, DEFAULT_SORT, DETAILS_LINK_TYPE, LARGE_ICON_TYPE, LINK_TYPE, LINK_TYPE_COMMENTS, LINK_TYPE_CONTENT, LINK_TYPE_DETAILS, LINK_TYPE_EDIT, LINK_TYPE_HELP, LINK_TYPE_HELP_MAXIMIZED, LINK_TYPE_MAXIMIZED, LINK_TYPE_MINIMIZED, LINK_TYPE_PERMISSIONS, LINK_TYPE_PORTAL_CONTENT, LINK_TYPE_PORTLET_STANDALONE, LINK_TYPE_PROPERTIES, LINK_TYPE_RESTORED, LINK_TYPE_SUBSCRIPTIONS, LINK_TYPE_THUMBNAILS, LINK_TYPE_VERSIONS, PERMISSIONS_LINK_TYPE, PORTAL_CONTENT_LINK_TYPE, PROPERTIES_LINK_TYPE, PROPERTY_LINK_TARGET, PROPERTY_OWNER_NAME, PROPERTY_PARENT_NAME, PROPERTY_TOOLTIP, REFERENCE_ICON_TYPE, SUBSCRIPTIONS_LINK_TYPE, THUMBNAIL_ICON_TYPE, THUMBNAILS_LINK_TYPE, VERSIONS_LINK_TYPE

Method Summary

Modifier and Type	Method	Description
IDirUser	authenticateUser(String userid, String password)	Attempts to authenticate the user based on the credentials with any registered directory service in their configured search order.
default IDirUser	authenticateUser(String userid, String password, String oneTimePassword)
IDirRole	getAdminRole()
IThingID	getAdminRoleID()
IDirUser	getAdminUser()
IThingID	getAdminUserID()
IDirGroup	getEveryoneGroup()
IThingID	getEveryoneGroupID()
IDirUser	getGuestUser()
IThingID	getGuestUserID()
boolean	hasAdminRole(IDirPrincipal dirPrincipal)
IThingIDList	listDirectoryServices(IThingID userID)	Retrieves the list of IThings which are portlets which implement the IDirService interface and are currently configured.
IThingIDList	listDirectoryServiceTypes()	Retrieves the list of IThings that are portlets which implement the IDirService interface.
IThingIDList	listPrincipalAttributeProviders(int type)	Gets all the avaliable IPrincipalAttributeProvider for a specific type
IThingIDList	listRoleProviders(IThingID userID)	Retrieves the list of IThings which are portlets which implement the IRoleProvider interface and are currently configured.
IThingIDList	listRoles()	List the available roles
IDirPrincipal	lookupPrincipalByAlias(String alias)	The aliases can be one of the following: ADMIN_USER_ALIAS: dir.admin.user EVERYONE_GROUP_ALIAS: dir.everyone.group GUEST_USER_ALIAS: dir.guest.user ADMIN_ROLE_ALIAS: dir.admin.role
IDirPrincipal	lookupPrincipalByDN(String principalDN, int type)	Attempts to lookup a principal by their dn.
IDirPrincipal	lookupPrincipalByID(String principalID, int type)	Attempts to lookup a principal by their id.
IDirPrincipal	lookupPrincipalByURI(IURI principalUri)	Attempts to lookup a principal by their dn.
IThingID	lookupPrincipalThingIDByAlias(String alias)	The aliases can be one of the following: ADMIN_USER_ALIAS: dir.admin.user EVERYONE_GROUP_ALIAS: dir.everyone.group GUEST_USER_ALIAS: dir.guest.user ADMIN_ROLE_ALIAS: dir.admin.role

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Methods inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

canView, checkView, createPagingCookie, fireViewEvent, getCss, getCss, getDefaultLinkType, getFormattedProperty, getHierachicalUri, getIcon, getIcon, getLink, getLink, getListProperty, getListPropertyHTML, getListPropertyJS, isEnabled, view, view

Method Details

getAdminUserID

IThingID getAdminUserID()
                 throws PortalException

Returns:

the IThingID of the admin user

Throws:

PortalException

getAdminUser

IDirUser getAdminUser()
               throws PortalException

Returns:

the IDirUser of the admin user

Throws:

PortalException

getEveryoneGroupID

IThingID getEveryoneGroupID()
                     throws PortalException

Returns:

the IThingID of the everyone group

Throws:

PortalException

getEveryoneGroup

IDirGroup getEveryoneGroup()
                    throws PortalException

Returns:

the IDirGroup of the everyone group

Throws:

PortalException

getGuestUserID

IThingID getGuestUserID()
                 throws PortalException

Returns:

the IThingID of the guest user

Throws:

PortalException

getGuestUser

IDirUser getGuestUser()
               throws PortalException

Returns:

the IDirUser of the guest user

Throws:

PortalException

getAdminRoleID

IThingID getAdminRoleID()
                 throws PortalException

Returns:

the IThingID of the admin role

Throws:

PortalException

getAdminRole

IDirRole getAdminRole()
               throws PortalException

Returns:

the IDirRole of the admin role

Throws:

PortalException

hasAdminRole

boolean hasAdminRole(IDirPrincipal dirPrincipal)
              throws PortalException

Parameters:

dirPrincipal -

Returns:

whether or not the user is a member of the admin role

Throws:

PortalException

lookupPrincipalByID

IDirPrincipal lookupPrincipalByID(String principalID,
 int type)
                           throws PortalException

Attempts to lookup a principal by their id. Delegates to the directory service in their configured search order. If found, this principal will be guaranteed to be initialized

Parameters:

principalID -

type - one of com.webmethods.portal.service.dir.IDirSystem.TYPE_USER com.webmethods.portal.service.dir.IDirSystem.TYPE_GROUP or com.webmethods.portal.service.dir.IDirSystem.TYPE_ROLE

Returns:

the found IDirPrincipal or null

Throws:

PortalException

lookupPrincipalByDN

IDirPrincipal lookupPrincipalByDN(String principalDN,
 int type)
                           throws PortalException

Attempts to lookup a principal by their dn. Delegates to the directory service in their configured search order. If found, this principal will be guaranteed to be initialized

Parameters:

principalDN -

type - one of com.webmethods.portal.service.dir.IDirSystem.TYPE_USER com.webmethods.portal.service.dir.IDirSystem.TYPE_GROUP or com.webmethods.portal.service.dir.IDirSystem.TYPE_ROLE

Returns:

the found IDirPrincipal or null

Throws:

PortalException

lookupPrincipalByURI

IDirPrincipal lookupPrincipalByURI(IURI principalUri)
                            throws PortalException

Attempts to lookup a principal by their dn. Delegates to the directory service in their configured search order. If found, this principal will be guaranteed to be initialized

Parameters:

principalUri -

Returns:

the found IDirPrincipal or null

Throws:

PortalException

lookupPrincipalByAlias

IDirPrincipal lookupPrincipalByAlias(String alias)
                              throws PortalException

The aliases can be one of the following:

• ADMIN_USER_ALIAS: dir.admin.user
• EVERYONE_GROUP_ALIAS: dir.everyone.group
• GUEST_USER_ALIAS: dir.guest.user
• ADMIN_ROLE_ALIAS: dir.admin.role

Throws:

PortalException

lookupPrincipalThingIDByAlias

IThingID lookupPrincipalThingIDByAlias(String alias)
                                throws PortalException

The aliases can be one of the following:

• ADMIN_USER_ALIAS: dir.admin.user
• EVERYONE_GROUP_ALIAS: dir.everyone.group
• GUEST_USER_ALIAS: dir.guest.user
• ADMIN_ROLE_ALIAS: dir.admin.role

Throws:

PortalException

authenticateUser

IDirUser authenticateUser(String userid,
 String password)
                   throws PortalException,
AuthenticationException

Attempts to authenticate the user based on the credentials with any registered directory service in their configured search order.

Parameters:

userid -

password -

Returns:

an instance of IDirUser which holds critical information describing the user

Throws:

AuthenticationException

PortalException

authenticateUser

default IDirUser authenticateUser(String userid,
 String password,
 String oneTimePassword)
                           throws PortalException

Parameters:

userid -

password -

oneTimePassword - Time-Based One-Time Password for two-factor identification

Returns:

an instance of IDirUser which holds critical information describing the user

Throws:

PortalException

listRoles

IThingIDList listRoles()
                throws PortalException

List the available roles

Returns:

the list of registered roles

Throws:

PortalException

listDirectoryServices

IThingIDList listDirectoryServices(IThingID userID)
                            throws PortalException

Retrieves the list of IThings which are portlets which implement the IDirService interface and are currently configured.

Parameters:

userID -

Returns:

list of IThingIDs

Throws:

PortalException

listRoleProviders

IThingIDList listRoleProviders(IThingID userID)
                        throws PortalException

Retrieves the list of IThings which are portlets which implement the IRoleProvider interface and are currently configured.

Parameters:

userID -

Returns:

list of IThingIDs

Throws:

PortalException

listDirectoryServiceTypes

IThingIDList listDirectoryServiceTypes()
                                throws PortalException

Retrieves the list of IThings that are portlets which implement the IDirService interface. These are default instances that are available to be published and configured, but are not currently active. Think of these as templates.

Returns:

list of IThingIDs

Throws:

PortalException

listPrincipalAttributeProviders

IThingIDList listPrincipalAttributeProviders(int type)
                                      throws PortalException

Gets all the avaliable IPrincipalAttributeProvider for a specific type

Parameters:

type - one of com.webmethods.portal.service.dir.IDirSystem.TYPE_USER com.webmethods.portal.service.dir.IDirSystem.TYPE_GROUP or com.webmethods.portal.service.dir.IDirSystem.TYPE_ROLE

Returns:

list of thingids

Throws:

PortalException