IDirConstants (server-common-api)

All Known Subinterfaces:

IDirSystem, IDirSystemBizPolicy

All Known Implementing Classes:

DirectoryTools
```
public interface IDirConstants
```
Common constants for directory system use

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADMIN_ROLE_ALIAS` Well known alias for admin role: "dir.admin.role"
`static String`	`ADMIN_USER_ALIAS` Well known alias for admin user: "dir.admin.user"
`static String`	`ATTR_DISABLED` Well known constant for common attribute names: 'disabled'
`static String`	`ATTR_DN` Well known constant for common attribute names: 'dn'
`static String`	`ATTR_EMAIL` Well known constant for common attribute names: 'email'
`static String`	`ATTR_NAME` Well known constant for common attribute names: 'name'
`static String`	`ATTR_PASSWORD` Well known constant for common attribute names: 'password'
`static String`	`CATEGORY_DIRECTORY`
`static String`	`CHANGE_PASS` Flag used to detect whether to render the change password screen
`static String`	`CHANGE_PASS_SUCCESS_ATTR` Request attribute used as a flag to detect whether to show a success message
`static String`	`CONFIRM_PASSWORD_PARAM` Request parameter for the new password confirmation
`static String`	`DELETED_THINGS_USER` Alias for deleted thing user.
`static String`	`DIR_SVC_CONTAINER` dir.svc.container
`static String`	`DIR_SVC_TYPE_CONTAINER` dir.svc.type.container
`static String`	`DIRECTORY_ROOT` name of the root for the directory system
`static String`	`DISPLAY_URI_SEGMENT` name of the dn uri segment
`static String`	`DOMAIN_PREFIX_SEPARATOR`
`static String`	`EVERYONE_GROUP_ALIAS` Well known alias for everyone group: "dir.everyone.group"
`static String`	`FIRST_NAME` Well known constant for common attribute names: 'firstName'
`static String`	`FULL_NAME` Well known constant for common attribute names: 'fullName'
`static String`	`GROUP_DN_SEGMENT` 'group' dn segment
`static String`	`GROUP_NAME` Well known constant for common attribute names: 'groupName'
`static String`	`GUEST_USER_ALIAS` Well known alias for guest user: "dir.guest.user"
`static String`	`IS_SYSADMIN_ATTR` Request attribute to verify whether the user sysadmin's session after it's invalidated
`static String`	`LAST_NAME` Well known constant for common attribute names: 'lastName'
`static String`	`NEW_PASSWORD_PARAM` Request parameter for the new password
`static String`	`PAP_GROUP_TYPE_CONTAINER` pap.group.type.container
`static String`	`PAP_PORTAL_ATTRIBUTES` pap.portal
`static String`	`PAP_ROLE_TYPE_CONTAINER` pap.role.type.container
`static String`	`PAP_USER_TYPE_CONTAINER` pap.user.type.container
`static String`	`PROPERTY_PASSWORDVALIDUNTIL`
`static String`	`ROLE_CURRENT_ROLES` role.provider.roles
`static String`	`ROLE_DN_PREFIX`
`static String`	`ROLE_DN_SEGMENT` 'role' dn segment
`static String`	`ROLE_PROVIDER_CONTAINER` role.provider.container
`static String`	`ROLE_RELATION` role.relation
`static String`	`ROLE_STORAGE_CONTAINER` role.provider.storage
`static String`	`SECURITY_SVC_CONTAINER` security.svc.container
`static String`	`SKIP_CHECK_AUTH_ATTR` Flag used to detect whether to skip a user's authentication
`static String`	`SYSADMIN` SysAdmin
`static String`	`SYSTEM_DIRECTORY_SERVICE_ALIAS` Well known alias for the system directory service: "system.directory.service"
`static String`	`TOTP_ADMIN_ALIAS`
`static String`	`TOTP_AUTH`
`static String`	`TOTP_CATEGORY`
`static String`	`TOTP_CREDENTIALS`
`static String`	`TOTP_PREFIX`
`static String`	`TOTP_SERVICE_TOKEN`
`static String`	`TOTP_TOKEN_NAME`
`static int`	`TYPE_GROUP` Describes what 'type' of user For use with `IDirSystem.getPrincipalAttributeProviders(int)` and many others
`static String`	`TYPE_NAME_DIRECTORY_ROOT`
`static String`	`TYPE_NAME_GROUP`
`static String`	`TYPE_NAME_PRINCIPAL`
`static String`	`TYPE_NAME_ROLE`
`static String`	`TYPE_NAME_SERVICE`
`static String`	`TYPE_NAME_USER`
`static int`	`TYPE_ROLE` Describes what 'type' of user For use with `IDirSystem.getPrincipalAttributeProviders(int)` and many others
`static int`	`TYPE_USER` Describes what 'type' of user For use with `IDirSystem.getPrincipalAttributeProviders(int)` and many others
`static String`	`USER_DN_SEGMENT` 'user' dn segment
`static String`	`USER_UUID` Well known constant for common attribute names: 'UserUUID'

- Field Detail
  - TYPE_USER
```
static final int TYPE_USER
```
    Describes what 'type' of user For use with IDirSystem.getPrincipalAttributeProviders(int) and many others
    
    See Also:
    
    Constant Field Values
  - TYPE_GROUP
```
static final int TYPE_GROUP
```
    Describes what 'type' of user For use with IDirSystem.getPrincipalAttributeProviders(int) and many others
    
    See Also:
    
    Constant Field Values
  - TYPE_ROLE
```
static final int TYPE_ROLE
```
    Describes what 'type' of user For use with IDirSystem.getPrincipalAttributeProviders(int) and many others
    
    See Also:
    
    Constant Field Values
  - ATTR_DISABLED
```
static final String ATTR_DISABLED
```
    Well known constant for common attribute names: 'disabled'
    
    See Also:
    
    Constant Field Values
  - ATTR_EMAIL
```
static final String ATTR_EMAIL
```
    Well known constant for common attribute names: 'email'
    
    See Also:
    
    Constant Field Values
  - ATTR_DN
```
static final String ATTR_DN
```
    Well known constant for common attribute names: 'dn'
    
    See Also:
    
    Constant Field Values
  - ATTR_PASSWORD
```
static final String ATTR_PASSWORD
```
    Well known constant for common attribute names: 'password'
    
    See Also:
    
    Constant Field Values
  - ATTR_NAME
```
static final String ATTR_NAME
```
    Well known constant for common attribute names: 'name'
    
    See Also:
    
    Constant Field Values
  - USER_UUID
```
static final String USER_UUID
```
    Well known constant for common attribute names: 'UserUUID'
    
    See Also:
    
    Constant Field Values
  - FIRST_NAME
```
static final String FIRST_NAME
```
    Well known constant for common attribute names: 'firstName'
    
    See Also:
    
    Constant Field Values
  - LAST_NAME
```
static final String LAST_NAME
```
    Well known constant for common attribute names: 'lastName'
    
    See Also:
    
    Constant Field Values
  - FULL_NAME
```
static final String FULL_NAME
```
    Well known constant for common attribute names: 'fullName'
    
    See Also:
    
    Constant Field Values
  - GROUP_NAME
```
static final String GROUP_NAME
```
    Well known constant for common attribute names: 'groupName'
    
    See Also:
    
    Constant Field Values
  - ADMIN_USER_ALIAS
```
static final String ADMIN_USER_ALIAS
```
    Well known alias for admin user: "dir.admin.user"
    
    See Also:
    
    IDirSystemBizPolicy.lookupPrincipalByAlias(com.webmethods.portal.bizPolicy.IContext, java.lang.String), Constant Field Values
  - EVERYONE_GROUP_ALIAS
```
static final String EVERYONE_GROUP_ALIAS
```
    Well known alias for everyone group: "dir.everyone.group"
    
    See Also:
    
    IDirSystemBizPolicy.lookupPrincipalByAlias(com.webmethods.portal.bizPolicy.IContext, java.lang.String), Constant Field Values
  - GUEST_USER_ALIAS
```
static final String GUEST_USER_ALIAS
```
    Well known alias for guest user: "dir.guest.user"
    
    See Also:
    
    IDirSystemBizPolicy.lookupPrincipalByAlias(com.webmethods.portal.bizPolicy.IContext, java.lang.String), Constant Field Values
  - ADMIN_ROLE_ALIAS
```
static final String ADMIN_ROLE_ALIAS
```
    Well known alias for admin role: "dir.admin.role"
    
    See Also:
    
    IDirSystemBizPolicy.lookupPrincipalByAlias(com.webmethods.portal.bizPolicy.IContext, java.lang.String), Constant Field Values
  - DELETED_THINGS_USER
```
static final String DELETED_THINGS_USER
```
    Alias for deleted thing user. Holds things that were owned by a now deleted user.
    
    See Also:
    
    IDirSystemBizPolicy.lookupPrincipalByAlias(com.webmethods.portal.bizPolicy.IContext, java.lang.String), Constant Field Values
  - SYSTEM_DIRECTORY_SERVICE_ALIAS
```
static final String SYSTEM_DIRECTORY_SERVICE_ALIAS
```
    Well known alias for the system directory service: "system.directory.service"
    
    See Also:
    
    Constant Field Values
  - SYSADMIN
```
static final String SYSADMIN
```
    SysAdmin
    
    See Also:
    
    Constant Field Values
  - NEW_PASSWORD_PARAM
```
static final String NEW_PASSWORD_PARAM
```
    Request parameter for the new password
    
    See Also:
    
    Constant Field Values
  - CONFIRM_PASSWORD_PARAM
```
static final String CONFIRM_PASSWORD_PARAM
```
    Request parameter for the new password confirmation
    
    See Also:
    
    Constant Field Values
  - IS_SYSADMIN_ATTR
```
static final String IS_SYSADMIN_ATTR
```
    Request attribute to verify whether the user sysadmin's session after it's invalidated
    
    See Also:
    
    Constant Field Values
  - CHANGE_PASS_SUCCESS_ATTR
```
static final String CHANGE_PASS_SUCCESS_ATTR
```
    Request attribute used as a flag to detect whether to show a success message
    
    See Also:
    
    Constant Field Values
  - SKIP_CHECK_AUTH_ATTR
```
static final String SKIP_CHECK_AUTH_ATTR
```
    Flag used to detect whether to skip a user's authentication
    
    See Also:
    
    Constant Field Values
  - CHANGE_PASS
```
static final String CHANGE_PASS
```
    Flag used to detect whether to render the change password screen
    
    See Also:
    
    Constant Field Values
  - DISPLAY_URI_SEGMENT
```
static final String DISPLAY_URI_SEGMENT
```
    name of the dn uri segment
    
    See Also:
    
    Constant Field Values
  - USER_DN_SEGMENT
```
static final String USER_DN_SEGMENT
```
    'user' dn segment
    
    See Also:
    
    Constant Field Values
  - GROUP_DN_SEGMENT
```
static final String GROUP_DN_SEGMENT
```
    'group' dn segment
    
    See Also:
    
    Constant Field Values
  - ROLE_DN_SEGMENT
```
static final String ROLE_DN_SEGMENT
```
    'role' dn segment
    
    See Also:
    
    Constant Field Values
  - ROLE_DN_PREFIX
```
static final String ROLE_DN_PREFIX
```
    See Also:
    
    Constant Field Values
  - DIRECTORY_ROOT
```
static final String DIRECTORY_ROOT
```
    name of the root for the directory system
    
    See Also:
    
    Constant Field Values
  - TYPE_NAME_DIRECTORY_ROOT
```
static final String TYPE_NAME_DIRECTORY_ROOT
```
    See Also:
    
    Constant Field Values
  - TYPE_NAME_PRINCIPAL
```
static final String TYPE_NAME_PRINCIPAL
```
    See Also:
    
    Constant Field Values
  - TYPE_NAME_USER
```
static final String TYPE_NAME_USER
```
    See Also:
    
    Constant Field Values
  - TYPE_NAME_GROUP
```
static final String TYPE_NAME_GROUP
```
    See Also:
    
    Constant Field Values
  - TYPE_NAME_ROLE
```
static final String TYPE_NAME_ROLE
```
    See Also:
    
    Constant Field Values
  - TYPE_NAME_SERVICE
```
static final String TYPE_NAME_SERVICE
```
    See Also:
    
    Constant Field Values
  - DIR_SVC_CONTAINER
```
static final String DIR_SVC_CONTAINER
```
    dir.svc.container
    
    See Also:
    
    Constant Field Values
  - DIR_SVC_TYPE_CONTAINER
```
static final String DIR_SVC_TYPE_CONTAINER
```
    dir.svc.type.container
    
    See Also:
    
    Constant Field Values
  - PAP_USER_TYPE_CONTAINER
```
static final String PAP_USER_TYPE_CONTAINER
```
    pap.user.type.container
    
    See Also:
    
    Constant Field Values
  - PAP_GROUP_TYPE_CONTAINER
```
static final String PAP_GROUP_TYPE_CONTAINER
```
    pap.group.type.container
    
    See Also:
    
    Constant Field Values
  - PAP_ROLE_TYPE_CONTAINER
```
static final String PAP_ROLE_TYPE_CONTAINER
```
    pap.role.type.container
    
    See Also:
    
    Constant Field Values
  - ROLE_PROVIDER_CONTAINER
```
static final String ROLE_PROVIDER_CONTAINER
```
    role.provider.container
    
    See Also:
    
    Constant Field Values
  - ROLE_STORAGE_CONTAINER
```
static final String ROLE_STORAGE_CONTAINER
```
    role.provider.storage
    
    See Also:
    
    Constant Field Values
  - ROLE_CURRENT_ROLES
```
static final String ROLE_CURRENT_ROLES
```
    role.provider.roles
    
    See Also:
    
    Constant Field Values
  - ROLE_RELATION
```
static final String ROLE_RELATION
```
    role.relation
    
    See Also:
    
    Constant Field Values
  - PAP_PORTAL_ATTRIBUTES
```
static final String PAP_PORTAL_ATTRIBUTES
```
    pap.portal
    
    See Also:
    
    Constant Field Values
  - SECURITY_SVC_CONTAINER
```
static final String SECURITY_SVC_CONTAINER
```
    security.svc.container
    
    See Also:
    
    Constant Field Values
  - CATEGORY_DIRECTORY
```
static final String CATEGORY_DIRECTORY
```
    See Also:
    
    Debug.getLogCategory(String), Constant Field Values
  - DOMAIN_PREFIX_SEPARATOR
```
static final String DOMAIN_PREFIX_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - PROPERTY_PASSWORDVALIDUNTIL
```
static final String PROPERTY_PASSWORDVALIDUNTIL
```
    See Also:
    
    Constant Field Values
  - TOTP_PREFIX
