Package com.priint.pubserver.config

Interface ConfigManagerLocal

  • public interface ConfigManagerLocal
    Local Interface for ConfigManager
    Loads and saves configuration files and their revisions using the Document Manager.

    • Method Detail

      • getConfig

        PluginConfigDataHandler getConfig​(java.lang.String path,
                                  java.lang.Class<?>... customClazz)
                           throws ConfigManagerException
        Get the content of the a configuration file from the Document Manager (HEAD Revision)
        Parameters:
        path - Repository path (e.g. /pubserver/com.priint.plugin.demo/config_2.1.xml)
        customClazz - class representing an XML root element defined via JAXB
        Returns:
        String content (XML) of the configuration file.
        Throws:
        ConfigManagerException

      • getConfigRevision

        PluginConfigDataHandler getConfigRevision​(java.lang.String path,
                                          java.lang.String revision,
                                          java.lang.Class<?>... customClazz)
                                   throws ConfigManagerException
        Get the content of the a specific revision of a configuration file from the Document Manager
        Parameters:
        path - Repository path (e.g. /pubserver/com.priint.plugin.demo/config_2.1.xml)
        revision - Revision number
        customClazz - class representing an XML root element defined via JAXB
        Returns:
        String content (XML) of the configuration file.
        Throws:
        ConfigManagerException

      • checkinConfig

        java.lang.String checkinConfig​(java.lang.String sessionId,
                               java.lang.String path,
                               PluginConfigDataHandler config,
                               java.lang.Class<?>... customClazz)
                        throws ConfigManagerCheckinException
        Check-in a single configuration
        Parameters:
        sessionId -
        config -
        customClazz - class representing an XML root element defined via JAXB
        Returns:
        the path of the configuration checked in
        Throws:
        ConfigManagerCheckinException

      • getConfigs

        PluginConfigCollection getConfigs​(java.lang.String folder,
                                  java.lang.Class<?>... customClazz)
                           throws ConfigManagerException
        Get a collection of config files from 'folder'.
        Parameters:
        folder - repository folder (e.g. /pubserver/com.priint.plugin.demo/myfolder/)
        customClazz - class representing an XML root element defined via JAXB
        Returns:
        Collection of config files Key: config file path in repository
        Throws:
        ConfigManagerException

      • getSubFolders

        java.util.List<java.lang.String> getSubFolders​(java.lang.String folderPath)
                                        throws ConfigManagerException
        Get List of sub folders
        Parameters:
        folderPath - repository folder (e.g. /pubserver/com.priint.plugin.demo/myfolder/)
        Returns:
        List of sub folders (path)
        Throws:
        ConfigManagerException

      • exists

        boolean exists​(java.lang.String path)
        throws ConfigManagerException
        Check whether a file or folder exists at the given path
        Parameters:
        path -
        Returns:
        true if the configuration exists
        Throws:
        ConfigManagerException

      • isAlive

        boolean isAlive​(java.lang.String path)
         throws ConfigManagerException
        Check whether a file exists AND is alive, i.e.: the file is not deleted.
        Parameters:
        path -
        Returns:
        true, if file exists and has not been tagged as deleted.
        Throws:
        ConfigManagerException

      • getPlugins

        java.util.List<PluginInfo> getPlugins​(boolean active)
                               throws ConfigManagerException
        Gets a list of all plugin libraries with their plugins and configurations.
        Parameters:
        active - if true only active plugin libraries are return, if false all plugin libraries are returned
        Returns:
        list of configurations (empty list if nothing was found)
        Throws:
        ConfigManagerException

      • getNextID

        int getNextID​(boolean useServerId)
        Read the next ID from the data source.

        Note:
        Purpose of this method is to retrieve unique IDs for a single server instance or a server instance within a deployment environment (e.g. Developing Server, Integration Server, Test Server, Productive System).
        This will only work, if each of this server has a unique instance ID.
        Please take care to configure these values properly. See Constants.PUBSERVER_NUM_INSTANCES and Constants.PUBSERVER_INSTANCE_ID for more information.

        Parameters:
        useServerId -
        Returns:
        integer containing a sequential incrementing server dependent ID

      • getConnectors

        java.util.List<java.lang.String> getConnectors()
        Get a list of connector plug-ins (i.e. string IDs of the plug-ins)
        Returns:
        a list of connector plug-ins

      • getClients

        java.util.List<Client> getClients()
        Get a list of clients (tenants)
        Returns:
        a list of clients (tenants)

      • upload

        java.lang.String upload​(java.lang.String filePath,
                        java.lang.String path,
                        ConfigFileProperties properties)
                 throws ConfigManagerException,
                        java.io.FileNotFoundException
        upload a local config file to the Repository
        Parameters:
        filePath - local system path of the config file
        path - target folder in repository
        properties - properties of the config file
        Returns:
        target path
        Throws:
        ConfigManagerException
        java.io.FileNotFoundException

      • deleteFileOrFolder

        void deleteFileOrFolder​(java.lang.String sessionId,
                        java.lang.String path,
                        boolean updateDependencies)
                 throws ConfigManagerException
        Remove files and/or folders physically from the repository
        Parameters:
        sessionId - SessionId
        path - target file or folder in repository
        updateDependencies -
        Throws:
        ConfigManagerException

      • deleteFileOrFolder

        void deleteFileOrFolder​(java.lang.String sessionId,
                        java.lang.String path)
                 throws ConfigManagerException
        Remove files and/or folders physically from the repository
        Parameters:
        sessionId - SessionId
        path - target file or folder in repository
        Throws:
        ConfigManagerException

      • checkoutConfig

        PluginConfigDataHandler checkoutConfig​(java.lang.String sessionId,
                                       java.lang.String path,
                                       java.lang.Class<?>... customClazz)
                                throws ConfigManagerCheckoutException
        Checkout a single file string
        Parameters:
        sessionId - SessionID
        path - Path to the config file in repository
        customClazz - class representing an XML root element defined via JAXB
        Returns:
        config file as String
        Throws:
        ConfigManagerCheckoutException

      • checkoutListOfConfigFiles

        PluginConfigCollection checkoutListOfConfigFiles​(java.lang.String sessionId,
                                                 java.util.List<java.lang.String> files,
                                                 java.lang.Class<?>... customClazz)
                                          throws ConfigManagerCheckoutException
        Check a list of files from the repository. The files that are checked out are locked for other users
        Parameters:
        sessionId - valid PubServer SessionID
        files - List of config files for checking out (path in repository)
        customClazz - class representing an XML root element defined via JAXB
        Throws:
        ConfigManagerCheckoutException

      • checkinListOfConfigFiles

        void checkinListOfConfigFiles​(java.lang.String sessionId,
                              PluginConfigCollection configurations,
                              boolean validateXML)
                       throws ConfigManagerCheckinException
        Check-in multiple files as string array
        Parameters:
        sessionId - SessionID
        configurations - Collection of config files as String array. Key: path to the file in repository
        validateXML - validate XML files against the PluginConfig.xsd schema
        Throws:
        ConfigManagerCheckinException

      • deleteListOfConfigFiles

        java.util.List<java.lang.String> deleteListOfConfigFiles​(java.lang.String sessionId,
                                                         java.util.List<java.lang.String> deletefiles,
                                                         boolean updateDependencies)
                                                  throws ConfigManagerDeleteException
        Delete configuration files from the provided list.
        Parameters:
        sessionId -
        deletefiles - Paths of the files to delete.
        updateDependencies - If true dependencies will be automatically updated.
        Returns:
        list of paths of files actually deleted
        Throws:
        ConfigManagerDeleteException

      • deleteListOfConfigFiles

        java.util.List<java.lang.String> deleteListOfConfigFiles​(java.lang.String sessionId,
                                                         java.util.List<java.lang.String> deletefiles)
                                                  throws ConfigManagerDeleteException
        Delete configuration files from the provided list.
        Parameters:
        sessionId -
        deletefiles - Paths of the files to delete.
        Returns:
        list of paths of files actually deleted
        Throws:
        ConfigManagerDeleteException

      • createConfiguration

        java.lang.String createConfiguration​(java.lang.String sessionId,
                                     java.lang.String pluginName,
                                     java.lang.String customTypeName,
                                     java.util.Map<java.lang.String,​java.lang.Object> initialValues)
                              throws ConfigManagerException
        Create and save a new configuration for a plug-in. The resulting configuration XML will be returned.

        The actual config creation will be delegated to the plug-in itself.

        Parameters:
        sessionId -
        pluginName - Mapped name of the plug-in. Used as first part of the full path to the configuration file.
        customTypeName - Plug-in specific type string.
        initialValues - HashMap of values to be used for the configuration creation. Interpretation of the entries is plugin specific.
        Returns:
        Created XML as string.
        Throws:
        ConfigManagerException

      • upload

        java.lang.String upload​(java.io.InputStream content,
                        java.lang.String path,
                        ConfigFileProperties properties)
                 throws ConfigManagerException
        Upload content stream to a config file at a specific location.
        Parameters:
        content - stream
        path - location
        properties - additional properties of the configuration file
        Returns:
        path
        Throws:
        ConfigManagerException

      • getAllDependencies

        java.util.List<PluginConfig.Dependencies.PluginDependency> getAllDependencies​(java.lang.String path,
                                                                              java.util.List<PluginConfig.Dependencies.PluginDependency> dependencies,
                                                                              boolean recursive)
        Read all dependencies of a configuration file.
        Parameters:
        path - of the file
        dependencies - list of known dependencies
        recursive - if true, system performs a deep traversal of dependencies
        Returns:
        List of dependencies found

      • setMinimumInitialServerId

        void setMinimumInitialServerId​(boolean useServerId,
                               int minInitialValue)
        Set the sequence initial value on this machine to minimum minInitialValue.

        Warning!
        Use this function for sanity checks only. In normal operation there should be no need to manually change the sequence value. If anything, doing so is a dangerous operation and can cause ID conflicts later.
        Calling this method can be necessary after importing repository dumps into a newly installed system (with newly initialized ID sequences). In that case you would use the following code: 

         // maximum ID calculated from the last import - in real life, this piece
 // of code will probably look more complex: 
 int maxId = 132456;
 
 ConfigManagerRemote configManager; // lookup etc.
 
 int currentSequenceId = configManager.getCurrentId(false);
 
 if (currentSequenceId < maxId) {
   // this is OK. The next time we call getNextID, the value
   // will be incremented before return:
   configManager.setMinimumInitialServerId(false, maxId);
 }
        Parameters:
        useServerId - if true, use instance name for the sequence name
        minInitialValue -

      • getCurrentId

        int getCurrentId​(boolean useServerId)
        Get the current value of this ID sequence. This is the value that was returned on the last call of getNextID(boolean) or the initial value of this sequence, if it has not been initialized yet.
        If you want to retrieve a unique ID for this server instance, use getNextID(boolean) instead.
        Parameters:
        useServerId - if true, use instance name for the sequence name
        Returns:
        the current value of sequence

      • emptyConfigTrash

        void emptyConfigTrash()
        Clears the trash bin of the repository. Files cannot be undeleted after this operation.

      • getNextIDs

        int getNextIDs​(boolean useServerId,
               int poolSize)
        Get the next value of this ID sequence.
        Parameters:
        useServerId - if true, use instance name for the sequence name
        poolSize - initial size of (untouchable) IDs
        Returns:
        the next (incremented) value of sequence