@ProviderType
public interface Filter
Modifier and Type | Method and Description |
---|---|
boolean |
canHandle(@NotNull java.util.Set<java.security.Principal> principals)
Reveals if this filter implementation is able to handle the given set of principals.
|
@NotNull java.lang.String |
getOakPath(@NotNull java.security.Principal validPrincipal)
Returns the Oak path of the
Tree to which the policy for the given validPrincipal will be bound. |
@Nullable java.security.Principal |
getValidPrincipal(@NotNull java.lang.String oakPath)
Retrieves the
ItemBasedPrincipal for the given oakPath
and returns it if it is considered valid by the Filter implementation. |
boolean canHandle(@NotNull @NotNull java.util.Set<java.security.Principal> principals)
principals
- A set of principals.true
if the principals can be dealt with by this filter implementation, false
otherwise.@NotNull @NotNull java.lang.String getOakPath(@NotNull @NotNull java.security.Principal validPrincipal)
Tree
to which the policy for the given validPrincipal
will be bound.
This method can rely on the fact that the given principal has been validated
before and is
not expected to validate the principal.validPrincipal
- A valid principal i.e. that has been validated through canHandle(Set)
.Tree
. The policy for the given principal will be bound to that tree.java.lang.IllegalArgumentException
- If the specified principal is not validated/valid.@Nullable @Nullable java.security.Principal getValidPrincipal(@NotNull @NotNull java.lang.String oakPath)
ItemBasedPrincipal
for the given oakPath
and returns it if it is considered valid by the Filter
implementation. Otherwise this method returns
null
.oakPath
- A non-null Oak path pointing to an ItemBasedPrincipal
.null
if no valid principal can be retrieved/exists for the given path.Copyright © 2012–2022 The Apache Software Foundation. All rights reserved.