```
static final String TOTP_PREFIX
```
    See Also:
    
    Constant Field Values
  - TOTP_CATEGORY
```
static final String TOTP_CATEGORY
```
    See Also:
    
    Constant Field Values
  - TOTP_TOKEN_NAME
```
static final String TOTP_TOKEN_NAME
```
    See Also:
    
    Constant Field Values
  - TOTP_AUTH
```
static final String TOTP_AUTH
```
    See Also:
    
    Constant Field Values
  - TOTP_CREDENTIALS
```
static final String TOTP_CREDENTIALS
```
    See Also:
    
    Constant Field Values
  - TOTP_ADMIN_ALIAS
```
static final String TOTP_ADMIN_ALIAS
```
    See Also:
    
    Constant Field Values
  - TOTP_SERVICE_TOKEN
```
static final String TOTP_SERVICE_TOKEN
```
    See Also:
    
    Constant Field Values

Interface IDirConstants

Field Summary

Field Detail

TYPE_USER

TYPE_GROUP

TYPE_ROLE

ATTR_DISABLED

ATTR_EMAIL

ATTR_DN

ATTR_PASSWORD

ATTR_NAME

USER_UUID

FIRST_NAME

LAST_NAME

FULL_NAME

GROUP_NAME

ADMIN_USER_ALIAS

