OSGi 8.1.0 · org.osgi.service.condpermadmin.ConditionalPermissionAdmin

Method Summary

Modifier and Type	Method and Description
public ConditionalPermissionInfo	Returns: The ConditionalPermissionInfo for the specified Conditions and Permissions. addConditionalPermissionInfo(ConditionInfo[] The conditions that need to be satisfied to enable the specified permissions. This argument can be `null` or an empty array indicating the specified permissions are not guarded by any conditions. conditions, PermissionInfo[] The permissions that are enabled when the specified conditions, if any, are satisfied. This argument must not be `null` and must specify at least one permission. permissions) Deprecated As of 1.1. Use `newConditionalPermissionUpdate()` instead. Create a new Conditional Permission Info in the Conditional Permission Table.
public AccessControlContext	Returns: An `AccessControlContext` that has the Permissions associated with the signer. getAccessControlContext(String[] The signers for which to return an Access Control Context. signers) References Deprecated `AccessControlContext` is deprecated or references (maybe indirectly) at least one deprecated element. Returns the Access Control Context that corresponds to the specified signers.
public ConditionalPermissionInfo	Returns: The Conditional Permission Info with the specified name or `null` if no Conditional Permission Info with the specified name exists in the Conditional Permission Table. getConditionalPermissionInfo(String The name of the Conditional Permission Info to be returned. name) Deprecated As of 1.1. Use `newConditionalPermissionUpdate()` instead. Return the Conditional Permission Info with the specified name.
public Enumeration<ConditionalPermissionInfo>	Returns: An enumeration of the Conditional Permission Infos that are currently in the Conditional Permission Table. getConditionalPermissionInfos() Deprecated As of 1.1. Use `newConditionalPermissionUpdate()` instead. Returns the Conditional Permission Infos from the Conditional Permission Table.
public ConditionalPermissionInfo	Returns: A `ConditionalPermissionInfo` object suitable for insertion into a `ConditionalPermissionUpdate`. newConditionalPermissionInfo(String The name of the created `ConditionalPermissionInfo` or `null` to have a unique name generated when the returned `ConditionalPermissionInfo` is committed in an update to the Conditional Permission Table. name, ConditionInfo[] The conditions that need to be satisfied to enable the specified permissions. This argument can be `null` or an empty array indicating the specified permissions are not guarded by any conditions. conditions, PermissionInfo[] The permissions that are enabled when the specified conditions, if any, are satisfied. This argument must not be `null` and must specify at least one permission. permissions, String Access decision. Must be one of the following values: `allow` `deny` The specified access decision value must be evaluated case insensitively. access) Creates a new ConditionalPermissionInfo with the specified fields suitable for insertion into a `ConditionalPermissionUpdate`.
public ConditionalPermissionInfo	Returns: A `ConditionalPermissionInfo` object suitable for insertion into a `ConditionalPermissionUpdate`. newConditionalPermissionInfo(String The encoded `ConditionalPermissionInfo`. White space in the encoded `ConditionalPermissionInfo` is ignored. The access decision value in the encoded `ConditionalPermissionInfo` must be evaluated case insensitively. If the encoded `ConditionalPermissionInfo` does not contain the optional name, `null` must be used for the name and a unique name will be generated when the returned `ConditionalPermissionInfo` is committed in an update to the Conditional Permission Table. encodedConditionalPermissionInfo) Creates a new `ConditionalPermissionInfo` from the specified encoded `ConditionalPermissionInfo` string suitable for insertion into a `ConditionalPermissionUpdate`.
public ConditionalPermissionUpdate	Returns: A new update for the Conditional Permission Table. newConditionalPermissionUpdate() Creates a new update for the Conditional Permission Table.
public ConditionalPermissionInfo	Returns: The ConditionalPermissionInfo for the specified name, Conditions and Permissions. setConditionalPermissionInfo(String The name of the Conditional Permission Info, or `null`. name, ConditionInfo[] The conditions that need to be satisfied to enable the specified permissions. This argument can be `null` or an empty array indicating the specified permissions are not guarded by any conditions. conditions, PermissionInfo[] The permissions that are enabled when the specified conditions, if any, are satisfied. This argument must not be `null` and must specify at least one permission. permissions) Deprecated As of 1.1. Use `newConditionalPermissionUpdate()` instead. Set or create a Conditional Permission Info with a specified name in the Conditional Permission Table.

