public interface ResourceFinder
Modifier and Type | Method and Description |
---|---|
ResourceEntry |
getResource(java.lang.String resourceTypeName, java.lang.String name)
Get the resource given the name and the type of the resource.
|
java.util.List<ResourceEntry> |
getResources(java.lang.String resourceTypeName, ResourceSearchQuery query)
Search for resources based on SearchQuery.
|
java.util.List<ResourceSearchQuery.SEARCH_PROPERTY> |
getSearchableAttributes()
Returns a list of query attributes that are supported by the underlying resource store.
|
void |
initialize(java.util.Map<java.lang.String,java.lang.String> props)
This method is called by JPS before calling any other methods on the Finder.
|
java.util.List<ResourceEntry> getResources(java.lang.String resourceTypeName, ResourceSearchQuery query) throws PolicyStoreException, PolicyStoreOperationNotAllowedException, ResourceFinderException
ResourceEntry.getResourceTypeName().equalsIgnoreCase(resourceTypeName) == true;
must hold for every resource entry returned.resourceTypeName
- resource type name, must not be null.query
- -- the search criteria for searching resources, must not be null. ResourceSerachQuery.SEARCH_PROPERTY.RESOURCE_TYPE
must not be specified in query.PolicyStoreException
- if there was an error while searching for the resource.PolicyStoreOperationNotAllowedException
- -- if the resource finder is unable to handle the search query -- e.g., attribute to search on is not supported, or criteria such as 'beginsWith', 'endsWith' etc. are not supported.InvalidArgumentException
- if query is null.ResourceFinderException
ResourceEntry getResource(java.lang.String resourceTypeName, java.lang.String name) throws PolicyStoreException, PolicyObjectNotFoundException
ResourceEntry.getResourceTypeName().equalsIgnoreCase(resourceTypeName) == true;
must hold for the resource entry returned.resourceTypeName
- -- name of the resource type (to restrict the search to a resource type)name--
- name of the resource (to be found).PolicyStoreException
- if there was an error while searching for the resource.PolicyObjectNotFoundException
- if the resource with given name and type does not exit.ResourceFinderException
- if resource type cannot be found.void initialize(java.util.Map<java.lang.String,java.lang.String> props) throws ResourceFinderException
ResourceFinder
implementation must ensure that the set of properties presented in this method match with the properties the implementation expects. If there's a mismatch the implementation should throw a ResourceFinderException
exception.SEARCH_PROPERTY
values(See method getSearchableAttributes()).props
- - a map of properties required to initialize the Resource Finder. These are configured during registration of the finder.ResourceFinderException
- - if the method fails to initialize ResourceFinder.java.util.List<ResourceSearchQuery.SEARCH_PROPERTY> getSearchableAttributes()
getResources(String resourceTypeName, ResourceSearchQuery query)
with ResourceSearchQuery query
that conforms to the set of supported query properties (attributes).