Directory (Oracle? Fusion Middleware Java API Reference for the Lifecycle Management Environment Specification)

java.lang.Object
- oracle.fmwplatform.envspec.model.topology.Directory

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.ContainerAware<Topology>, oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.Substitutable
```
public class Directory
extends Object
implements oracle.fmwplatform.envspec.common.ContainerAware<Topology>, oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.Substitutable
```
Represents an LDAP Directory.

Since:

12.2.2

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Directory.DirectoryType
Type of Directory

Nested Classes
Modifier and Type	Class and Description
`static class`	`Directory.DirectoryType` Type of Directory

Constructor Summary

Constructors
Constructor and Description

Directory()

Constructors
Constructor and Description
`Directory()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getConfigHome()` Returns the configHome of this Directory object
`String`	`getCredentialRef()` Returns the credentialRef of this Directory object
`String`	`getGroupSearchBase()` Returns the groupSearchBase of this Directory object
`String`	`getId()` Returns the id of this Directory object
`String`	`getLBRURL()` Returns the LBRURL of this Directory object
`Properties`	`getMiscConfig()` Returns the miscConfig of this Directory object
`Topology`	`getParent()` Returns the object that contains this entity.
`String`	`getPort()` Returns the port of this Directory object
`String`	`getProductHome()` Returns the productHome of this Directory object
`String`	`getRcuConnectString()` Returns the rcuConnectString of this Directory object
`String`	`getSearchBase()` Returns the searchBase of this Directory object
`boolean`	`getSecure()` Returns the secure of this Directory object
`Directory.DirectoryType`	`getType()` Returns the type of this Directory object
`String`	`getUserSearchBase()` Returns the userSearchBase of this Directory object
`String`	`getVariableValue(String key)` Returns the variable value assigned to the specified key.
`Directory`	`setConfigHome(String configHome)` Set the configHome of this Directory object
`Directory`	`setCredentialRef(String credentialRef)` Set the credentialRef of this Directory object
`Directory`	`setGroupSearchBase(String groupSearchBase)` Set the groupSearchBase of this Directory object
`Directory`	`setId(String id)` Set the id of this Directory object
`Directory`	`setLBRURL(String LBRURL)` Set the LBRURL of this Directory object
`Directory`	`setMiscConfig(Properties miscConfig)` Set the miscConfig of this Directory object
`Directory`	`setParent(Topology containerTopology)` Sets the parent of this object.
`Directory`	`setPort(String port)` Set the port of this Directory object
`Directory`	`setProductHome(String productHome)` Set the productHome of this Directory object
`Directory`	`setRcuConnectString(String rcuConnectString)` Set the rcuConnectString of this Directory object
`Directory`	`setSearchBase(String searchBase)` Set the searchBase of this Directory object
`Directory`	`setSecure(boolean secure)` Set the secure of this Directory object
`Directory`	`setType(Directory.DirectoryType type)` Set the type of this Directory object
`Directory`	`setUserSearchBase(String userSearchBase)` Set the userSearchBase of this Directory object
`String`	`substitute(String text)` Replaces substitution keys in the specified text with their corresponding values.
`String`	`toCompactString()` Returns a compact string representation of the object in JSON format.
`String`	`toString()` Returns a string representation of the object in JSON format.
`String`	`toXmlCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toXmlString()` Returns a string representation of the object in XML format.

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

- Constructor Detail
  - Directory
```
public Directory()
```
- Method Detail
  - getParent
