com.webmethods.portal.service.dir

Class DirectoryTools

java.lang.Object

com.webmethods.portal.service.dir.DirectoryTools

All Implemented Interfaces:

IDirConstants

public class DirectoryTools
extends Object
implements IDirConstants

Static helper functions

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	EDIT_GROUP_PAGE
protected static String	EDIT_GROUP_PAGE_PORTLET
protected static String	EDIT_ROLE_PAGE
protected static String	EDIT_ROLE_PAGE_PORTLET
protected static String	EDIT_USER_PAGE
protected static String	EDIT_USER_PAGE_PORTLET
protected static String	FABRIC_EDIT_GROUP_PAGE
protected static String	FABRIC_EDIT_GROUP_PAGE_PORTLET
protected static String	FABRIC_EDIT_ROLE_PAGE
protected static String	FABRIC_EDIT_ROLE_PAGE_PORTLET
protected static String	FABRIC_EDIT_USER_PAGE
protected static String	FABRIC_EDIT_USER_PAGE_PORTLET
protected static Map<String,Integer>	s_typeMap
protected static String	UUID_CONFIG
static Boolean	UUIDUserResolution

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, CHANGE_PASS, CHANGE_PASS_SUCCESS_ATTR, CONFIRM_PASSWORD_PARAM, 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, IS_SYSADMIN_ATTR, LAST_NAME, NEW_PASSWORD_PARAM, PAP_GROUP_TYPE_CONTAINER, PAP_PORTAL_ATTRIBUTES, PAP_ROLE_TYPE_CONTAINER, PAP_USER_TYPE_CONTAINER, PROPERTY_PASSWORDVALIDUNTIL, ROLE_CURRENT_ROLES, ROLE_DN_PREFIX, ROLE_DN_SEGMENT, ROLE_PROVIDER_CONTAINER, ROLE_RELATION, ROLE_STORAGE_CONTAINER, SECURITY_SVC_CONTAINER, SKIP_CHECK_AUTH_ATTR, SYSADMIN, 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

Constructor Summary

Constructors

Constructor and Description
DirectoryTools()

Method Summary

Modifier and Type	Method and Description
static IURI	constructDirectoryURI(IThingID dirServiceID, IThingID objectID, int type) Constructs directory URI in the form of: /directory///.
static IURI	constructDirectoryURI(IThingID dirServiceID, String dn, int type)
static IDirService	getDirectoryService(IURI principalURI)
static IDirSystemBizPolicy	getDirSystemBizPolicy()
static String	getDisplayName(IURI principalURI)
static String	getDisplayURI(IURI directoryURI, int type)
static String	getDN(IURI directoryURI) Retrieve the DN from a directory URI
static List<String>	getEmptyUUIDUsers()
static String	getEscapedRDN(String rdn) Returns the RDN after escaping the characters requiring escaping.
static IMechanicsManager	getMechanicsManager()
static IURI	getPrincipalDirectoryURI(IURI principalURI)
static String	getRDN(String dn) Retrieves the most significant attribute set in the DN.
static int	getType(IURI principalURI)
static int	getTypeID(String type) Examines the given type and returns the corresponding type ID
static String	getUID(String dn) Returns value of the most significant attribute in the DN.
static String	getUserDNFromUserUUID(String uuid, IUserService us)
static Boolean	getUUIDResolution()
static void	invalidateGroupRoleCache(IThingID thingID)
static String	normalizeDN(String dn) Removes the spaces and captialization from an LDAP distinguished-name
static IThingID	resolveUserByUUID(IInitializableUser initializableUser) Resolve the user by UUID, If user exist update the DN and return the userThingID
static List<String>	updatePrincipalUUID()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EDIT_USER_PAGE

protected static final String EDIT_USER_PAGE

See Also:

Constant Field Values

EDIT_USER_PAGE_PORTLET

protected static final String EDIT_USER_PAGE_PORTLET

See Also:

Constant Field Values

EDIT_GROUP_PAGE

protected static final String EDIT_GROUP_PAGE

See Also:

Constant Field Values

EDIT_GROUP_PAGE_PORTLET

protected static final String EDIT_GROUP_PAGE_PORTLET

See Also:

Constant Field Values

EDIT_ROLE_PAGE

protected static final String EDIT_ROLE_PAGE

See Also:

Constant Field Values

EDIT_ROLE_PAGE_PORTLET

protected static final String EDIT_ROLE_PAGE_PORTLET

See Also:

Constant Field Values

FABRIC_EDIT_USER_PAGE

protected static final String FABRIC_EDIT_USER_PAGE

