com.webmethods.portal.bizPolicy.biz.dir
Interface IDirSystemBizPolicy

All Superinterfaces:
IDirConstants

public interface IDirSystemBizPolicy
extends IDirConstants

Provides system level biz policies (commands) for the directory system


Field Summary
 
Fields inherited from interface com.webmethods.portal.service.dir.IDirConstants
ADMIN_ROLE_ALIAS, ADMIN_USER_ALIAS, ATTR_DISABLED, ATTR_DN, ATTR_EMAIL, ATTR_NAME, ATTR_PASSWORD, CATEGORY_DIRECTORY, DIR_SVC_CONTAINER, DIR_SVC_TYPE_CONTAINER, DIRECTORY_ROOT, DISPLAY_URI_SEGMENT, DOMAIN_PREFIX_SEPARATOR, EVERYONE_GROUP_ALIAS, FIRST_NAME, FULL_NAME, GROUP_DN_SEGMENT, GROUP_NAME, GUEST_USER_ALIAS, LAST_NAME, PAP_GROUP_TYPE_CONTAINER, PAP_PORTAL_ATTRIBUTES, PAP_ROLE_TYPE_CONTAINER, PAP_USER_TYPE_CONTAINER, ROLE_CURRENT_ROLES, ROLE_DN_SEGMENT, ROLE_PROVIDER_CONTAINER, ROLE_RELATION, ROLE_STORAGE_CONTAINER, SECURITY_SVC_CONTAINER, SYSTEM_DIRECTORY_SERVICE_ALIAS, TYPE_GROUP, TYPE_NAME_DIRECTORY_ROOT, TYPE_NAME_GROUP, TYPE_NAME_PRINCIPAL, TYPE_NAME_ROLE, TYPE_NAME_SERVICE, TYPE_NAME_USER, TYPE_ROLE, TYPE_USER, USER_DN_SEGMENT
 
Method Summary
 IDirUser authenticateUser(IContext context, String userid, String password)
          Attempts to authenticate the user based on the credentials with any registered directory service in their configured search order.
 IThingIDList listDirectoryServices(IContext context)
          Retrieves the list of com.webmethods.portal.service.meta2.thing.IThings which are portlets which implement the com.webmethods.portal.service.dir.IDirService interface and are currently configured.
 IThingIDList listDirectoryServiceTypes(IContext context)
          Retrieves the list of com.webmethods.portal.service.meta2.thing.IThings that are portlets which implement the com.webmethods.portal.service.dir.IDirService interface.
 IThingIDList listPrincipalAttributeProviders(IContext context, int type)
          Gets all the avaliable com.webmethods.portal.service.dir.IPrincipalAttributeProvider for a specific type
 IThingIDList listRoles(IContext context)
          List the available roles
 IDirPrincipal lookupPrincipalByAlias(IContext context, 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(IContext context, String principalDN, int type)
          Attempts to lookup a principal by their dn.
 IDirPrincipal lookupPrincipalByID(IContext context, String principalID, int type)
          Attempts to lookup a principal by their id.
 IDirPrincipal lookupPrincipalByURI(IContext context, IURI principalUri)
          Attempts to lookup a principal by their dn.
 

Method Detail

authenticateUser

IDirUser authenticateUser(IContext context,
                          String userid,
                          String password)
                          throws BizException
Attempts to authenticate the user based on the credentials with any registered directory service in their configured search order.

Parameters:
context -
userid -
password -
Returns:
an instance of IDirUser which holds critical information describing the user
Throws:
BizException

listRoles

IThingIDList listRoles(IContext context)
                       throws BizException
List the available roles

Parameters:
context -
Returns:
the list of registered roles
Throws:
BizException

listDirectoryServices

IThingIDList listDirectoryServices(IContext context)
                                   throws BizException
Retrieves the list of com.webmethods.portal.service.meta2.thing.IThings which are portlets which implement the com.webmethods.portal.service.dir.IDirService interface and are currently configured.

Parameters:
context -
Returns:
list of IThingIDs
Throws:
BizException

listDirectoryServiceTypes

IThingIDList listDirectoryServiceTypes(IContext context)
                                       throws BizException
Retrieves the list of com.webmethods.portal.service.meta2.thing.IThings that are portlets which implement the com.webmethods.portal.service.dir.IDirService interface. These are default instances that are available to be published and configured, but are not currently active. Think of these as templates.

Parameters:
context -
Returns:
list of IThingIDs
Throws:
BizException

listPrincipalAttributeProviders

IThingIDList listPrincipalAttributeProviders(IContext context,
                                             int type)
                                             throws BizException
Gets all the avaliable com.webmethods.portal.service.dir.IPrincipalAttributeProvider for a specific type

Parameters:
context -
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:
BizException

lookupPrincipalByID

IDirPrincipal lookupPrincipalByID(IContext context,
                                  String principalID,
                                  int type)
                                  throws BizException
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:
context -
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:
BizException

lookupPrincipalByDN

IDirPrincipal lookupPrincipalByDN(IContext context,
                                  String principalDN,
                                  int type)
                                  throws BizException
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:
context -
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:
BizException

lookupPrincipalByURI

IDirPrincipal lookupPrincipalByURI(IContext context,
                                   IURI principalUri)
                                   throws BizException
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:
context -
principalUri -
Returns:
the found IDirPrincipal or null
Throws:
BizException

lookupPrincipalByAlias

IDirPrincipal lookupPrincipalByAlias(IContext context,
                                     String alias)
                                     throws BizException
The aliases can be one of the following:

Throws:
BizException