DotNamedPermission (UberFire Security API 1.1.0.Beta2 API)

java.lang.Object
- org.uberfire.security.impl.authz.DotNamedPermission

All Implemented Interfaces:

Comparable<Permission>, Permission
```
@Portable
public class DotNamedPermission
extends Object
implements Permission, Comparable<Permission>
```
An implementation where the permission's name is formatted using dots. For instance:
- resource.view => View all resources
- resource.view.r1 => View only r1
The implies(Permission other) implementation is based on the simple fact that one permission implies another just if its name starts with the another's name. This very simple mechanism can be applied to most of the resources that require authorization control, like for instance, workbench perspectives, a file system, etc.

Constructor Summary

Constructors
Constructor and Description
`DotNamedPermission()`
`DotNamedPermission(String name)`
`DotNamedPermission(String name, AuthorizationResult result)`
`DotNamedPermission(String name, Boolean granted)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_checkImmutability()`
`protected void`	`_enableImmutability()`
`Permission`	`clone()` Creates an exact copy of this instance.
`int`	`compareTo(Permission o)`
`boolean`	`equals(Object obj)`
`boolean`	`equalsName(Permission other)`
`boolean`	`equalsResult(Permission other)`
`String`	`getName()` A string literal that identifies a resource or set of resources this permission object relates to.
`AuthorizationResult`	`getResult()` The authorization result or permission status.
`boolean`	`implies(Permission other)` Basically, "permission p1 implies permission p2" means that if one is granted permission p1, one is naturally granted permission p2.
`boolean`	`impliesName(Permission other)` If "permission p1 impliesName permission p2" means that the feature represented by p1 is a superset of p2.
`boolean`	`impliesResult(Permission other)` If "permission p1 impliesResult permission p2" means that both permissions give the same result.
`<T extends DotNamedPermission> T`	`nonMutable()`
`void`	`setName(String name)`
`void`	`setResult(AuthorizationResult result)` Change the authorzation result.
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DotNamedPermission
```
public DotNamedPermission()
```
  - DotNamedPermission
```
public DotNamedPermission(String name)
```
  - DotNamedPermission
```
public DotNamedPermission(String name,
                          Boolean granted)
```
  - DotNamedPermission
```
public DotNamedPermission(String name,
                          AuthorizationResult result)
```
- Method Detail
  - _enableImmutability
```
protected void _enableImmutability()
```
  - _checkImmutability
```
protected void _checkImmutability()
```
  - nonMutable
```
public <T extends DotNamedPermission> T nonMutable()
```
  - getName
```
public String getName()
```
    Description copied from interface: Permission
    
    A string literal that identifies a resource or set of resources this permission object relates to.
    It's up to every Permission implementation to define what's the set the name's format.
    
    Specified by:
    
    getName in interface Permission
  - setName
```
public void setName(String name)
```
  - getResult
```
public AuthorizationResult getResult()
```
    Description copied from interface: Permission
    
    The authorization result or permission status.
    
    Specified by:
    
    getResult in interface Permission
    
    Returns:
    
    One of the available results: GRANT / DENY / ABSTAIN
  - setResult
```
public void setResult(AuthorizationResult result)
```
    Description copied from interface: Permission
    
    Change the authorzation result.
    
    Specified by:
    
    setResult in interface Permission
    
    Parameters:
    
    result - GRANT / DENY / ABSTAIN
  - implies
```
public boolean implies(Permission other)
```
    Description copied from interface: Permission
    
    Basically, "permission p1 implies permission p2" means that if one is granted permission p1, one is naturally granted permission p2. Thus, this is not an equality test, but rather more of a subset test.
    
    Both calls to Permission.impliesName(Permission) & Permission.impliesResult(Permission) return true.
    
    Specified by:
    
    implies in interface Permission
    
    Parameters:
    
    other - the permission to check against.
    
    Returns:
    
    true if the specified permission is implied by this object, false if not.
  - impliesName
```
public boolean impliesName(Permission other)
```
    Description copied from interface: Permission
    
    If "permission p1 impliesName permission p2" means that the feature represented by p1 is a superset of p2.
    
    Specified by:
    
    impliesName in interface Permission
    
    Parameters:
    
    other - the permission to check against.
    
    Returns:
    
    true if the specified permission name is implied by this object, false if not.
  - impliesResult
```
public boolean impliesResult(Permission other)
```
    Description copied from interface: Permission
    
    If "permission p1 impliesResult permission p2" means that both permissions give the same result.
    
    Specified by:
    
    impliesResult in interface Permission
    
    Parameters:
    
    other - the permission to check against.
    
    Returns:
    
    true if the specified permission result is implied by this object, false if not.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsName
```
public boolean equalsName(Permission other)
```
  - equalsResult
```
public boolean equalsResult(Permission other)
```
  - compareTo
```
public int compareTo(Permission o)
```
    Specified by:
    
    compareTo in interface Comparable<Permission>
  - clone
```
public Permission clone()
```
    Description copied from interface: Permission
    
    Creates an exact copy of this instance.
    
    Specified by:
    
    clone in interface Permission
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    A brand new Permission instance
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DotNamedPermission

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DotNamedPermission

DotNamedPermission

DotNamedPermission

DotNamedPermission

Method Detail

_enableImmutability

_checkImmutability

nonMutable

getName

setName

getResult

setResult

implies

impliesName

impliesResult

equals

equalsName

equalsResult

compareTo

clone

toString