com.webmethods.portal.service.dir

Interface IDirSystem

All Superinterfaces:

IComponent, IComponentProvider, IDirConstants, IInitializable, IURIResolver

public interface IDirSystem
extends IComponentProvider, IDirConstants

The IDirSystem manages the lifecycle of all IDirServices. If you need to obtain a reference or discover an IDirService then you start with the IDirSystem. The IDirSystem also extends IComponentProvider so it can participate in the IURIResolver.acquireURI(String) and the IComponentProvider.lookup(com.webmethods.portal.system.IURI) apis.

The IDirSystem uses lazy-initialization for all of its apis.

Field Summary

Fields inherited from interface com.webmethods.portal.system.IComponentProvider

ATTR_APP_NAME, ATTR_BEG_QUERY, ATTR_END_QUERY, ATTR_MID_QUERY, BIZPOLICY_MANAGER, CACHE_PROVIDER, COMMAND_PROVIDER, COMPONENTS_QUERY, INSTALL_PROVIDER, MECH_PROVIDER, METACONTEXT_PROVIDER, PHASE_PROVIDER, POLICY_PROVIDER, SEARCH_PROVIDER

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, DELETED_THINGS_USER, 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_PREFIX, ROLE_DN_SEGMENT, ROLE_PROVIDER_CONTAINER, ROLE_RELATION, ROLE_STORAGE_CONTAINER, SECURITY_SVC_CONTAINER, SYSTEM_DIRECTORY_SERVICE_ALIAS, TOTP_ADMIN_ALIAS, TOTP_AUTH, TOTP_CATEGORY, TOTP_CREDENTIALS, TOTP_PREFIX, TOTP_SERVICE_TOKEN, TOTP_TOKEN_NAME, 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, USER_UUID

Method Summary

Modifier and Type	Method and Description
void	clearCache(IURI uri) Clears any caches for this uri
default Map<String,Object>	getDirectoryServiceDefaultValues(String dirServiceXType, String subType) Returns the IDirService portlet which is associated with this IThingID
IThingID	getDirectoryServiceFromName(String name) Returns the IThingID which represents the IDirService
IDirService	getDirectoryServiceFromThingID(IThingID thingID) Returns the IDirService portlet which is associated with this IThingID
default IDirService	getDirectoryServiceFromThingID(IThingID thingID, boolean includeDisabled) Returns the IDirService portlet which is associated with this IThingID
IThingIDList	getDirectoryServices() Retrieves the list of IThings which are portlets which implement the IDirService interface and are currently configured.
default IThingIDList	getDirectoryServices(boolean includeDisabled) Retrieves the list of IThings which are portlets which implement the IDirService interface and are currently configured.
IThingIDList	getDirectoryServices(IThingID userID) Retrieves the list of IThings which are portlets which implement the IDirService interface and are currently configured.
IThingIDList	getDirectoryServices(IThingID userID, boolean filterNonEditable) Retrieves the list of IThings which are portlets which implement the IDirService interface and are currently configured, filtered by editable directory service
IPrincipalAttributeProvider	getPrincipalAttributeProvider(IThingID thingID) Get the Principal Attribute Provider
IThingIDList	getPrincipalAttributeProviders(int type) Gets all the avaliable IPrincipalAttributeProvider for a specific type
IThingIDList	getRegisteredDirectoryServiceTypes() Retrieves the list of IThings that are portlets which implement the IDirService interface.
IRoleSystem	getRoleSystem()
IThingID	getSecurityServiceFromName(String name) Returns the IThingID which represents the ISecurityService
ISecurityService	getSecurityServiceFromThingID(IThingID thingID) Returns the ISecurityService portlet which is associated with this IThingID
IThingIDList	getSecurityServices() Retrieves the list of IThings which are portlets which implement the ISecurityService interface and are currently configured.
IThingIDList	getSecurityServices(IThingID userID) Retrieves the list of IThings which are portlets which implement the ISecurityService interface and are currently configured.
IDirService	getSystemDirectoryService() Returns the internal System directory service

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

exists, getComponent, getComponent, getComponent, getComponentQueryString, getComponents, getDefaultComponent, getLogger, initDeferredWebAppComponents, lookup, registerComponent, reloadComponent, reloadComponent, unregisterComponent, upgradeComponentDataFromBootstrapComponentData

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.system.IURIResolver

acquireURI, acquireURI

Method Detail

getDirectoryServices

IThingIDList getDirectoryServices()
                           throws PortalException

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

Returns:

list of IThingIDs

Throws:

PortalException

See Also:

getDirectoryServiceFromThingID(com.webmethods.portal.service.meta2.thing.IThingID)

getDirectoryServices

default IThingIDList getDirectoryServices(boolean includeDisabled)
                                   throws PortalException

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

Parameters:

includeDisabled - - include the services which are disabled

Returns:

list of IThingIDs

Throws:

PortalException

See Also:

