DirProperties (Oracle WebCenter Sites Java API Reference)

java.lang.Object
- com.openmarket.directory.DirProperties

```
public class DirProperties
extends Object
```
Defines the read-only property names used by the Directory subsystem. Also provides fundamental methods for retrieving the property values, including default values.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`attrCn` The name of the 'commonname' attribute.
`static String`	`attrLogin` The name of the 'loginid' attribute.
`static String`	`attrMemberof` The name of the 'memberof' attribute specifying the user attribute defining the groups for the user, or blank if user membership is determined from the uniquemember attribute on the group.
`static String`	`attrObjectclass` The name of the 'objectclass' attribute.
`static String`	`attrPassword` The name of the 'password' attribute.
`static String`	`attrUniquemember` The name of the 'uniquemember' attribute of a typeGroup used to specify members in a group.
`static String`	`attrUsername` The name of the 'username' attribute.
`static String`	`baseDN` Distinguished name for root to use by default for searching and for prepending to names for attribute values that require a DN type.
`static String`	`classAttribute` Name of concrete class to implement interface Attribute
`static String`	`classAttributes` Name of concrete class to implement Attributes
`static String`	`classIDir` Name of concrete class to implement interface IDir
`static String`	`classIFactory` Name of concrete class to implement interface IFactory
`static String`	`classIName` Name of concrete class to implement interface IName
`static String`	`classIUserDir` Name of concrete class to implement interface IUserDir
`static String`	`classJNDIName` Name of concrete class to implement com.openmarket.directory.jndi.NameWrapper.
`static String`	`cleanDNs`
`static String`	`defaultGroupAttrs` Set of attribute name/value pairs to be set on every descendant of groupParent by default.
`static String`	`defaultPeopleAttrs` Set of attribute name/value pairs to be set on every descendant of peopleParent by default.
`static String`	`defaultReaderACLs`
`static String`	`groupParent` The entry to use as the parent of all typeGroup entries.
`static String`	`jndiBaseURL` jndiBaseURL+"/"+baseDN=javax.naming.Context.PROVIDER_URL
`static String`	`jndiConnectAsUser` True to connect to JNDI as the currently logged in user, false to connect with jndi.login as the principal and jndi.password as the credentials.
`static String`	`jndiCustomVariables` Other, SPI-specific variables to pass into the javax.naming.Context environment.
`static String`	`jndiLogin` If jndi.ConnectAsUser is set to "false", this is the principal to connect as (leave blank to connect anonymously).
`static String`	`jndiPassword` If jndi.ConnectAsUser is set to "false", this is the credentials for the jndi.login to connect as.
`static String`	`jndipoolConnections` "true" indicates to the system to use pooled DirContexts
`static String`	`jndipoolSize` This property indicates size of the pool
`static String`	`objectclassGroup` The name of some base object class common to all ContentServer groups - e.g., this is used by the 'groupMemberships' command to discern group-class entries from other object classes.
`static String`	`objectclassPerson` The name of some base object class common to all ContentServer users - e.g., this is used by the 'listUsers' command to discern user-class entries from other object classes.
`static String`	`peopleParent` The entry to use as the parent of all ContentServer entries of typeUser.
`static String`	`requiredGroupAttrs` Set of attributes required by default by every descendant of groupParent.
`static String`	`requiredPeopleAttrs` Set of attributes required by default by every descendant of peopleParent.
`static String`	`searchLimit` The maximum number of entries to return.
`static String`	`searchScope` The search scope.
`static String`	`searchTimeout` The number of seconds to wait before returning.
`static String`	`synBeginquote` If present, specifies the string delimiting start of a quoted string.
`static String`	`synBeginquote2` Alternative set of begin/end quotes.
`static String`	`synCustomVariables` Other, classJNDIName-specific variables to pass into the classIName constructor.
`static String`	`synDirection` Direction for parsing ('right_to_left', 'left_to_right', 'flat').
`static String`	`synEndquote` String delimiting end of quoted string.
`static String`	`synEndquote2` Alternative set of begin/end quotes.
`static String`	`synEscape` If present, specifies the escape string for overriding separator, escapes and quotes.
`static String`	`synIgnorecase` If present, 'true' means ignore the case when comparing name components.
`static String`	`synSeparator` Separator between atomic name components.
`static String`	`synSeparatorava` If present, specifies the string that separates attribute-value-assertions when specifying multiple attribute/value pairs.
`static String`	`synSeparatortypeval` If present, specifies the string that separators attribute from value (e.g.
`static String`	`synTrimblanks` If present, 'true' means trim any leading and trailing whitespaces in a name component for comparison purposes.
`static String`	`userDirectory`

Constructor Summary

Constructors
Constructor and Description

DirProperties()

Constructors
Constructor and Description
`DirProperties()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getDefaultValue(String property)` Returns a hard-coded default value for the given property.
`static String`	`getProperty(ICS ics, String property)` Returns the value of a property.
`static String`	`getProperty(String property)`
`static String`	`getRequiredProperty(ICS ics, String property)` Returns the value of a property.
`static boolean`	`isIgnoreCaseInLDAP(ICS ics)` Returns true if Sites is configured with LDAP and syntax ignore case is set to true.
`static Hashtable`	`JNDIEnvironment(ICS ics)` Reads all the relevant JNDI variables from the property files and returns it in a format suitable for creation of a JNDI Context.
`static Properties`	`namingSyntax(ICS ics)` Reads all the naming syntax out of the property file

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - peopleParent
```
public static final String peopleParent
```
    The entry to use as the parent of all ContentServer entries of typeUser.
    
    See Also:
    
    Constant Field Values
  - groupParent
```
public static final String groupParent
```
    The entry to use as the parent of all typeGroup entries.
    
    See Also:
    
    Constant Field Values
  - baseDN
```
public static final String baseDN
```
    Distinguished name for root to use by default for searching and for prepending to names for attribute values that require a DN type. May not be empty string.
    
    See Also:
    
    Constant Field Values
  - defaultPeopleAttrs
```
public static final String defaultPeopleAttrs
```
    Set of attribute name/value pairs to be set on every descendant of peopleParent by default. Syntax follows x-www-form-urlencoded format.
    
    See Also:
    
    Constant Field Values
  - defaultGroupAttrs
```
public static final String defaultGroupAttrs
```
    Set of attribute name/value pairs to be set on every descendant of groupParent by default. Syntax follows x-www-form-urlencoded format.
    
    See Also:
    
    Constant Field Values
  - requiredPeopleAttrs
```
public static final String requiredPeopleAttrs
```
    Set of attributes required by default by every descendant of peopleParent. Syntax follows x-www-form-urlencoded format, where the name is the required attribute's id and the value is a description of the attribute.
    
    See Also:
    
    Constant Field Values
  - requiredGroupAttrs
```
public static final String requiredGroupAttrs
```
    Set of attributes required by default by every descendant of groupParent. Syntax follows x-www-form-urlencoded format, where the name is the required attribute's id and the value is a description of the attribute.
    
    See Also:
    
    Constant Field Values
  - objectclassGroup
```
public static final String objectclassGroup
```
    The name of some base object class common to all ContentServer groups - e.g., this is used by the 'groupMemberships' command to discern group-class entries from other object classes.
    
    See Also:
    
    Constant Field Values
  - objectclassPerson
```
public static final String objectclassPerson
```
    The name of some base object class common to all ContentServer users - e.g., this is used by the 'listUsers' command to discern user-class entries from other object classes.
    
    See Also:
    
    Constant Field Values
  - attrCn
```
public static final String attrCn
```
    The name of the 'commonname' attribute.
    
    See Also:
    
    Constant Field Values
  - attrUsername
```
public static final String attrUsername
```
    The name of the 'username' attribute.
    
    See Also:
    
    Constant Field Values
  - attrPassword
```
public static final String attrPassword
```
    The name of the 'password' attribute.
    
    See Also:
    
    Constant Field Values
  - attrUniquemember
```
public static final String attrUniquemember
```
    The name of the 'uniquemember' attribute of a typeGroup used to specify members in a group.
    
    See Also:
    
    Constant Field Values
  - attrMemberof
```
public static final String attrMemberof
```
    The name of the 'memberof' attribute specifying the user attribute defining the groups for the user, or blank if user membership is determined from the uniquemember attribute on the group.
    
    See Also:
    
    Constant Field Values
  - attrObjectclass
```
public static final String attrObjectclass
```
    The name of the 'objectclass' attribute.
    
    See Also:
    
    Constant Field Values
  - attrLogin
```
public static final String attrLogin
```
    The name of the 'loginid' attribute.
    
    See Also:
    
    Constant Field Values
  - synDirection
```
public static final String synDirection
```
    Direction for parsing ('right_to_left', 'left_to_right', 'flat'). If unspecified, defaults to 'flat', which means the namespace is flat with no hierarchical structure.
    
    See Also:
    
    Constant Field Values
  - synSeparator
```
public static final String synSeparator
```
    Separator between atomic name components. Required unless direction is 'flat'.
    
    See Also:
    
    Constant Field Values
  - synIgnorecase
```
public static final String synIgnorecase
```
    If present, 'true' means ignore the case when comparing name components. If its value is not 'true', or if the property is not present, case is considered when comparing name components.
    
    See Also:
    
    Constant Field Values
  - synEscape
```
public static final String synEscape
```
    If present, specifies the escape string for overriding separator, escapes and quotes.
    
    See Also:
    
    Constant Field Values
  - synBeginquote
```
public static final String synBeginquote
```
    If present, specifies the string delimiting start of a quoted string.
    
    See Also:
    
    Constant Field Values
  - synEndquote
```
public static final String synEndquote
```
    String delimiting end of quoted string. If present, specifies the string delimiting the end of a quoted string. If not present, use syntax.beginquote as end quote.
    
    See Also:
    
    Constant Field Values
  - synBeginquote2
```
public static final String synBeginquote2
```
    Alternative set of begin/end quotes.
    
    See Also:
    
    Constant Field Values
  - synEndquote2
```
public static final String synEndquote2
```
    Alternative set of begin/end quotes.
    
    See Also:
    
    Constant Field Values
  - synTrimblanks
```
public static final String synTrimblanks
```
    If present, 'true' means trim any leading and trailing whitespaces in a name component for comparison purposes. If its value is not 'true', or if the property is not present, blanks are significant.
    
    See Also:
    
    Constant Field Values
  - synSeparatorava
```
public static final String synSeparatorava
```
    If present, specifies the string that separates attribute-value-assertions when specifying multiple attribute/value pairs. (e.g. ',' in age=65,gender=male).
    
    See Also:
    
    Constant Field Values
  - synSeparatortypeval
```
public static final String synSeparatortypeval
```
    If present, specifies the string that separators attribute from value (e.g. '=' in 'age=65')
    
    See Also:
    
    Constant Field Values
  - synCustomVariables
```
public static final String synCustomVariables
```
    Other, classJNDIName-specific variables to pass into the classIName constructor. Syntax follows x-www-form-urlencoded format.
    
    See Also:
    
    classIName, classJNDIName, Constant Field Values
  - classIFactory
```
public static final String classIFactory
```
    Name of concrete class to implement interface IFactory
    
    See Also:
    
    Constant Field Values
  - classIName
```
public static final String classIName
```
    Name of concrete class to implement interface IName
    
    See Also:
    
    Constant Field Values
  - classAttributes
```
public static final String classAttributes
```
    Name of concrete class to implement Attributes
    
    See Also:
    
    Constant Field Values
  - classAttribute
```
public static final String classAttribute
```
    Name of concrete class to implement interface Attribute
    
    See Also:
    
    Constant Field Values
  - classIDir
```
public static final String classIDir
```
    Name of concrete class to implement interface IDir
    
    See Also:
    
    Constant Field Values
  - classIUserDir
```
public static final String classIUserDir
```
    Name of concrete class to implement interface IUserDir
    
    See Also:
    
    Constant Field Values
  - userDirectory
```
public static final String userDirectory
```
    See Also:
    
    Constant Field Values
  - classJNDIName
```
public static final String classJNDIName
```
    Name of concrete class to implement com.openmarket.directory.jndi.NameWrapper. Only meaningful if classIDir=com.openmarket.directory.jndi.JNDIDir
    
    See Also:
    
    DirProperties.classIDir, Constant Field Values
  - searchScope
```
public static final String searchScope
```
    The search scope. One of: 1=ONELEVEL, 2=SUBTREE.
    
    See Also:
    
    Constant Field Values
  - searchLimit
```
public static final String searchLimit
```
    The maximum number of entries to return. If 0, return all entries that satisfy the search criteria.
    
    See Also:
    
    Constant Field Values
  - searchTimeout
```
public static final String searchTimeout
```
    The number of seconds to wait before returning. If 0, wait indefinitely.
    
    See Also:
    
    Constant Field Values
  - jndiConnectAsUser
```
public static final String jndiConnectAsUser
```
    True to connect to JNDI as the currently logged in user, false to connect with jndi.login as the principal and jndi.password as the credentials.
    
    See Also:
    
    Constant Field Values
  - jndiLogin
```
public static final String jndiLogin
```
    If jndi.ConnectAsUser is set to "false", this is the principal to connect as (leave blank to connect anonymously).
    
    See Also:
    
    Constant Field Values
  - jndiPassword
```
public static final String jndiPassword
```
    If jndi.ConnectAsUser is set to "false", this is the credentials for the jndi.login to connect as.
    
    See Also:
    
    Constant Field Values
  - jndiBaseURL
```
public static final String jndiBaseURL
```
    jndiBaseURL+"/"+baseDN=javax.naming.Context.PROVIDER_URL
    
    See Also:
    
    Constant Field Values
  - jndiCustomVariables
```
public static final String jndiCustomVariables
```
    Other, SPI-specific variables to pass into the javax.naming.Context environment. Syntax follows x-www-form-urlencoded format
    
    See Also:
    
    Constant Field Values
  - jndipoolConnections
```
public static final String jndipoolConnections
```
    "true" indicates to the system to use pooled DirContexts
    
    See Also:
    
    Constant Field Values
  - jndipoolSize
```
public static final String jndipoolSize
```
    This property indicates size of the pool
    
    See Also:
    
    Constant Field Values
  - cleanDNs
```
public static final String cleanDNs
```
    See Also:
    
    Constant Field Values
  - defaultReaderACLs
```
public static final String defaultReaderACLs
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DirProperties
```
public DirProperties()
```
- Method Detail
  - namingSyntax
```
public static Properties namingSyntax(ICS ics)
```
    Reads all the naming syntax out of the property file
  - JNDIEnvironment
```
public static Hashtable JNDIEnvironment(ICS ics)
                                 throws DirectoryException
```
    Reads all the relevant JNDI variables from the property files and returns it in a format suitable for creation of a JNDI Context. Only handles values from the property file; it is up to the client to set any additional properties acquired from the session, such as Context.SECURITY_PRINCIPAL and Context.SECURITY_CREDENTIALS. Note also that the baseDN property value will be appended to the value of jndiBaseURL in the property file.
    
    Throws:
    
    DirectoryException
    
    See Also:
    
    Context.SECURITY_PRINCIPAL, javax.naming.Context#CREDENTIALS
  - getDefaultValue
```
public static String getDefaultValue(String property)
```
    Returns a hard-coded default value for the given property. This is a fallback in case the property is missing entirely from the property file.
    
    Parameters:
    
    property - for which to find the default value.
  - getProperty
```
public static String getProperty(ICS ics,
                                 String property)
```
    Returns the value of a property.
    
    Parameters:
    
    ics - a COM.FutureTense.Interfaces.ICS context. This param is no longer needed. Retained for legacy code compatibility only
    
    property - name of the property to return
    
    Returns:
    
    String containing the value of the property or null, if the property value could be resolved
  - getProperty
```
public static String getProperty(String property)
```
  - getRequiredProperty
```
public static String getRequiredProperty(ICS ics,
                                         String property)
                                  throws DirectoryException
```
    Returns the value of a property. If not found in the property file, returns the default value. If no default value is found, errno is set to DirectoryResources.icConfigurationError and an exception is thrown
    
    Parameters:
    
    ics - a COM.FutureTense.Interfaces.ICS context. This param is no longer needed. Retained for legacy code compatibility only
    
    property - name of the property to return
    
    Returns:
    
    String containing the value of the property
    
    Throws:
    
    Exception - if the property is undefined
    
    DirectoryException
  - isIgnoreCaseInLDAP
```
public static boolean isIgnoreCaseInLDAP(ICS ics)
```
    Returns true if Sites is configured with LDAP and syntax ignore case is set to true.
    
    Parameters:
    
    ics - a COM.FutureTense.Interfaces.ICS context
    
    Returns:
    
    boolean true or false

Class DirProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

peopleParent

groupParent

baseDN

defaultPeopleAttrs

defaultGroupAttrs

requiredPeopleAttrs

requiredGroupAttrs

objectclassGroup

objectclassPerson

attrCn

attrUsername

attrPassword

attrUniquemember

attrMemberof

attrObjectclass

attrLogin

synDirection

synSeparator

synIgnorecase

synEscape

synBeginquote

synEndquote

synBeginquote2

synEndquote2

synTrimblanks

synSeparatorava

synSeparatortypeval

synCustomVariables

classIFactory

classIName

classAttributes

classAttribute

classIDir

classIUserDir

userDirectory

classJNDIName

searchScope

searchLimit

searchTimeout

jndiConnectAsUser

jndiLogin

jndiPassword

jndiBaseURL

jndiCustomVariables

jndipoolConnections

jndipoolSize

cleanDNs

defaultReaderACLs

Constructor Detail

DirProperties

Method Detail

namingSyntax

JNDIEnvironment

getDefaultValue

getProperty

getProperty

getRequiredProperty

isIgnoreCaseInLDAP