EVERYONE_GROUP_ALIAS

GUEST_USER_ALIAS

ADMIN_ROLE_ALIAS

DELETED_THINGS_USER

SYSTEM_DIRECTORY_SERVICE_ALIAS

SYSADMIN

NEW_PASSWORD_PARAM

CONFIRM_PASSWORD_PARAM

IS_SYSADMIN_ATTR

CHANGE_PASS_SUCCESS_ATTR

SKIP_CHECK_AUTH_ATTR

CHANGE_PASS

DISPLAY_URI_SEGMENT

USER_DN_SEGMENT

GROUP_DN_SEGMENT

ROLE_DN_SEGMENT

ROLE_DN_PREFIX

DIRECTORY_ROOT

TYPE_NAME_DIRECTORY_ROOT

TYPE_NAME_PRINCIPAL

TYPE_NAME_USER

TYPE_NAME_GROUP

TYPE_NAME_ROLE

TYPE_NAME_SERVICE

DIR_SVC_CONTAINER

DIR_SVC_TYPE_CONTAINER

PAP_USER_TYPE_CONTAINER

PAP_GROUP_TYPE_CONTAINER

PAP_ROLE_TYPE_CONTAINER

ROLE_PROVIDER_CONTAINER

ROLE_STORAGE_CONTAINER

ROLE_CURRENT_ROLES

ROLE_RELATION

PAP_PORTAL_ATTRIBUTES

SECURITY_SVC_CONTAINER

CATEGORY_DIRECTORY

DOMAIN_PREFIX_SEPARATOR

PROPERTY_PASSWORDVALIDUNTIL

TOTP_PREFIX

TOTP_CATEGORY

TOTP_TOKEN_NAME

TOTP_AUTH

TOTP_CREDENTIALS

TOTP_ADMIN_ALIAS

TOTP_SERVICE_TOKEN