Method Detail

addConditionalPermissionInfo back to summary

addConditionalPermissionInfo	back to summary
public ConditionalPermissionInfo addConditionalPermissionInfo(ConditionInfo[] conditions, PermissionInfo[] permissions) Deprecated As of 1.1. Use `newConditionalPermissionUpdate()` instead. Create a new Conditional Permission Info in the Conditional Permission Table. The Conditional Permission Info will be given a unique, never reused name. This entry will be added at the beginning of the Conditional Permission Table with an access decision of `ALLOW`. Since this method changes the Conditional Permission Table any `ConditionalPermissionUpdate`s that were created prior to calling this method can no longer be committed. Parameters conditions:ConditionInfo[] The conditions that need to be satisfied to enable the specified permissions. This argument can be `null` or an empty array indicating the specified permissions are not guarded by any conditions. permissions:PermissionInfo[] The permissions that are enabled when the specified conditions, if any, are satisfied. This argument must not be `null` and must specify at least one permission. Returns:ConditionalPermissionInfo The ConditionalPermissionInfo for the specified Conditions and Permissions. Exceptions IllegalArgumentException: If no permissions are specified. SecurityException: If the caller does not have `AllPermission`.

public ConditionalPermissionInfo addConditionalPermissionInfo(ConditionInfo[] conditions, PermissionInfo[] permissions)

Deprecated

As of 1.1. Use newConditionalPermissionUpdate() instead.

Create a new Conditional Permission Info in the Conditional Permission Table.

The Conditional Permission Info will be given a unique, never reused name. This entry will be added at the beginning of the Conditional Permission Table with an access decision of ALLOW.

Since this method changes the Conditional Permission Table any ConditionalPermissionUpdates that were created prior to calling this method can no longer be committed.

Parameters

conditions:ConditionInfo[]: The conditions that need to be satisfied to enable the specified permissions. This argument can be null or an empty array indicating the specified permissions are not guarded by any conditions.
permissions:PermissionInfo[]: The permissions that are enabled when the specified conditions, if any, are satisfied. This argument must not be null and must specify at least one permission.

Returns:ConditionalPermissionInfo

The ConditionalPermissionInfo for the specified Conditions and Permissions.

Exceptions

IllegalArgumentException:: If no permissions are specified.
SecurityException:: If the caller does not have AllPermission.

getAccessControlContext back to summary

getAccessControlContext	back to summary
public AccessControlContext getAccessControlContext(String[] signers) References Deprecated `AccessControlContext` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Returns the Access Control Context that corresponds to the specified signers. The returned Access Control Context must act as if its protection domain came from a bundle that has the following characteristics: It is signed by all of the given signers It has a bundle id of -1 Its location is the empty string Its state is UNINSTALLED It has no headers It has the empty version (0.0.0) Its last modified time=0 Many methods will throw `IllegalStateException` because the state is UNINSTALLED All other methods return a `null` Parameters signers:String[] The signers for which to return an Access Control Context. Returns:AccessControlContext An `AccessControlContext` that has the Permissions associated with the signer.

public AccessControlContext getAccessControlContext(String[] signers)

References Deprecated

AccessControlContext is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Returns the Access Control Context that corresponds to the specified signers. The returned Access Control Context must act as if its protection domain came from a bundle that has the following characteristics:

