de.frame4j.security

Class Permit

java.lang.Object

java.security.Permission

de.frame4j.security.Permit

All Implemented Interfaces:

Serializable, Guard

@MinDoc(copyright="Copyright 2000 - 2003, 2009  A. Weinert",
        author="Albrecht Weinert",
        version="V.11",
        lastModified="5.02.2019",
        lastModifiedBy="A. Weinert",
        usage="use for a permission / operation and its execution",
        purpose="a permission / a right to act")
public class Permit
extends Permission
implements Serializable

A permission / a right to act.

An object of this class represents a certain right (to act) or a permission (Permission).

A Permit is identified by a (full) name as returned by toString(). The uniqueness of this identification should be maintained by the users of / factories for this class, as is the case with ACLentry.

Optionally a permit may have a target object, usually also uniquely named. The targets being Principals ensures their having a name. If there is a target, its name will be part of this Permit's full name in the form "targetname:purePermitName".

If having such target plus the pure permission's name getPureName() as operation the Permit object itself also embodies the action / operation, to which it is the permission:
Permission (Permit) = action
If the target is of the type Permit.Operable, the method invoke() executes this action / operation.


Copyright 2003, 2009 Albrecht Weinert

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Permit.Operable Controllable (remotely) function unit.

Field Summary

Fields

Modifier and Type	Field and Description
String	asLowerString The permission's or act's full name in lower case.
String	asString The permission's or act's full name.
int	hash The prmissions's hash value.
Principal	target The target object of the act / permission.

Constructor Summary

Constructors

Constructor and Description
Permit(CharSequence name, Principal target) Constructor with name and target.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Equality with other Permit.
String	getActions()
String	getPureName() The permission's or act's pure name.
Principal	getTarget() The target object of the act / permission.
int	hashCode() The prmissions's hash value.
boolean	implies(Permission permission)
String	invoke() Execute the operation / action / permit (if possible and allowed).
String	toString() The permission's or action's name.

Methods inherited from class java.security.Permission

checkGuard, getName, newPermissionCollection

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

asString

public final String asString

The permission's or act's full name.

See Also:

toString()

asLowerString

public final String asLowerString

The permission's or act's full name in lower case.


null or empty is impossible (by constructor's rules).

target

public final Principal target

The target object of the act / permission.

This may be null.

hash

public final int hash

The prmissions's hash value.

Constructor Detail

Permit

public Permit(CharSequence name,
              Principal target)
       throws IllegalArgumentException

Constructor with name and target.

Parameters:

name - The (in most contexts unique) name of the permission.
It must not be empty.

target - The (optional) target. That may be null.

Throws:

IllegalArgumentException - if violation the rules

Method Detail

implies

public boolean implies(Permission permission)

Specified by:

implies in class Permission

getActions

public String getActions()

Specified by:

getActions in class Permission

toString

public final String toString()

The permission's or action's name.

The full name is returned. It may contain the target's name also.

null or empty is impossible (by constructor's rules).

Overrides:

toString in class Permission

getPureName

public final String getPureName()

The permission's or act's pure name.

See Also:

toString()

getTarget

public final Principal getTarget()

The target object of the act / permission.

This may be null.

hashCode

public final int hashCode()

The prmissions's hash value.

Specified by:

hashCode in class Permission

equals

public final boolean equals(Object other)

Equality with other Permit.

This method returns true, if the other object is of type Permit and has the same designation (ignoring case).

Specified by:

equals in class Permission

See Also:

hashCode(), asLowerString

invoke

public String invoke()

Execute the operation / action / permit (if possible and allowed).

This method does nothing and just returns ACLentry.REFUSED, if the target is not of type Permit.Operable. If this permission was taken from a negative or prohibition list (see. ACLentry), this method should not be called.

Otherwise target.clientOrder(pureName) will be called and the result (including Exceptions if any) will just be forwarded to this method's caller.