public abstract class ResourceFinderModule extends Object
ResourceFinder
modules extend. All methods have
default values to represent that the given feature isn't supported by this module, so module
writers needs only implement the methods for the features they're supporting.Constructor and Description |
---|
ResourceFinderModule() |
Modifier and Type | Method and Description |
---|---|
ResourceFinderResult |
findChildResources(AttributeValue parentResourceId)
Deprecated.
As of version 1.2, replaced by
findChildResources(AttributeValue,EvaluationCtx) . This version does not
provide the evaluation context, and will be removed in a future release. Also,
not that this will never get called when using the default PDP. |
ResourceFinderResult |
findChildResources(AttributeValue parentResourceId,
EvaluationCtx context)
Tries to find the child Resource Ids associated with the parent.
|
ResourceFinderResult |
findDescendantResources(AttributeValue parentResourceId)
Deprecated.
As of version 1.2, replaced by
findDescendantResources(AttributeValue,EvaluationCtx) . This version does
not provide the evaluation context, and will be removed in a future release.
Also, not that this will never get called when using the default PDP. |
ResourceFinderResult |
findDescendantResources(AttributeValue parentResourceId,
EvaluationCtx context)
Tries to find the descendant Resource Ids associated with the parent.
|
String |
getIdentifier()
Returns this module's identifier.
|
void |
invalidateCache()
This is an experimental method that asks the module to invalidate any cache values it may
contain.
|
boolean |
isChildSupported()
Returns true if this module supports finding resources with the "Children" scope.
|
boolean |
isDescendantSupported()
Returns true if this module supports finding resources with the "Descendants" scope.
|
public String getIdentifier()
public boolean isChildSupported()
public boolean isDescendantSupported()
public void invalidateCache()
This method has been introduced to see what people think of this functionality, and how they would like to use it. It may be removed in future versions, or it may be changed to a more general message-passing system (if other useful messages are identified).
public ResourceFinderResult findChildResources(AttributeValue parentResourceId, EvaluationCtx context)
parentResourceId
- the parent resource identifiercontext
- the representation of the request datapublic ResourceFinderResult findChildResources(AttributeValue parentResourceId)
findChildResources(AttributeValue,EvaluationCtx)
. This version does not
provide the evaluation context, and will be removed in a future release. Also,
not that this will never get called when using the default PDP.parentResourceId
- the parent resource identifierpublic ResourceFinderResult findDescendantResources(AttributeValue parentResourceId, EvaluationCtx context)
parentResourceId
- the parent resource identifiercontext
- the representation of the request datapublic ResourceFinderResult findDescendantResources(AttributeValue parentResourceId)
findDescendantResources(AttributeValue,EvaluationCtx)
. This version does
not provide the evaluation context, and will be removed in a future release.
Also, not that this will never get called when using the default PDP.parentResourceId
- the parent resource identifierCopyright © 2020 WSO2. All rights reserved.