Package org.nuxeo.ecm.directory

Class DirectoryServiceImpl

java.lang.Object
org.nuxeo.runtime.model.DefaultComponent
org.nuxeo.ecm.directory.DirectoryServiceImpl
All Implemented Interfaces:
DirectoryService, Adaptable, Component, Extensible, TimestampedService
public class DirectoryServiceImpl extends DefaultComponent implements DirectoryService

  • Field Details

    • CLUSTER_START_DURATION_PROP

      public static final String CLUSTER_START_DURATION_PROP
      Since:
      11.1
      See Also:

    • CLUSTER_START_DURATION_DEFAULT

      public static final Duration CLUSTER_START_DURATION_DEFAULT
      Since:
      11.1

    • DELIMITER_BETWEEN_DIRECTORY_NAME_AND_SUFFIX

      protected static final String DELIMITER_BETWEEN_DIRECTORY_NAME_AND_SUFFIX
      See Also:

    • registry

      protected DirectoryRegistry registry

  • Constructor Details

    • DirectoryServiceImpl

      public DirectoryServiceImpl()

  • Method Details

    • activate

      public void activate(ComponentContext context)
      Description copied from interface: Component
      Activates the component.

      This method is called by the runtime when a component is activated.

      Specified by:
      activate in interface Component
      Overrides:
      activate in class DefaultComponent
      Parameters:
      context - the runtime context

    • deactivate

      public void deactivate(ComponentContext context)
      Description copied from interface: Component
      Deactivates the component.

      This method is called by the runtime when a component is deactivated.

      Specified by:
      deactivate in interface Component
      Overrides:
      deactivate in class DefaultComponent
      Parameters:
      context - the runtime context

    • registerContribution

      public void registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
      Overrides:
      registerContribution in class DefaultComponent

    • registerDirectoryDescriptor

      public void registerDirectoryDescriptor(BaseDirectoryDescriptor descriptor)
      Description copied from interface: DirectoryService
      INTERNAL registers a directory descriptor.
      Specified by:
      registerDirectoryDescriptor in interface DirectoryService

    • unregisterDirectoryDescriptor

      public void unregisterDirectoryDescriptor(BaseDirectoryDescriptor descriptor)
      Description copied from interface: DirectoryService
      INTERNAL unregisters a directory descriptor.
      Specified by:
      unregisterDirectoryDescriptor in interface DirectoryService

    • loadFromCSV

      public void loadFromCSV(String directoryName, Blob dataBlob, String dataLoadingPolicy)
      Description copied from interface: DirectoryService
      Loads a CSV into the given directoryName.
      Specified by:
      loadFromCSV in interface DirectoryService
      See Also:

    • getApplicationStartedOrder

      public int getApplicationStartedOrder()
      Description copied from interface: Component
      The component notification order for Component.start(ComponentContext).

      Components are notified in increasing order. Order 1000 is the default order for components that don't care. Order 100 is the repository initialization.

      Specified by:
      getApplicationStartedOrder in interface Component
      Returns:
      the order, 1000 by default

    • start

      public void start(ComponentContext context)
      Description copied from interface: Component
      Start the component. This method is called after all the components were resolved and activated
      Specified by:
      start in interface Component
      Overrides:
      start in class DefaultComponent

    • start

      protected void start()

    • getDirectoryConfiguration

      protected DirectoryConfiguration getDirectoryConfiguration(DocumentModel documentContext)

    • getWaitingLocalDirectoryName

      protected String getWaitingLocalDirectoryName(String directoryName, DirectoryConfiguration configuration)
      This will return the local directory name according the local configuration. If the local configuration is null or the suffix value is null or the suffix value trimmed is an empty string the returned value is the directoryName given in parameter. If not this is directoryName + DELIMITER_BETWEEN_DIRECTORY_NAME_AND_SUFFIX + suffix. if directoryName is null, return null.

    • getDirectoryDescriptor

      public BaseDirectoryDescriptor getDirectoryDescriptor(String id)
      Description copied from interface: DirectoryService
      Gets the effective directory descriptor for the given directory.
      Specified by:
      getDirectoryDescriptor in interface DirectoryService
      Parameters:
      id - the directory id
      Returns:
      the effective directory descriptor, or null if not registered

    • getDirectory

      public Directory getDirectory(String id)
      Description copied from interface: DirectoryService
      Return the directory with the given id.

      If the id is null, returns null.

      Specified by:
      getDirectory in interface DirectoryService
      Parameters:
      id - the directory id
      Returns:
      the directory, or null if not found

    • getDirectory

      public Directory getDirectory(String id, DocumentModel documentContext)
      Description copied from interface: DirectoryService
      Returns the directory for the specified id and document context.

      The context is given by the document. The document service will try to find the directory local configuration of the document that will specify the suffix. The directory service will fetch the id + suffix found. If no local configuration is found the service will return the directory with the given id.

      If the id is null, returns null.

      Specified by:
      getDirectory in interface DirectoryService
      Parameters:
      id - the directory id
      documentContext - the document context
      Returns:
      the directory, or null if not found

    • getDirectoryOrFail

      protected Directory getDirectoryOrFail(String name)

    • getDirectoryOrFail

      protected Directory getDirectoryOrFail(String id, DocumentModel documentContext)

    • getDirectories

      public List<Directory> getDirectories()
      Description copied from interface: DirectoryService
      Gets all the directories.
      Specified by:
      getDirectories in interface DirectoryService

    • getDirectoryNames

      public List<String> getDirectoryNames()
      Description copied from interface: DirectoryService
      Gets the directory ids.
      Specified by:
      getDirectoryNames in interface DirectoryService

    • getDirectorySchema

      public String getDirectorySchema(String directoryName)
      Description copied from interface: DirectoryService
      Gets the schema for a directory.
      Specified by:
      getDirectorySchema in interface DirectoryService
      Parameters:
      directoryName - the directory id
      Returns:
      the schema for the directory

    • getDirectoryIdField

      public String getDirectoryIdField(String directoryName)
      Description copied from interface: DirectoryService
      Gets the id field for a directory.
      Specified by:
      getDirectoryIdField in interface DirectoryService
      Parameters:
      directoryName - the directory id
      Returns:
      the id field for the directory

    • getDirectoryPasswordField

      public String getDirectoryPasswordField(String directoryName)
      Description copied from interface: DirectoryService
      Gets the password field for a directory.
      Specified by:
      getDirectoryPasswordField in interface DirectoryService
      Parameters:
      directoryName - the directory name
      Returns:
      the password field for the directory

    • getParentDirectoryName

      public String getParentDirectoryName(String directoryName)
      Description copied from interface: DirectoryService
      Gets the parent directory id a directory.
      Specified by:
      getParentDirectoryName in interface DirectoryService
      Parameters:
      directoryName - the directory id
      Returns:
      the parent directory id, which may be null

    • open

      public Session open(String directoryName)
      Description copied from interface: DirectoryService
      Opens a session on specified directory.

      This method prefers to throw rather than returning null.

      Specified by:
      open in interface DirectoryService
      Returns:
      the session

    • open

      public Session open(String directoryName, DocumentModel documentContext)
      Description copied from interface: DirectoryService
      Opens a session on the directory for the specified context. The context is given by the document. The document service will try to find the directory local configuration of the document that will specify the suffix. the directory will fetch the directoryName + suffix found. If no local configuration is found the service will return the directoryName directory.

      This method prefers to throw rather than returning null.

      Specified by:
      open in interface DirectoryService
      Returns:
      the session