```
public Topology getParent()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.ContainerAware
    
    Returns the object that contains this entity.
    
    Specified by:
    
    getParent in interface oracle.fmwplatform.envspec.common.ContainerAware<Topology>
    
    Returns:
    
    the object that contains this entity
  - setParent
```
public Directory setParent(Topology containerTopology)
```
    Description copied from interface: oracle.fmwplatform.envspec.common.ContainerAware
    
    Sets the parent of this object. The container object has variables in it that are used by child objects.
    
    Specified by:
    
    setParent in interface oracle.fmwplatform.envspec.common.ContainerAware<Topology>
    
    Parameters:
    
    containerTopology - the parent container
    
    Returns:
    
    the ContainerAware parent object
  - getId
```
public String getId()
```
    Returns the id of this Directory object
    
    Specified by:
    
    getId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Returns:
    
    id
  - setId
```
public Directory setId(String id)
```
    Set the id of this Directory object
    
    Specified by:
    
    setId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Parameters:
    
    id - of this Directory object
    
    Returns:
    
    this Directory object (for method chaining)
  - getType
```
public Directory.DirectoryType getType()
```
    Returns the type of this Directory object
    
    Returns:
    
    Type
  - setType
```
public Directory setType(Directory.DirectoryType type)
```
    Set the type of this Directory object
    
    Parameters:
    
    type - of this Directory object
    
    Returns:
    
    this Directory object (for method chaining)
  - getProductHome
```
public String getProductHome()
```
    Returns the productHome of this Directory object
    
    Returns:
    
    productHome
  - setProductHome
```
public Directory setProductHome(String productHome)
```
    Set the productHome of this Directory object
    
    Parameters:
    
    productHome - of this Directory object
    
    Returns:
    
    this Directory object (for method chaining)
  - getConfigHome
```
public String getConfigHome()
```
    Returns the configHome of this Directory object
    
    Returns:
    
    configHome
  - setConfigHome
```
public Directory setConfigHome(String configHome)
```
    Set the configHome of this Directory object
    
    Parameters:
    
    configHome - of this Directory object
    
    Returns:
    
    this Directory object (for method chaining)
  - getPort
```
public String getPort()
```
    Returns the port of this Directory object
    
    Returns:
    
    port
  - setPort
```
public Directory setPort(String port)
```
    Set the port of this Directory object
    
    Parameters:
    
    port - of this Directory object
    
    Returns:
    
    this Directory object (for method chaining)
  - getSecure
```
public boolean getSecure()
```
    Returns the secure of this Directory object
    
    Returns:
    
    secure
  - setSecure
```
public Directory setSecure(boolean secure)
```
    Set the secure of this Directory object
    
    Parameters:
    
    secure - of this Directory object
    
    Returns:
    
    this Directory object (for method chaining)
  - getMiscConfig
```
public Properties getMiscConfig()
```
    Returns the miscConfig of this Directory object
    
    Returns:
    
    miscConfig
  - setMiscConfig
```
public Directory setMiscConfig(Properties miscConfig)
```
    Set the miscConfig of this Directory object
    
    Parameters:
    
    miscConfig - of this Directory object
    
    Returns:
    
    this Directory object (for method chaining)
  - getRcuConnectString
```
public String getRcuConnectString()
```
    Returns the rcuConnectString of this Directory object
    
    Returns:
    
    rcuConnectString
  - setRcuConnectString
```
public Directory setRcuConnectString(String rcuConnectString)
```
    Set the rcuConnectString of this Directory object
    
    Parameters:
    
    rcuConnectString - of this Directory object
    
    Returns:
    
    this Directory object (for method chaining)
  - getCredentialRef
```
public String getCredentialRef()
```
    Returns the credentialRef of this Directory object
    
    Returns:
    
    credentialRef
  - setCredentialRef
```
public Directory setCredentialRef(String credentialRef)
```
    Set the credentialRef of this Directory object
    
    Parameters:
    
    credentialRef - of this Directory object
    
    Returns:
    
    this Directory object (for method chaining)
  - getSearchBase
```
public String getSearchBase()
```
    Returns the searchBase of this Directory object
    
    Returns:
    
    searchBase
  - setSearchBase
```
public Directory setSearchBase(String searchBase)
```
    Set the searchBase of this Directory object
    
    Parameters:
    
    searchBase - of this Directory object
    
    Returns:
    
    this Directory object (for method chaining)
  - getUserSearchBase
```
public String getUserSearchBase()
```
    Returns the userSearchBase of this Directory object
    
    Returns:
    
    userSearchBase
  - setUserSearchBase
```
public Directory setUserSearchBase(String userSearchBase)
```
    Set the userSearchBase of this Directory object
    
    Parameters:
    
    userSearchBase - of this Directory object
    
    Returns:
    
    this Directory object (for method chaining)
  - getGroupSearchBase
```
public String getGroupSearchBase()
```
    Returns the groupSearchBase of this Directory object
    
    Returns:
    
    groupSearchBase
  - setGroupSearchBase
```
public Directory setGroupSearchBase(String groupSearchBase)
```
    Set the groupSearchBase of this Directory object
    
    Parameters:
    
    groupSearchBase - of this Directory object
    
    Returns:
    
    this Directory object (for method chaining)
  - getLBRURL
```
public String getLBRURL()
```
    Returns the LBRURL of this Directory object
    
    Returns:
    
    LBRURL
  - setLBRURL
```
public Directory setLBRURL(String LBRURL)
```
    Set the LBRURL of this Directory object
    
    Parameters:
    
    LBRURL - of this Directory object
    
    Returns:
    
    this Directory object (for method chaining)
  - getVariableValue
```
public String getVariableValue(String key)
```
    Returns the variable value assigned to the specified key.
    
    Specified by:
    
    getVariableValue in interface oracle.fmwplatform.envspec.common.Substitutable
    
    Parameters:
    
    key - the key of the variable to be checked
    
    Returns:
    
    the variable value, or null if not found
  - substitute
```
public String substitute(String text)
```
    Replaces substitution keys in the specified text with their corresponding values.
    
    Specified by:
    
    substitute in interface oracle.fmwplatform.envspec.common.Substitutable
    
    Parameters:
    
    text - the original text
    
    Returns:
    
    the text with substitution keys replaced
  - toXmlCompactString
```
public String toXmlCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Returns:
    
    a compact string representation of the object in XML format
  - toXmlString
```
public String toXmlString()
```
    Returns a string representation of the object in XML format.
    
    Returns:
    
    a string representation of the object in XML format
  - toCompactString
```
public String toCompactString()
```
    Returns a compact string representation of the object in JSON format.
    
    Returns:
    
    a compact string representation of the object in JSON format
  - toString
```
public String toString()
```
    Returns a string representation of the object in JSON format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object in JSON format

Class Directory

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Directory

Method Detail

getParent

setParent

getId

setId

getType

setType

getProductHome

setProductHome

getConfigHome

setConfigHome

getPort

setPort

getSecure

setSecure

getMiscConfig

setMiscConfig

getRcuConnectString

setRcuConnectString

getCredentialRef

setCredentialRef

getSearchBase

setSearchBase

getUserSearchBase

setUserSearchBase

getGroupSearchBase

setGroupSearchBase

getLBRURL

setLBRURL

getVariableValue

substitute

toXmlCompactString

toXmlString

toCompactString

toString