Class ProxyRepository

    • Constructor Detail

      • ProxyRepository

        public ProxyRepository​(RepositoryFactory factory)
        Creates a proxy for the repository (or repositories) accessible through the given factory.
        Parameters:
        factory - repository factory
      • ProxyRepository

        public ProxyRepository​(java.util.Map<java.lang.String,​java.lang.String> parameters)
        Creates a proxy for the repository (or repositories) accessible using the given repository parameters.
        Parameters:
        parameters - repository parameters
      • ProxyRepository

        public ProxyRepository​(java.lang.String uri)
        Creates a proxy for the repository accessible using the given repository URI.
        Parameters:
        uri - repository URI
    • Method Detail

      • getDescriptorKeys

        public java.lang.String[] getDescriptorKeys()
        Returns the descriptor keys of the proxied repository, or an empty array if the proxied repository can not be accessed.
        Returns:
        descriptor keys (possibly empty)
      • isSingleValueDescriptor

        public boolean isSingleValueDescriptor​(java.lang.String key)
        Checks whether the given key identifies a valid single-valued descriptor key in the proxied repository. Returns false if the proxied repository can not be accessed.
        Parameters:
        key - a descriptor key.
        Returns:
        true if the key identifies a valid single-valued descriptor in the proxied repository, false otherwise
      • getDescriptor

        public java.lang.String getDescriptor​(java.lang.String key)
        Returns the descriptor with the given key from the proxied repository. Returns null if the descriptor does not exist or if the proxied repository can not be accessed.
        Parameters:
        key - descriptor key
        Returns:
        descriptor value, or null
      • getDescriptorValue

        public Value getDescriptorValue​(java.lang.String key)
        Returns the value of the descriptor with the given key from the proxied repository. Returns null if the descriptor does not exist or if the proxied repository can not be accessed.
        Parameters:
        key - descriptor key
        Returns:
        descriptor value, or null
      • getDescriptorValues

        public Value[] getDescriptorValues​(java.lang.String key)
        Returns the values of the descriptor with the given key from the proxied repository. Returns null if the descriptor does not exist or if the proxied repository can not be accessed.
        Parameters:
        key - descriptor key
        Returns:
        descriptor values, or null
      • login

        public Session login​(Credentials credentials,
                             java.lang.String workspace)
                      throws RepositoryException
        Logs in to the proxied repository and returns the resulting session.

        Note that the Session.getRepository() method of the resulting session will return the proxied repository, not this repository proxy!

        Parameters:
        credentials - The credentials of the user
        workspace - the name of a workspace.
        Returns:
        a valid session for the user to access the repository.
        Throws:
        RepositoryException - if the proxied repository can not be accessed, or if the login in the proxied repository fails