javolution.context

Class SecurityContext

java.lang.Object

javolution.context.AbstractContext

javolution.context.SecurityContext

public abstract class SecurityContext
extends AbstractContext

A high-level security context integrated with OSGi.

When granting/revoking permission the order is important. For example, the following code revokes all configurable permissions except for setting the concurrency level.

 SecurityContext ctx = SecurityContext.enter(); 
 try {
     ctx.revoke(Configurable.RECONFIGURE_PERMISSION);
     ctx.grant(ConcurrentContext.CONCURRENCY.getReconfigurePermission());
     ...
     ConcurrentContext.CONCURRENCY.reconfigure(0); // Ok (permission specifically granted).
     ...
  } finally {
     ctx.exit(); // Back to previous security settings. 
  }

Version:

6.0, July 21, 2013

Author:

Jean-Marie Dautelle

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecurityContext.Permission<T> A permission associated to a specific class/action/instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SecurityContext() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static void	check(SecurityContext.Permission<?> permission) Checks if the specified permission is granted.
static SecurityContext	enter() Enters and returns a new security context instance.
void	grant(SecurityContext.Permission<?> permission) Grants the specified permission (convenience method).
abstract void	grant(SecurityContext.Permission<?> permission, Object certificate) Grants the specified permission.
abstract boolean	isGranted(SecurityContext.Permission<?> permission) Indicates if the specified permission is granted.
void	revoke(SecurityContext.Permission<?> permission) Revokes the specified permission (convenience method).
abstract void	revoke(SecurityContext.Permission<?> permission, Object certificate) Revokes the specified permission.

Methods inherited from class javolution.context.AbstractContext

current, current, enter, enterInner, exit, getOuter, inherit, inner

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecurityContext

protected SecurityContext()

Default constructor.

Method Detail

enter

public static SecurityContext enter()

Enters and returns a new security context instance.

Returns:

the new security context implementation entered.

check

public static void check(SecurityContext.Permission<?> permission)

Checks if the specified permission is granted.

Parameters:

permission - the permission to check.

Throws:

SecurityException - if the specified permission is not granted.

isGranted

public abstract boolean isGranted(SecurityContext.Permission<?> permission)

Indicates if the specified permission is granted.

Parameters:

permission - the permission to check.

grant

public abstract void grant(SecurityContext.Permission<?> permission,
         Object certificate)

Grants the specified permission.

Parameters:

permission - the permission to grant.

certificate - the certificate used to grant that permission or null if none.

Throws:

SecurityException - if the specified permission cannot be granted.

revoke

public abstract void revoke(SecurityContext.Permission<?> permission,
          Object certificate)

Revokes the specified permission.

Parameters:

permission - the permission to grant.

certificate - the certificate used to grant that permission or null if none.

Throws:

SecurityException - if the specified permission cannot be revoked.

grant

public final void grant(SecurityContext.Permission<?> permission)

Grants the specified permission (convenience method).

Parameters:

permission - the permission to grant.

Throws:

SecurityException - if the specified permission cannot be granted.

revoke

public final void revoke(SecurityContext.Permission<?> permission)

Revokes the specified permission (convenience method).

Parameters:

permission - the permission to grant.

Throws:

SecurityException - if the specified permission cannot be revoked.