Package org.osgi.framework
Class AdaptPermission
- java.lang.Object
-
- java.security.Permission
-
- java.security.BasicPermission
-
- org.osgi.framework.AdaptPermission
-
- All Implemented Interfaces:
java.io.Serializable,java.security.Guard
public final class AdaptPermission extends java.security.BasicPermissionA bundle's authority to adapt an object to a type.AdaptPermissionhas one action:adapt.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private static intACTION_ADAPTprivate static intACTION_ALL(package private) intaction_maskThe actions mask.(package private) static intACTION_NONEprivate java.lang.StringactionsThe actions in canonical form.static java.lang.StringADAPTThe action stringinitiate.(package private) BundlebundleThe bundle used by this AdaptPermission.(package private) FilterfilterThis holds a Filter matching object used to evaluate the filter in implies.private java.util.Map<java.lang.String,java.lang.Object>propertiesThis map holds the properties of the permission, used to match a filter in implies.private static longserialVersionUID
-
Constructor Summary
Constructors Constructor Description AdaptPermission(java.lang.String filter, java.lang.String actions)Creates a new grantedAdaptPermissionobject.AdaptPermission(java.lang.String adaptClass, Bundle adaptableBundle, java.lang.String actions)Creates a new requestedAdaptPermissionobject to be used by the code that must performcheckPermission.AdaptPermission(Filter filter, int mask)Package private constructor used by AdaptPermissionCollection.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)Determines the equality of twoAdaptPermissionobjects.java.lang.StringgetActions()Returns the canonical string representation of theAdaptPermissionactions.private java.util.Map<java.lang.String,java.lang.Object>getProperties()Called byimplies(Permission).inthashCode()Returns the hash code value for this object.booleanimplies(java.security.Permission p)Determines if the specified permission is implied by this object.(package private) booleanimplies0(AdaptPermission requested, int effective)Internal implies method.java.security.PermissionCollectionnewPermissionCollection()Returns a newPermissionCollectionobject suitable for storingAdaptPermissionobjects.private static intparseActions(java.lang.String actions)Parse action string into action mask.private static FilterparseFilter(java.lang.String filterString)Parse filter string into a Filter object.private voidreadObject(java.io.ObjectInputStream s)readObject is called to restore the state of this permission from a stream.private voidsetTransients(Filter filter, int mask)Called by constructors and when deserialized.private voidwriteObject(java.io.ObjectOutputStream s)WriteObject is called to save the state of this permission object to a stream.
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
ADAPT
public static final java.lang.String ADAPT
The action stringinitiate.- See Also:
- Constant Field Values
-
ACTION_ADAPT
private static final int ACTION_ADAPT
- See Also:
- Constant Field Values
-
ACTION_ALL
private static final int ACTION_ALL
- See Also:
- Constant Field Values
-
ACTION_NONE
static final int ACTION_NONE
- See Also:
- Constant Field Values
-
action_mask
transient int action_mask
The actions mask.
-
actions
private volatile java.lang.String actions
The actions in canonical form.
-
bundle
final transient Bundle bundle
The bundle used by this AdaptPermission.
-
filter
transient Filter filter
This holds a Filter matching object used to evaluate the filter in implies.
-
properties
private transient volatile java.util.Map<java.lang.String,java.lang.Object> properties
This map holds the properties of the permission, used to match a filter in implies. This is not initialized until necessary, and then cached in this object.
-
-
Constructor Detail
-
AdaptPermission
public AdaptPermission(java.lang.String filter, java.lang.String actions)Creates a new grantedAdaptPermissionobject. This constructor must only be used to create a permission that is going to be checked.Examples:
(adaptClass=com.acme.*) (&(signer=\*,o=ACME,c=US)(adaptClass=com.acme.*)) (signer=\*,o=ACME,c=US)
When a signer key is used within the filter expression the signer value must escape the special filter chars ('*', '(', ')').
The name is specified as a filter expression. The filter gives access to the following attributes:
- signer - A Distinguished Name chain used to sign the exporting bundle. Wildcards in a DN are not matched according to the filter string rules, but according to the rules defined for a DN chain.
- location - The location of the exporting bundle.
- id - The bundle ID of the exporting bundle.
- name - The symbolic name of the exporting bundle.
- adaptClass - The name of the type to which an object can be adapted.
- Parameters:
filter- A filter expression. Filter attribute names are processed in a case sensitive manner. A special value of"*"can be used to match all adaptations.actions-adapt.- Throws:
java.lang.IllegalArgumentException- If the filter has an invalid syntax.
-
AdaptPermission
public AdaptPermission(java.lang.String adaptClass, Bundle adaptableBundle, java.lang.String actions)Creates a new requestedAdaptPermissionobject to be used by the code that must performcheckPermission.AdaptPermissionobjects created with this constructor cannot be added to anAdaptPermissionpermission collection.- Parameters:
adaptClass- The name of the type to which an object can be adapted.adaptableBundle- The bundle associated with the object being adapted.actions-adapt.
-
AdaptPermission
AdaptPermission(Filter filter, int mask)
Package private constructor used by AdaptPermissionCollection.- Parameters:
filter- name filtermask- action mask
-
-
Method Detail
-
setTransients
private void setTransients(Filter filter, int mask)
Called by constructors and when deserialized.- Parameters:
filter- Permission's filter ornullfor wildcard.mask- action mask
-
parseActions
private static int parseActions(java.lang.String actions)
Parse action string into action mask.- Parameters:
actions- Action string.- Returns:
- action mask.
-
parseFilter
private static Filter parseFilter(java.lang.String filterString)
Parse filter string into a Filter object.- Parameters:
filterString- The filter string to parse.- Returns:
- a Filter for this bundle.
- Throws:
java.lang.IllegalArgumentException- If the filter syntax is invalid.
-
implies
public boolean implies(java.security.Permission p)
Determines if the specified permission is implied by this object.This method checks that the filter of the target is implied by the adapt class name of this object. The list of
AdaptPermissionactions must either match or allow for the list of the target object to imply the targetAdaptPermissionaction.- Overrides:
impliesin classjava.security.BasicPermission- Parameters:
p- The requested permission.- Returns:
trueif the specified permission is implied by this object;falseotherwise.
-
implies0
boolean implies0(AdaptPermission requested, int effective)
Internal implies method. Used by the implies and the permission collection implies methods.- Parameters:
requested- The requested AdaptPermission which has already be validated as a proper argument. The requested AdaptPermission must not have a filter expression.effective- The effective actions with which to start.- Returns:
trueif the specified permission is implied by this object;falseotherwise.
-
getActions
public java.lang.String getActions()
Returns the canonical string representation of theAdaptPermissionactions.Always returns present
AdaptPermissionactions in the following order:adapt.- Overrides:
getActionsin classjava.security.BasicPermission- Returns:
- Canonical string representation of the
AdaptPermissionactions.
-
newPermissionCollection
public java.security.PermissionCollection newPermissionCollection()
Returns a newPermissionCollectionobject suitable for storingAdaptPermissionobjects.- Overrides:
newPermissionCollectionin classjava.security.BasicPermission- Returns:
- A new
PermissionCollectionobject.
-
equals
public boolean equals(java.lang.Object obj)
Determines the equality of twoAdaptPermissionobjects. This method checks that specified permission has the same name andAdaptPermissionactions as thisAdaptPermissionobject.- Overrides:
equalsin classjava.security.BasicPermission- Parameters:
obj- The object to test for equality with thisAdaptPermissionobject.- Returns:
trueifobjis aAdaptPermission, and has the same name and actions as thisAdaptPermissionobject;falseotherwise.
-
hashCode
public int hashCode()
Returns the hash code value for this object.- Overrides:
hashCodein classjava.security.BasicPermission- Returns:
- A hash code value for this object.
-
writeObject
private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOExceptionWriteObject is called to save the state of this permission object to a stream. The actions are serialized, and the superclass takes care of the name.- Throws:
java.io.IOException
-
readObject
private void readObject(java.io.ObjectInputStream s) throws java.io.IOException, java.lang.ClassNotFoundExceptionreadObject is called to restore the state of this permission from a stream.- Throws:
java.io.IOExceptionjava.lang.ClassNotFoundException
-
getProperties
private java.util.Map<java.lang.String,java.lang.Object> getProperties()
Called byimplies(Permission). This method is only called on a requested permission which cannot have a filter set.- Returns:
- a map of properties for this permission.
-
-