OSGi 8.1.0 · org.osgi.framework.AdaptPermission · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static final int	ACTION_ADAPT
private static final int	ACTION_ALL
pack-priv transient int	action_mask The actions mask.
pack-priv static final int	ACTION_NONE
private volatile String	actions The actions in canonical form.
public static final String	ADAPT The action string `initiate`.
pack-priv final transient Bundle	bundle The bundle used by this AdaptPermission.
pack-priv transient Filter	filter This holds a Filter matching object used to evaluate the filter in implies.
private transient volatile Map<String, Object>	properties This map holds the properties of the permission, used to match a filter in implies.
private static final long	serialVersionUID Hides java.security.BasicPermission.serialVersionUID.

Access	Constructor and Description
public	AdaptPermission(String A filter expression. Filter attribute names are processed in a case sensitive manner. A special value of `"*"` can be used to match all adaptations. filter, String `adapt`. actions) Creates a new granted `AdaptPermission` object.
public	AdaptPermission(String The name of the type to which an object can be adapted. adaptClass, Bundle The bundle associated with the object being adapted. adaptableBundle, String `adapt`. actions) Creates a new requested `AdaptPermission` object to be used by the code that must perform `checkPermission`.
pack-priv	AdaptPermission(Filter name filter filter, int action mask mask) Package private constructor used by AdaptPermissionCollection.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if `obj` is a `AdaptPermission`, and has the same name and actions as this `AdaptPermission` object; `false` otherwise. equals(Object The object to test for equality with this `AdaptPermission` object. obj) Overrides java.security.BasicPermission.equals. Determines the equality of two `AdaptPermission` objects.
public String	Returns: Canonical string representation of the `AdaptPermission` actions. getActions() Overrides java.security.BasicPermission.getActions. Returns the canonical string representation of the `AdaptPermission` actions.
private Map<String, Object>	Returns: a map of properties for this permission. getProperties() Called by `AdaptPermission#implies(Permission)`.
public int	Returns: A hash code value for this object. hashCode() Overrides java.security.BasicPermission.hashCode. Returns the hash code value for this object.
public boolean	Returns: `true` if the specified permission is implied by this object; `false` otherwise. implies(Permission The requested permission. p) Overrides java.security.BasicPermission.implies. Determines if the specified permission is implied by this object.
pack-priv boolean	Returns: `true` if the specified permission is implied by this object; `false` otherwise. implies0(AdaptPermission The requested AdaptPermission which has already be validated as a proper argument. The requested AdaptPermission must not have a filter expression. requested, int The effective actions with which to start. effective) Internal implies method.
public PermissionCollection	Returns: A new `PermissionCollection` object. newPermissionCollection() Overrides java.security.BasicPermission.newPermissionCollection. Returns a new `PermissionCollection` object suitable for storing `AdaptPermission` objects.
private static int	Returns: action mask. parseActions(String Action string. actions) Parse action string into action mask.
private static Filter	Returns: a Filter for this bundle. parseFilter(String The filter string to parse. filterString) Parse filter string into a Filter object.
private synchronized void	readObject(ObjectInputStream the `ObjectInputStream` from which data is read s) Hides java.security.BasicPermission.readObject. readObject is called to restore the state of this permission from a stream.
private void	setTransients(Filter Permission's filter or `null` for wildcard. filter, int action mask mask) Called by constructors and when deserialized.
private synchronized void	writeObject(ObjectOutputStream s) WriteObject is called to save the state of this permission object to a stream.

Field Detail

ACTION_ADAPT	back to summary
private static final int ACTION_ADAPT

ACTION_ALL	back to summary
private static final int ACTION_ALL

action_mask	back to summary
pack-priv transient int action_mask The actions mask.

ACTION_NONE	back to summary
pack-priv static final int ACTION_NONE

actions	back to summary
private volatile String actions The actions in canonical form.

ADAPT	back to summary
public static final String ADAPT The action string `initiate`.

bundle	back to summary
pack-priv final transient Bundle bundle The bundle used by this AdaptPermission.

filter	back to summary
pack-priv transient Filter filter This holds a Filter matching object used to evaluate the filter in implies.

properties	back to summary
private transient volatile Map<String, 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.

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.security.BasicPermission.serialVersionUID.

Constructor Detail

AdaptPermission back to summary

AdaptPermission	back to summary
public AdaptPermission(String filter, String actions) Creates a new granted `AdaptPermission` object. 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. Filter attribute names are processed in a case sensitive manner. Parameters filter:String 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:String `adapt`. Exceptions IllegalArgumentException: If the filter has an invalid syntax.

public AdaptPermission(String filter, String actions)

Creates a new granted AdaptPermission object. 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.

Filter attribute names are processed in a case sensitive manner.

Parameters

filter:String: 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:String: adapt.

Exceptions

IllegalArgumentException:: If the filter has an invalid syntax.

AdaptPermission back to summary

AdaptPermission	back to summary
public AdaptPermission(String adaptClass, Bundle adaptableBundle, String actions) Creates a new requested `AdaptPermission` object to be used by the code that must perform `checkPermission`. `AdaptPermission` objects created with this constructor cannot be added to an `AdaptPermission` permission collection. Parameters adaptClass:String The name of the type to which an object can be adapted. adaptableBundle:Bundle The bundle associated with the object being adapted. actions:String `adapt`.

public AdaptPermission(String adaptClass, Bundle adaptableBundle, String actions)

Creates a new requested AdaptPermission object to be used by the code that must perform checkPermission. AdaptPermission objects created with this constructor cannot be added to an AdaptPermission permission collection.

Parameters

adaptClass:String: The name of the type to which an object can be adapted.
adaptableBundle:Bundle: The bundle associated with the object being adapted.
actions:String: adapt.

AdaptPermission	back to summary
pack-priv AdaptPermission(Filter filter, int mask) Package private constructor used by AdaptPermissionCollection. Parameters filter:Filter name filter mask:int action mask

AdaptPermission

back to summary

pack-priv AdaptPermission(Filter filter, int mask)

Package private constructor used by AdaptPermissionCollection.

Parameters

filter:Filter: name filter
mask:int: action mask

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.security.BasicPermission.equals. Determines the equality of two `AdaptPermission` objects. This method checks that specified permission has the same name and `AdaptPermission` actions as this `AdaptPermission` object. Parameters obj:Object The object to test for equality with this `AdaptPermission` object. Returns:boolean `true` if `obj` is a `AdaptPermission`, and has the same name and actions as this `AdaptPermission` object; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.security.BasicPermission.equals.

Determines the equality of two AdaptPermission objects. This method checks that specified permission has the same name and AdaptPermission actions as this AdaptPermission object.

Parameters

obj:Object: The object to test for equality with this AdaptPermission object.

Returns:boolean

true if obj is a AdaptPermission, and has the same name and actions as this AdaptPermission object; false otherwise.

Annotations

@Override

getActions back to summary

getActions	back to summary
public String getActions() Overrides java.security.BasicPermission.getActions. Returns the canonical string representation of the `AdaptPermission` actions. Always returns present `AdaptPermission` actions in the following order: `adapt`. Returns:String Canonical string representation of the `AdaptPermission` actions. Annotations @Override

public String getActions()

Overrides java.security.BasicPermission.getActions.

Returns the canonical string representation of the AdaptPermission actions.

Always returns present AdaptPermission actions in the following order: adapt.

Returns:String

Canonical string representation of the AdaptPermission actions.

Annotations

@Override

getProperties back to summary

getProperties	back to summary
private Map<String, Object> getProperties() Called by `AdaptPermission#implies(Permission)`. This method is only called on a requested permission which cannot have a filter set. Returns:Map<String, Object> a map of properties for this permission.

private Map<String, Object> getProperties()

Called by AdaptPermission#implies(Permission). This method is only called on a requested permission which cannot have a filter set.

Returns:Map<String, Object>: a map of properties for this permission.

hashCode	back to summary
public int hashCode() Overrides java.security.BasicPermission.hashCode. Returns the hash code value for this object. Returns:int A hash code value for this object. Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.security.BasicPermission.hashCode.

Returns the hash code value for this object.

Returns:int

A hash code value for this object.

Annotations

@Override

implies back to summary

implies	back to summary
public boolean implies(Permission p) Overrides java.security.BasicPermission.implies. 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 `AdaptPermission` actions must either match or allow for the list of the target object to imply the target `AdaptPermission` action. Parameters p:Permission The requested permission. Returns:boolean `true` if the specified permission is implied by this object; `false` otherwise. Annotations @Override

public boolean implies(Permission p)

Overrides java.security.BasicPermission.implies.

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 AdaptPermission actions must either match or allow for the list of the target object to imply the target AdaptPermission action.

Parameters

p:Permission: The requested permission.

Returns:boolean

true if the specified permission is implied by this object; false otherwise.

Annotations

@Override

implies0 back to summary

implies0	back to summary
pack-priv boolean implies0(AdaptPermission requested, int effective) Internal implies method. Used by the implies and the permission collection implies methods. Parameters requested:AdaptPermission The requested AdaptPermission which has already be validated as a proper argument. The requested AdaptPermission must not have a filter expression. effective:int The effective actions with which to start. Returns:boolean `true` if the specified permission is implied by this object; `false` otherwise.

pack-priv boolean implies0(AdaptPermission requested, int effective)

Internal implies method. Used by the implies and the permission collection implies methods.

Parameters

requested:AdaptPermission: The requested AdaptPermission which has already be validated as a proper argument. The requested AdaptPermission must not have a filter expression.
effective:int: The effective actions with which to start.

Returns:boolean

true if the specified permission is implied by this object; false otherwise.

newPermissionCollection back to summary

newPermissionCollection	back to summary
public PermissionCollection newPermissionCollection() Overrides java.security.BasicPermission.newPermissionCollection. Returns a new `PermissionCollection` object suitable for storing `AdaptPermission` objects. Returns:PermissionCollection A new `PermissionCollection` object. Annotations @Override

public PermissionCollection newPermissionCollection()

Overrides java.security.BasicPermission.newPermissionCollection.

Returns a new PermissionCollection object suitable for storing AdaptPermission objects.

Returns:PermissionCollection

A new PermissionCollection object.

Annotations

@Override

parseActions	back to summary
private static int parseActions(String actions) Parse action string into action mask. Parameters actions:String Action string. Returns:int action mask.

parseActions

back to summary

private static int parseActions(String actions)

Parse action string into action mask.

Parameters

actions:String: Action string.

Returns:int

action mask.

parseFilter	back to summary
private static Filter parseFilter(String filterString) Parse filter string into a Filter object. Parameters filterString:String The filter string to parse. Returns:Filter a Filter for this bundle. Exceptions IllegalArgumentException: If the filter syntax is invalid.

parseFilter

back to summary

private static Filter parseFilter(String filterString)

Parse filter string into a Filter object.

Parameters

filterString:String: The filter string to parse.

Returns:Filter

a Filter for this bundle.

Exceptions

IllegalArgumentException:: If the filter syntax is invalid.

readObject back to summary

readObject	back to summary
private synchronized void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException Hides java.security.BasicPermission.readObject. readObject is called to restore the state of this permission from a stream. Parameters s:ObjectInputStream Doc from java.security.BasicPermission.readObject. the `ObjectInputStream` from which data is read Exceptions IOException: Doc from java.security.BasicPermission.readObject. if an I/O error occurs ClassNotFoundException: Doc from java.security.BasicPermission.readObject. if a serialized class cannot be loaded

private synchronized void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException

Hides java.security.BasicPermission.readObject.

readObject is called to restore the state of this permission from a stream.

Parameters

s:ObjectInputStream

Doc from java.security.BasicPermission.readObject.

the ObjectInputStream from which data is read

Exceptions

IOException:

Doc from java.security.BasicPermission.readObject.

if an I/O error occurs

ClassNotFoundException:

Doc from java.security.BasicPermission.readObject.

if a serialized class cannot be loaded

setTransients back to summary

setTransients	back to summary
private void setTransients(Filter filter, int mask) Called by constructors and when deserialized. Parameters filter:Filter Permission's filter or `null` for wildcard. mask:int action mask

private void setTransients(Filter filter, int mask)

Called by constructors and when deserialized.

Parameters

filter:Filter: Permission's filter or null for wildcard.
mask:int: action mask

writeObject	back to summary
private synchronized void writeObject(ObjectOutputStream s) throws IOException WriteObject 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.

public final Class AdaptPermission

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail