OSGi™ Service Platform
Release 4

org.osgi.service.condpermadmin
Interface Condition

All Known Implementing Classes:
UserPromptCondition

public interface Condition

The interface implemented by a Condition. Conditions are bound to Permissions using Conditional Permission Info. The Permissions of a ConditionalPermission Info can only be used if the associated Conditions are satisfied.


Field Summary
static Condition FALSE
          A Condition object that will always evaluate to false and that is never postponed.
static Condition TRUE
          A Condition object that will always evaluate to true and that is never postponed.
 
Method Summary
 boolean isMutable()
          Returns whether the Condition is mutable.
 boolean isPostponed()
          Returns whether the evaluation must be postponed until the end of the permission check.
 boolean isSatisfied()
          Returns whether the Condition is satisfied.
 boolean isSatisfied(Condition[] conditions, java.util.Dictionary context)
          Returns whether a the set of Conditions are satisfied.
 

Field Detail

TRUE

public static final Condition TRUE
A Condition object that will always evaluate to true and that is never postponed.


FALSE

public static final Condition FALSE
A Condition object that will always evaluate to false and that is never postponed.

Method Detail

isPostponed

public boolean isPostponed()
Returns whether the evaluation must be postponed until the end of the permission check. This method returns true if the evaluation of the Condition must be postponed until the end of the permission check. If this method returns false, this Condition must be able to directly answer the isSatisfied() method. In other words, isSatisfied() will return very quickly since no external sources, such as for example users, need to be consulted.

Returns:
true to indicate the evaluation must be postponed. Otherwise, false if the evaluation can be immediately performed.

isSatisfied

public boolean isSatisfied()
Returns whether the Condition is satisfied.

Returns:
true to indicate the Conditions is satisfied. Otherwise, false if the Condition is not satisfied.

isMutable

public boolean isMutable()
Returns whether the Condition is mutable.

Returns:
true to indicate the value returned by isSatisfied() can change. Otherwise, false if the value returned by isSatisfied() will not change.

isSatisfied

public boolean isSatisfied(Condition[] conditions,
                           java.util.Dictionary context)
Returns whether a the set of Conditions are satisfied. Although this method is not static, it must be implemented as if it were static. All of the passed Conditions will be of the same type and will correspond to the class type of the object on which this method is invoked.

Parameters:
conditions - The array of Conditions.
context - A Dictionary object that implementors can use to track state. If this method is invoked multiple times in the same permission evaluation, the same Dictionary will be passed multiple times. The SecurityManager treats this Dictionary as an opaque object and simply creates an empty dictionary and passes it to subsequent invocations if multiple invocatios are needed.
Returns:
true if all the Conditions are satisfied. Otherwise, false if one of the Conditions is not satisfied.

OSGi™ Service Platform
Release 4

Copyright © OSGi Alliance (2000, 2006). All Rights Reserved. Licensed under the OSGi Specification License, Version 1.0