Package com.orchestranetworks.service.directory

# Class DirectoryFactory

java.lang.Object
com.orchestranetworks.service.directory.DirectoryFactory

Direct Known Subclasses:
  `DirectoryDefaultFactory`, `LdapDirectoryFactory`

public abstract class DirectoryFactory extends Object
Factory for the user and roles directory.

#### Configuration

The directory to be used by EBX® is specified by the property `ebx.directory.factory` in the EBX® main configuration file or in the EBX® Container Edition environment variables.

If not specified, the default factory is `DirectoryDefaultFactory`.

#### Deployment

This class and its associated classes must be accessible from the class-loader that contains `ebx.jar`.

See Also:
  - Custom directory

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `DirectoryFactory()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `abstract Directory`
  `createDirectory(AdaptationHome aDataSpace)`
  Creates the directory.

  ### Methods inherited from class java.lang.Object

  `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### DirectoryFactory

    public DirectoryFactory()

- ## Method Details

  - ### createDirectory

    public abstract Directory createDirectory(AdaptationHome aDataSpace) throws Exception
    Creates the directory.

    Limitation: since this method is called during the initialization process of EBX® repository, some resources may not yet be completely available; for instance, data model compilation may not yet finalized.

    Parameters:
      `aDataSpace` - Current 'Reference' dataspace of the repository.
    Throws:
      `Exception`