It is signed by all of the given signers
It has a bundle id of -1
Its location is the empty string
Its state is UNINSTALLED
It has no headers
It has the empty version (0.0.0)
Its last modified time=0
Many methods will throw IllegalStateException because the state is UNINSTALLED
All other methods return a null

Parameters

signers:String[]: The signers for which to return an Access Control Context.

Returns:AccessControlContext

An AccessControlContext that has the Permissions associated with the signer.

getConditionalPermissionInfo back to summary

getConditionalPermissionInfo	back to summary
public ConditionalPermissionInfo getConditionalPermissionInfo(String name) Deprecated As of 1.1. Use `newConditionalPermissionUpdate()` instead. Return the Conditional Permission Info with the specified name. Parameters name:String The name of the Conditional Permission Info to be returned. Returns:ConditionalPermissionInfo The Conditional Permission Info with the specified name or `null` if no Conditional Permission Info with the specified name exists in the Conditional Permission Table.

public ConditionalPermissionInfo getConditionalPermissionInfo(String name)

Deprecated

As of 1.1. Use newConditionalPermissionUpdate() instead.

Return the Conditional Permission Info with the specified name.

Parameters

name:String: The name of the Conditional Permission Info to be returned.

Returns:ConditionalPermissionInfo

The Conditional Permission Info with the specified name or null if no Conditional Permission Info with the specified name exists in the Conditional Permission Table.

getConditionalPermissionInfos back to summary

getConditionalPermissionInfos	back to summary
public Enumeration<ConditionalPermissionInfo> getConditionalPermissionInfos() Deprecated As of 1.1. Use `newConditionalPermissionUpdate()` instead. Returns the Conditional Permission Infos from the Conditional Permission Table. The returned Enumeration will return elements in the order they are kept in the Conditional Permission Table. The Enumeration returned is based on a copy of the Conditional Permission Table and therefore will not throw exceptions if the Conditional Permission Table is changed during the course of reading elements from the Enumeration. Returns:Enumeration<ConditionalPermissionInfo> An enumeration of the Conditional Permission Infos that are currently in the Conditional Permission Table.

public Enumeration<ConditionalPermissionInfo> getConditionalPermissionInfos()

Deprecated

As of 1.1. Use newConditionalPermissionUpdate() instead.

Returns the Conditional Permission Infos from the Conditional Permission Table.

The returned Enumeration will return elements in the order they are kept in the Conditional Permission Table.

The Enumeration returned is based on a copy of the Conditional Permission Table and therefore will not throw exceptions if the Conditional Permission Table is changed during the course of reading elements from the Enumeration.

Returns:Enumeration<ConditionalPermissionInfo>: An enumeration of the Conditional Permission Infos that are currently in the Conditional Permission Table.

newConditionalPermissionInfo back to summary

newConditionalPermissionInfo	back to summary
public ConditionalPermissionInfo newConditionalPermissionInfo(String name, ConditionInfo[] conditions, PermissionInfo[] permissions, String access) Creates a new ConditionalPermissionInfo with the specified fields suitable for insertion into a `ConditionalPermissionUpdate`. The `delete` method on `ConditionalPermissionInfo` objects created with this method must throw UnsupportedOperationException. Parameters name:String The name of the created `ConditionalPermissionInfo` or `null` to have a unique name generated when the returned `ConditionalPermissionInfo` is committed in an update to the Conditional Permission Table. conditions:ConditionInfo[] The conditions that need to be satisfied to enable the specified permissions. This argument can be `null` or an empty array indicating the specified permissions are not guarded by any conditions. permissions:PermissionInfo[] The permissions that are enabled when the specified conditions, if any, are satisfied. This argument must not be `null` and must specify at least one permission. access:String Access decision. Must be one of the following values: `allow` `deny` The specified access decision value must be evaluated case insensitively. Returns:ConditionalPermissionInfo A `ConditionalPermissionInfo` object suitable for insertion into a `ConditionalPermissionUpdate`. Exceptions IllegalArgumentException: If no permissions are specified or if the specified access decision is not a valid value. Since 1.1

