Package com.day.crx

Interface CRXRepository

All Superinterfaces:
Repository
public interface CRXRepository extends Repository
This Interface extends the jcr repository by some crx specific methods

  • Field Details

    • CRX_NAMESPACE_PREFIX

      static final String CRX_NAMESPACE_PREFIX
      the crx namespace prefix
      See Also:

    • CRX_NAMESPACE_URI

      static final String CRX_NAMESPACE_URI
      the crx namespace uri
      See Also:

    • REP_CLUSTER_PREFERRED_MASTER

      @Deprecated static final String REP_CLUSTER_PREFERRED_MASTER
      Deprecated.
      Not applicable to Oak.
      this flag indicates whether this repository is configured to be the preferred master
      See Also:

    • REP_CLUSTER_MASTER

      @Deprecated static final String REP_CLUSTER_MASTER
      Deprecated.
      Use Sling's discovery API instead - ie by implementing a TopologyEventListener
      this flag indicates whether this repository currently operates in master mode.
      See Also:

    • REP_CLUSTER_ID

      @Deprecated static final String REP_CLUSTER_ID
      Deprecated.
      Use Sling's discovery API instead - ie by implementing a TopologyEventListener
      the cluster id.
      See Also:

    • REP_SYSTEM_ID

      static final String REP_SYSTEM_ID
      the system id param
      See Also:

    • REP_VERSION_DISPLAY_DESC

      static final String REP_VERSION_DISPLAY_DESC
      the version to display
      See Also:

    • STATS_NODE_COUNT_PROPERTY

      static final String STATS_NODE_COUNT_PROPERTY
      desciptor-key name for node-count statistic
      See Also:

    • STATS_PROP_COUNT_PROPERTY

      static final String STATS_PROP_COUNT_PROPERTY
      desciptor-key name for property-count statistic
      See Also:

    • SYSTEM_WORKSPACE_NAME

      @Deprecated static final String SYSTEM_WORKSPACE_NAME
      Deprecated.
      As of CRX 2.0 the automatic initialization of a crx.system workspace is omitted. User data are no stored in each workspace.
      name of the workspace, containing system data, like users etc
      See Also:

    • LICENSE_PROPERTIES

      static final String LICENSE_PROPERTIES
      Default name for the license properties file
      See Also:

  • Method Details

    • getModule

      CRXModule getModule(String moduleName)
      Returns the Module with the given name.
      Parameters:
      moduleName - The name of the CRXModule to return.
      Returns:
      The installed CRXModule or null if no module whose CRXModule.getName() returns that name is registered or if moduleName is null or empty.

    • getModules

      CRXModule[] getModules()
      Returns all currently installed modules. The array is a copy of the internal data structure of installed modules, so modifying the array returned does not influence the installed modules.
      Returns:
      An array of all currently installed modules. If no modules are installed, an empty array is returned.

    • installModule

      void installModule(Session session, CRXModule module) throws AccessDeniedException, RepositoryException
      Installs a preconfigured CRXModule into the repository.

      After starting the module it is registered.

      If an error occurs, that is if any exception is thrown, the module is not registered and will not be returned by the getModule(String) and getModules() method.

      Parameters:
      session - The Session authorizing the installation of a new module into the repository. If the session does not have enough rights to install a module, an AccessDeniedException is thrown.
      module - The CRXModule to install. This must not be null.
      Throws:
      NullPointerException - Is thrown if session or module is null.
      IllegalArgumentException - Is thrown if a module with the same name, that is if another module whose getName() is equal to the getName() of module or if module.getName() returns an empty or null name.
      AccessDeniedException - Is thrown if the session has not enough rights to install a module into the repository.
      RepositoryException - Is thrown if the CRXModule.start(CRXSession) module fails or if any other problem occurs during installation.

    • uninstallModule

      void uninstallModule(Session session, String moduleName) throws AccessDeniedException
      Uninstalls the named CRXModule from the repository.

      After unregistering the module, the CRXModule.stop() method is called.

      If no module with the given name is installed in the system or if moduleName is empty or null, this method has on effect.

      Parameters:
      session - The Session authorizing the uninstallation of a module from the repository. If the session does not have enough rights to uninstall a module, an AccessDeniedException is thrown.
      moduleName - The name as returned by CRXModule.getName() of the module to uninstall.
      Throws:
      AccessDeniedException - Is thrown if the session has not enough rights to install a module into the repository.

    • getLicense

      @Deprecated License getLicense()
      Deprecated.
      Use the Granite License API
      Returns the product license of this repository
      Returns:
      the product license of this repository

    • getHomeDir

      File getHomeDir()
      Returns the repository home
      Returns:
      the repository home