Permission

All Known Implementing Classes:

Permission.Implementation
```
public interface Permission
```
The type representing an permission information for a specific Resource instance.
Every permission has a "factor" value that represents the type and weight of the permission. A negative value (< 0) means denial of access to the resource (or negative permission), a non-negative value (>= 0) means permission of access to the resource (or positive permission). The higher the absolute value of a factor, the higher is its "weight" or priority compared to conflicting permissions defined in other roles. The default factor is 0, so in the simple case of just granting a permission, the user does not have to care about factors at all.

Author:

XDEV Software (TM)

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Permission.Implementation
Simple default implementation of a Permission.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Permission.Implementation` Simple default implementation of a `Permission`.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`evaluate(Subject subject)` Evaluates if the passed `Subject` instance is granted access to the `Resource` instance associated with this `Permission` instance.
`int`	`factor()` The factor of this `Permission` instance.
`static Permission`	`New(Resource resource)` Creates a new `Permission` instance for the passed `Resource` instance and a default factor of 0.
`static Permission`	`New(Resource resource, int factor)` Creates a new `Permission` instance for the passed `Resource` instance and the passed factor.
`Resource`	`resource()` The resource whose access this `Permission` instance describes.

- Method Detail
  - resource
```
Resource resource()
```
    The resource whose access this Permission instance describes.
    
    Returns:
    
    the associated Resource instance.
  - factor
```
int factor()
```
    The factor of this Permission instance. See Permission for details.
    
    Returns:
    
    the factor of this Permission instance.
  - evaluate
```
default boolean evaluate(Subject subject)
```
    Evaluates if the passed Subject instance is granted access to the Resource instance associated with this Permission instance. Custom implementations of this method can use arbitrary complex logic to perform the evaluation.
    
    Parameters:
    
    subject - the Subject instance to be evaluated.
    
    Returns:
    
    whether or not the Subject instance is granted access to this instance's Resource.
  - New
```
static Permission New(Resource resource,
                      int factor)
```
    Creates a new Permission instance for the passed Resource instance and the passed factor. Note that factor can be any value, no restriction or validation is wanted in the default implementation.
    
    Parameters:
    
    resource - the resource to be associated with the Permission instance.
    
    factor - the value used as the Permission instance's factor.
    
    Returns:
    
    a new Permission instance for the passed values.
  - New
```
static Permission New(Resource resource)
```
    Creates a new Permission instance for the passed Resource instance and a default factor of 0.
    
    Parameters:
    
    resource - resource the resource to be associated with the Permission instance.
    
    Returns:
    
    a new Permission instance for the passed values.

Interface Permission

Nested Class Summary

Method Summary

Method Detail

resource

factor

evaluate

New

New