public ConditionalPermissionInfo newConditionalPermissionInfo(String name, ConditionInfo[] conditions, PermissionInfo[] permissions, String access)

Creates a new ConditionalPermissionInfo with the specified fields suitable for insertion into a ConditionalPermissionUpdate. The delete method on ConditionalPermissionInfo objects created with this method must throw UnsupportedOperationException.

Parameters

name:String

The name of the created ConditionalPermissionInfo or null to have a unique name generated when the returned ConditionalPermissionInfo is committed in an update to the Conditional Permission Table.

conditions:ConditionInfo[]

The conditions that need to be satisfied to enable the specified permissions. This argument can be null or an empty array indicating the specified permissions are not guarded by any conditions.

permissions:PermissionInfo[]

The permissions that are enabled when the specified conditions, if any, are satisfied. This argument must not be null and must specify at least one permission.

access:String

Access decision. Must be one of the following values:

The specified access decision value must be evaluated case insensitively.

Returns:ConditionalPermissionInfo

A ConditionalPermissionInfo object suitable for insertion into a ConditionalPermissionUpdate.

Exceptions

IllegalArgumentException:: If no permissions are specified or if the specified access decision is not a valid value.

Since

1.1

newConditionalPermissionInfo back to summary

newConditionalPermissionInfo	back to summary
public ConditionalPermissionInfo newConditionalPermissionInfo(String encodedConditionalPermissionInfo) Creates a new `ConditionalPermissionInfo` from the specified encoded `ConditionalPermissionInfo` string suitable for insertion into a `ConditionalPermissionUpdate`. The `delete` method on `ConditionalPermissionInfo` objects created with this method must throw UnsupportedOperationException. Parameters encodedConditionalPermissionInfo:String The encoded `ConditionalPermissionInfo`. White space in the encoded `ConditionalPermissionInfo` is ignored. The access decision value in the encoded `ConditionalPermissionInfo` must be evaluated case insensitively. If the encoded `ConditionalPermissionInfo` does not contain the optional name, `null` must be used for the name and a unique name will be generated when the returned `ConditionalPermissionInfo` is committed in an update to the Conditional Permission Table. Returns:ConditionalPermissionInfo A `ConditionalPermissionInfo` object suitable for insertion into a `ConditionalPermissionUpdate`. Exceptions IllegalArgumentException: If the specified `encodedConditionalPermissionInfo` is not properly formatted. Since 1.1 See Also `ConditionalPermissionInfo#getEncoded()`

public ConditionalPermissionInfo newConditionalPermissionInfo(String encodedConditionalPermissionInfo)

Creates a new ConditionalPermissionInfo from the specified encoded ConditionalPermissionInfo string suitable for insertion into a ConditionalPermissionUpdate. The delete method on ConditionalPermissionInfo objects created with this method must throw UnsupportedOperationException.

Parameters

encodedConditionalPermissionInfo:String: The encoded ConditionalPermissionInfo. White space in the encoded ConditionalPermissionInfo is ignored. The access decision value in the encoded ConditionalPermissionInfo must be evaluated case insensitively. If the encoded ConditionalPermissionInfo does not contain the optional name, null must be used for the name and a unique name will be generated when the returned ConditionalPermissionInfo is committed in an update to the Conditional Permission Table.

Returns:ConditionalPermissionInfo

A ConditionalPermissionInfo object suitable for insertion into a ConditionalPermissionUpdate.

Exceptions

IllegalArgumentException:: If the specified encodedConditionalPermissionInfo is not properly formatted.

Since

1.1

