Package de.aristaflow.adept2.core.globalprovider

Interface GlobalUserConfiguration

  • public interface GlobalUserConfiguration
    The global user configuration manages global and user-specific configurations that should apply system-wide, e. g. user-specific settings for all clients. Each configuration has a namespace to allow for easily distinguishing configurations.

    • Method Detail

      • getGlobalNamespaces

        Set<String> getGlobalNamespaces​(SessionToken session)
        Gets all namespaces for which global configurations are defined.
        Parameters:
        session - The session which is used to check for access rights on this method.
        Returns:
        All configuration namespaces that are defined globally or an empty set.

      • getGlobalNamespacesIterator

        RemoteIterator<List<String>> getGlobalNamespacesIterator​(SessionToken session)
        The same as getGlobalNamespaces(SessionToken) but with partial retrieval of the entities.
        Parameters:
        session - The session which is used to check for access rights on this method.
        Returns:
        All configuration namespaces that are defined globally as iterator. The caller is responsible for closing.

      • getNamespaces

        Set<String> getNamespaces​(SessionToken session,
                          long agentId,
                          long orgPosId)
        Gets all namespaces for which configurations are defined for the designated agent.
        Parameters:
        session - The session which is used to check for access rights on this method.
        agentId - The ID of the agent of whom to retrieve the available namespaces.
        orgPosId - The org position ID of the agent of whom to retrieve the available namespaces.
        Returns:
        All configuration namespaces that are defined for the designated agent or an empty set.
        Throws:
        ServiceAccessControlException - If the designated session token does not apply for accessing the configuration of the designated user (i. e. the user or a Capabilities.SUPERVISOR_ROLE), a ServiceAccessControlException will be thrown.

      • getNamespacesIterator

        RemoteIterator<List<String>> getNamespacesIterator​(SessionToken session,
                                                   long agentId,
                                                   long orgPosId)
        The same as getNamespaces(SessionToken, long, long) but with partial retrieval of the entities.
        Parameters:
        session - The session which is used to check for access rights on this method.
        agentId - The ID of the agent of whom to retrieve the available namespaces.
        orgPosId - The org position ID of the agent of whom to retrieve the available namespaces.
        Returns:
        All configuration namespaces that are defined for the designated agent as iterator. The caller is responsible for closing.
        Throws:
        ServiceAccessControlException - If the designated session token does not apply for accessing the configuration of the designated user (i. e. the user or a Capabilities.SUPERVISOR_ROLE), a ServiceAccessControlException will be thrown.

      • getGlobalConfiguration

        Configuration getGlobalConfiguration​(SessionToken session,
                                     String namespace)
        Gets the global configuration for the designated namespace.
        Parameters:
        session - The session which is used to check for access rights on this method.
        namespace - The namespace for which to retrieve the global configuration. This must neither be null nor an empty string.
        Returns:
        The global configuration for the designated namespace. This will be null if the designated namespaces is unknown.

      • setGlobalConfiguration

        void setGlobalConfiguration​(SessionToken session,
                            String namespace,
                            Configuration conf)
        Sets the designated global configuration for the designated namespace.
        Parameters:
        session - The session which is used to check for access rights on this method.
        namespace - The namespace for which to set the designated configuration. This must neither be null nor an empty string.
        conf - The configuration which to set globally for the designated namespace. Use null to delete the configuration (and the designated namespace).
        Throws:
        ServiceAccessControlException - If the designated session token does not apply for setting the configuration of the designated user (i. e. an authorised user or a Capabilities.SUPERVISOR_ROLE), a ServiceAccessControlException will be thrown.

      • getConfiguration

        Configuration getConfiguration​(SessionToken session,
                               String namespace,
                               long agentId,
                               long orgPosId)
        Gets the configuration for the designated agent and the designated namespace.
        Parameters:
        session - The session which is used to check for access rights on this method.
        namespace - The namespace for which to retrieve the configuration. This must neither be null nor an empty string.
        agentId - The ID of the agent of whom to retrieve the designated configuration.
        orgPosId - The org position ID of the agent of whom to retrieve the designated configuration.
        Returns:
        The configuration for the designated agent and the designated namespace. This will be null if the designated namespace is unknown.
        Throws:
        ServiceAccessControlException - If the designated session token does not apply for accessing the configuration of the designated user (i. e. the user or a Capabilities.SUPERVISOR_ROLE), a ServiceAccessControlException will be thrown.

      • setConfiguration

        void setConfiguration​(SessionToken session,
                      String namespace,
                      long agentId,
                      long orgPosId,
                      Configuration conf)
        Sets the designated configuration for the designated agent and the designated namespace.
        Parameters:
        namespace - The namespace for which to set the designated configuration. This must neither be null nor an empty string.
        session - The session which is used to check for access rights on this method.
        agentId - The ID of the agent of whom to set the designated configuration.
        orgPosId - The org position ID of the agent of whom to set the designated configuration.
        conf - The configuration which to set for the designated agent and the designated namespace. Use null to delete the configuration (and the designated namespace).
        Throws:
        ServiceAccessControlException - If the designated session token does not apply for accessing the configuration of the designated user (i. e. the user or a Capabilities.SUPERVISOR_ROLE), a ServiceAccessControlException will be thrown.