getDirectoryServiceFromThingID(com.webmethods.portal.service.meta2.thing.IThingID)

getDirectoryServices

IThingIDList getDirectoryServices(IThingID userID)
                           throws PortalException

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

Parameters:

userID - filtered for the current user

Returns:

list of IThingIDs

Throws:

PortalException

See Also:

getDirectoryServiceFromThingID(com.webmethods.portal.service.meta2.thing.IThingID)

getDirectoryServices

IThingIDList getDirectoryServices(IThingID userID,
                                  boolean filterNonEditable)
                           throws PortalException

Retrieves the list of IThings which are portlets which implement the IDirService interface and are currently configured, filtered by editable directory service

Parameters:

userID - filtered for the current user

filterNonEditable - only include editable directory services

Returns:

list of IThingIDs

Throws:

PortalException

See Also:

getDirectoryServiceFromThingID(com.webmethods.portal.service.meta2.thing.IThingID)

getRegisteredDirectoryServiceTypes

IThingIDList getRegisteredDirectoryServiceTypes()
                                         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

See Also:

getDirectoryServiceFromThingID(com.webmethods.portal.service.meta2.thing.IThingID)

getDirectoryServiceFromName

IThingID getDirectoryServiceFromName(String name)
                              throws PortalException

Returns the IThingID which represents the IDirService

Parameters:

name - of the service

Returns:

the IThingID associated with the portlet that implements an IDirService

Throws:

PortalException

See Also:

getDirectoryServiceFromThingID(com.webmethods.portal.service.meta2.thing.IThingID)

getDirectoryServiceFromThingID

default IDirService getDirectoryServiceFromThingID(IThingID thingID,
                                                   boolean includeDisabled)
                                            throws PortalException

Returns the IDirService portlet which is associated with this IThingID

Parameters:

thingID -

includeDisabled - - return the service even if it is disabled

Returns:

an IDirService

Throws:

PortalException

getDirectoryServiceFromThingID

IDirService getDirectoryServiceFromThingID(IThingID thingID)
                                    throws PortalException

Returns the IDirService portlet which is associated with this IThingID

Parameters:

thingID -

Returns:

an IDirService

Throws:

PortalException

getDirectoryServiceDefaultValues

default Map<String,Object> getDirectoryServiceDefaultValues(String dirServiceXType,
                                                            String subType)
                                                     throws PortalException

Returns the IDirService portlet which is associated with this IThingID

Parameters:

dirServiceXType - - valid values are "wm_xt_ldapdirsvc", "wm_xt_extdirsvc" , "wm_xt_dbdirsvc"

subType - - optional(only used for LDAP type) valid values are "adsi", "adam"

Returns:

an {Map} containing all the default keys and their default values for the particular dir service type

Throws:

PortalException

getSystemDirectoryService

IDirService getSystemDirectoryService()
                               throws PortalException

Returns the internal System directory service

Throws:

PortalException

getPrincipalAttributeProviders

IThingIDList getPrincipalAttributeProviders(int type)
                                     throws PortalException

Gets all the avaliable IPrincipalAttributeProvider for a specific type

Parameters:

type - either IDirConstants.TYPE_USER IDirConstants.TYPE_GROUP or IDirConstants.TYPE_ROLE

Returns:

a list of thingids

Throws:

PortalException

getPrincipalAttributeProvider

IPrincipalAttributeProvider getPrincipalAttributeProvider(IThingID thingID)
                                                   throws PortalException

Get the Principal Attribute Provider

Parameters:

thingID -

Returns:

the principal Attribute provider

Throws:

PortalException

getSecurityServices

IThingIDList getSecurityServices()
                          throws PortalException

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

Returns:

list of IThingIDs

Throws:

PortalException

See Also:

getSecurityServiceFromThingID(com.webmethods.portal.service.meta2.thing.IThingID)

getSecurityServices

IThingIDList getSecurityServices(IThingID userID)
                          throws PortalException

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

Parameters:

userID - filtered for the current user

Returns:

list of IThingIDs

Throws:

PortalException

See Also:

getSecurityServiceFromThingID(com.webmethods.portal.service.meta2.thing.IThingID)

getSecurityServiceFromName

IThingID getSecurityServiceFromName(String name)
                             throws PortalException

Returns the IThingID which represents the ISecurityService

Parameters:

name - of the service

Returns:

the IThingID associated with the portlet that implements an ISecurityService

Throws:

PortalException

getSecurityServiceFromThingID

ISecurityService getSecurityServiceFromThingID(IThingID thingID)
                                        throws PortalException

Returns the ISecurityService portlet which is associated with this IThingID

Parameters:

thingID -

Returns:

an ISecurityService

Throws:

PortalException

getRoleSystem

IRoleSystem getRoleSystem()

Returns:

the Directory System's role system

See Also:

IRoleSystem

clearCache

void clearCache(IURI uri)
         throws PortalException

Clears any caches for this uri

Throws:

PortalException