com.ibm.xdms.function
Interface Authorization
- All Superinterfaces:
- Function
public interface Authorization
- extends Function
This helper function class is used to determine authorization to a particular
document.
Method Summary |
boolean |
hasPermission(com.ibm.xcap.DocumentSelector documentSelector,
java.security.Principal principal,
int permission,
boolean isAnonymousUser)
Determines whether a user has a permission to a specific document. |
void |
invalidatePermissionsFromCache(com.ibm.xcap.DocumentSelector docSelector)
Invalidates all permissions associated with a specific ACL
DocumentSelector |
COPYRIGHT
static final java.lang.String COPYRIGHT
PERMISSION_ADMIN
static final int PERMISSION_ADMIN
- See Also:
- Constant Field Values
PERMISSION_READ
static final int PERMISSION_READ
- See Also:
- Constant Field Values
PERMISSION_WRITE
static final int PERMISSION_WRITE
- See Also:
- Constant Field Values
PERMISSION_DELETE
static final int PERMISSION_DELETE
- See Also:
- Constant Field Values
PERMISSIONS
static final int[] PERMISSIONS
PROPERTY_ENABLE_STANDARD_AUTH
static final java.lang.String PROPERTY_ENABLE_STANDARD_AUTH
- See Also:
- Constant Field Values
hasPermission
boolean hasPermission(com.ibm.xcap.DocumentSelector documentSelector,
java.security.Principal principal,
int permission,
boolean isAnonymousUser)
throws XdmsException
- Determines whether a user has a permission to a specific document.
- Parameters:
documentSelector
- The document selector that identifies the
documentprincipal
- The user to check against.permission
- The permission to check for.isAnonymousUser
- Boolean that indicates whether the principal is an
anonymous user
- Returns:
- Return true if the permission has been granted to the user for
the specific document.
- Throws:
XdmsException
invalidatePermissionsFromCache
void invalidatePermissionsFromCache(com.ibm.xcap.DocumentSelector docSelector)
throws XdmsException
- Invalidates all permissions associated with a specific ACL
DocumentSelector
- Parameters:
docSelector
- The DocumentSelector of an ACL
- Throws:
XdmsException