newConditionalPermissionUpdate	back to summary
public ConditionalPermissionUpdate newConditionalPermissionUpdate() Creates a new update for the Conditional Permission Table. The update is a working copy of the current Conditional Permission Table. If the running Conditional Permission Table is modified before commit is called on the returned update, then the call to commit on the returned update will fail. That is, the commit method will return false and no change will be made to the running Conditional Permission Table. There is no requirement that commit is eventually called on the returned update. Returns:ConditionalPermissionUpdate A new update for the Conditional Permission Table. Since 1.1

newConditionalPermissionUpdate

back to summary

public ConditionalPermissionUpdate newConditionalPermissionUpdate()

Creates a new update for the Conditional Permission Table. The update is a working copy of the current Conditional Permission Table. If the running Conditional Permission Table is modified before commit is called on the returned update, then the call to commit on the returned update will fail. That is, the commit method will return false and no change will be made to the running Conditional Permission Table. There is no requirement that commit is eventually called on the returned update.

Returns:ConditionalPermissionUpdate: A new update for the Conditional Permission Table.
Since: 1.1

setConditionalPermissionInfo back to summary

setConditionalPermissionInfo	back to summary
public ConditionalPermissionInfo setConditionalPermissionInfo(String name, ConditionInfo[] conditions, PermissionInfo[] permissions) Deprecated As of 1.1. Use `newConditionalPermissionUpdate()` instead. Set or create a Conditional Permission Info with a specified name in the Conditional Permission Table. If the specified name is `null`, a new Conditional Permission Info must be created and will be given a unique, never reused name. If there is currently no Conditional Permission Info with the specified name, a new Conditional Permission Info must be created with the specified name. Otherwise, the Conditional Permission Info with the specified name must be updated with the specified Conditions and Permissions. If a new entry was created in the Conditional Permission Table it will be added at the beginning of the table with an access decision of `ALLOW`. Since this method changes the underlying permission table any `ConditionalPermissionUpdate`s that were created prior to calling this method can no longer be committed. Parameters name:String The name of the Conditional Permission Info, or `null`. conditions:ConditionInfo[] The conditions that need to be satisfied to enable the specified permissions. This argument can be `null` or an empty array indicating the specified permissions are not guarded by any conditions. permissions:PermissionInfo[] The permissions that are enabled when the specified conditions, if any, are satisfied. This argument must not be `null` and must specify at least one permission. Returns:ConditionalPermissionInfo The ConditionalPermissionInfo for the specified name, Conditions and Permissions. Exceptions IllegalArgumentException: If no permissions are specified. SecurityException: If the caller does not have `AllPermission`.

public ConditionalPermissionInfo setConditionalPermissionInfo(String name, ConditionInfo[] conditions, PermissionInfo[] permissions)

Deprecated

As of 1.1. Use newConditionalPermissionUpdate() instead.

Set or create a Conditional Permission Info with a specified name in the Conditional Permission Table.

If the specified name is null, a new Conditional Permission Info must be created and will be given a unique, never reused name. If there is currently no Conditional Permission Info with the specified name, a new Conditional Permission Info must be created with the specified name. Otherwise, the Conditional Permission Info with the specified name must be updated with the specified Conditions and Permissions. If a new entry was created in the Conditional Permission Table it will be added at the beginning of the table with an access decision of ALLOW.

Since this method changes the underlying permission table any ConditionalPermissionUpdates that were created prior to calling this method can no longer be committed.

Parameters

name:String: The name of the Conditional Permission Info, or null.
conditions:ConditionInfo[]: The conditions that need to be satisfied to enable the specified permissions. This argument can be null or an empty array indicating the specified permissions are not guarded by any conditions.
permissions:PermissionInfo[]: The permissions that are enabled when the specified conditions, if any, are satisfied. This argument must not be null and must specify at least one permission.

Returns:ConditionalPermissionInfo

The ConditionalPermissionInfo for the specified name, Conditions and Permissions.

Exceptions

IllegalArgumentException:: If no permissions are specified.
SecurityException:: If the caller does not have AllPermission.

public Interface ConditionalPermissionAdmin

Method Summary

Method Detail