See Also:

Constant Field Values

FABRIC_EDIT_USER_PAGE_PORTLET

protected static final String FABRIC_EDIT_USER_PAGE_PORTLET

See Also:

Constant Field Values

FABRIC_EDIT_GROUP_PAGE

protected static final String FABRIC_EDIT_GROUP_PAGE

See Also:

Constant Field Values

FABRIC_EDIT_GROUP_PAGE_PORTLET

protected static final String FABRIC_EDIT_GROUP_PAGE_PORTLET

See Also:

Constant Field Values

FABRIC_EDIT_ROLE_PAGE

protected static final String FABRIC_EDIT_ROLE_PAGE

See Also:

Constant Field Values

FABRIC_EDIT_ROLE_PAGE_PORTLET

protected static final String FABRIC_EDIT_ROLE_PAGE_PORTLET

See Also:

Constant Field Values

s_typeMap

protected static Map<String,Integer> s_typeMap

UUID_CONFIG

protected static final String UUID_CONFIG

See Also:

Constant Field Values

UUIDUserResolution

public static final Boolean UUIDUserResolution

Constructor Detail

DirectoryTools

public DirectoryTools()

Method Detail

getRDN

public static String getRDN(String dn)

Retrieves the most significant attribute set in the DN. For example, given the dn:

      uid=Administrator,ou=People,o=datachannel.com --> uid=Administrator
      cn=Guests,ou=People,o=datachannel.com --> cn=Guests
 

getEscapedRDN

public static String getEscapedRDN(String rdn)

Returns the RDN after escaping the characters requiring escaping.

Parameters:

rdn -

Returns:

getUID

public static String getUID(String dn)

Returns value of the most significant attribute in the DN. We assume that this is principal UID value. For example given dn: uid=portal admin,ou=People,o=webmethods.com. Result would be 'portal admin'

Parameters:

dn -

Returns:

getType

public static int getType(IURI principalURI)

getTypeID

public static int getTypeID(String type)

Examines the given type and returns the corresponding type ID

getDN

public static String getDN(IURI directoryURI)
                    throws PortalException

Retrieve the DN from a directory URI

Parameters:

directoryURI - the uri to the directory resource

Returns:

the DN from the URI, or null if no DN found

Throws:

PortalException

constructDirectoryURI

public static IURI constructDirectoryURI(IThingID dirServiceID,
                                         IThingID objectID,
                                         int type)
                                  throws PortalException

Constructs directory URI in the form of: /directory///. For example: /directory/system/user/meta/default/user/0000000001 for portal admin

Parameters:

dirServiceID -

objectID -

type -

Throws:

PortalException

constructDirectoryURI

public static IURI constructDirectoryURI(IThingID dirServiceID,
                                         String dn,
                                         int type)
                                  throws PortalException

Throws:

PortalException

getDisplayURI

public static String getDisplayURI(IURI directoryURI,
                                   int type)

normalizeDN

public static String normalizeDN(String dn)
                          throws PortalException

Removes the spaces and captialization from an LDAP distinguished-name

Parameters:

dn -

Throws:

PortalException

getDirSystemBizPolicy

public static IDirSystemBizPolicy getDirSystemBizPolicy()
                                                 throws PortalException

Throws:

PortalException

getMechanicsManager

public static IMechanicsManager getMechanicsManager()

getDisplayName

public static String getDisplayName(IURI principalURI)
                             throws PortalException

Throws:

PortalException

getPrincipalDirectoryURI

public static IURI getPrincipalDirectoryURI(IURI principalURI)
                                     throws PortalException

Throws:

PortalException

getUserDNFromUserUUID

public static String getUserDNFromUserUUID(String uuid,
                                           IUserService us)
                                    throws PortalException

Throws:

PortalException

updatePrincipalUUID

public static List<String> updatePrincipalUUID()
                                        throws PortalException

Throws:

PortalException

getEmptyUUIDUsers

public static List<String> getEmptyUUIDUsers()
                                      throws PortalException

Throws:

PortalException

resolveUserByUUID

public static IThingID resolveUserByUUID(IInitializableUser initializableUser)
                                  throws PortalException

Resolve the user by UUID, If user exist update the DN and return the userThingID

Parameters:

initializableUser -

Returns:

thingId

Throws:

PortalException

getDirectoryService

public static IDirService getDirectoryService(IURI principalURI)
                                       throws PortalException

Throws:

PortalException

invalidateGroupRoleCache

public static void invalidateGroupRoleCache(IThingID thingID)

getUUIDResolution

public static Boolean getUUIDResolution()