Interface ResourceStore

    • Method Detail

      • create

        default Resource create​(ResourceServer resourceServer,
                                String name,
                                String owner)

        Creates a Resource instance backed by this persistent storage implementation.

        Parameters:
        resourceServer - the resource server to where the given resource belongs to
        name - the name of this resource. It must be unique.
        owner - the owner of this resource or null if the resource server is the owner
        Returns:
        an instance backed by the underlying storage implementation
      • create

        Resource create​(ResourceServer resourceServer,
                        String id,
                        String name,
                        String owner)

        Creates a Resource instance backed by this persistent storage implementation.

        Parameters:
        resourceServer - the resource server to where the given resource belongs to
        id - the id of this resource. It must be unique. Will be randomly generated if null.
        name - the name of this resource. It must be unique.
        owner - the owner of this resource or null if the resource server is the owner
        Returns:
        an instance backed by the underlying storage implementation
      • delete

        void delete​(String id)
        Removes a Resource instance, with the given id from the persistent storage.
        Parameters:
        id - the identifier of an existing resource instance
      • findById

        Resource findById​(ResourceServer resourceServer,
                          String id)
        Returns a Resource instance based on its identifier.
        Parameters:
        resourceServer - the resource server
        id - the identifier of an existing resource instance
        Returns:
        the resource instance with the given identifier or null if no instance was found
      • findByOwner

        default List<Resource> findByOwner​(ResourceServer resourceServer,
                                           String ownerId)
        Finds all Resource instances with the given ownerId.
        Parameters:
        resourceServer -
        ownerId - the identifier of the owner
        Returns:
        a list with all resource instances owned by the given owner
      • findByUri

        List<Resource> findByUri​(ResourceServer resourceServer,
                                 String uri)
        Finds all Resource instances with the given uri.
        Parameters:
        resourceServer -
        uri - the identifier of the uri
        Returns:
        a list with all resource instances owned by the given owner
      • findByResourceServer

        List<Resource> findByResourceServer​(ResourceServer resourceServer)
        Finds all Resource instances associated with a given resource server.
        Parameters:
        resourceServer - the identifier of the resource server
        Returns:
        a list with all resources associated with the given resource server
      • findByResourceServer

        List<Resource> findByResourceServer​(ResourceServer resourceServer,
                                            Map<Resource.FilterOption,​String[]> attributes,
                                            Integer firstResult,
                                            Integer maxResults)
        Finds all Resource instances associated with a given resource server.
        Parameters:
        resourceServer - the identifier of the resource server
        attributes - a map holding the attributes that will be used as a filter; possible filter options are given by Resource.FilterOption
        firstResult - first result to return. Ignored if negative or null.
        maxResults - maximum number of results to return. Ignored if negative or null.
        Returns:
        a list with all resources associated with the given resource server
        Throws:
        IllegalArgumentException - when there is an unknown attribute in the attributes map
      • findByScopes

        default List<Resource> findByScopes​(ResourceServer resourceServer,
                                            Set<Scope> scopes)
        Finds all Resource associated with a given scope.
        Parameters:
        resourceServer -
        scopes - one or more scope identifiers
        Returns:
        a list of resources associated with the given scope(s)
      • findByName

        default Resource findByName​(ResourceServer resourceServer,
                                    String name)
        Find a Resource by its name where the owner is the resource server itself.
        Parameters:
        resourceServer - the resource server
        name - the name of the resource
        Returns:
        a resource with the given name
      • findByName

        Resource findByName​(ResourceServer resourceServer,
                            String name,
                            String ownerId)
        Find a Resource by its name where the owner is the given ownerId.
        Parameters:
        resourceServer - the identifier of the resource server
        name - the name of the resource
        ownerId - the owner id
        Returns:
        a resource with the given name
      • findByType

        default List<Resource> findByType​(ResourceServer resourceServer,
                                          String type)
        Finds all Resource with the given type.
        Parameters:
        resourceServer -
        type - the type of the resource
        Returns:
        a list of resources with the given type
      • findByType

        default List<Resource> findByType​(ResourceServer resourceServer,
                                          String type,
                                          String owner)
        Finds all Resource with the given type.
        Parameters:
        resourceServer -
        type - the type of the resource
        owner - the resource owner or null for any resource with a given type
        Returns:
        a list of resources with the given type
      • findByType

        void findByType​(ResourceServer resourceServer,
                        String type,
                        Consumer<Resource> consumer)
        Finds all Resource with the given type.
        Parameters:
        resourceServer - the resource server id
        type - the type of the resource
        consumer - the result consumer
      • findByType

        void findByType​(ResourceServer resourceServer,
                        String type,
                        String owner,
                        Consumer<Resource> consumer)
        Finds all Resource with the given type.
        Parameters:
        resourceServer - the resource server id
        type - the type of the resource
        owner - the resource owner or null for any resource with a given type
        consumer - the result consumer