OSGi 8.1.0 · org.osgi.service.dal.DevicePermission · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
pack-priv transient Device	device Initialized when the device permission is built with device instance.
private transient Dictionary<String, Object>	deviceProperties Device properties are initialized on the first request.
private transient Filter	filter If the permission was built with filter, this filed contains LDAP filter used for matching.
public static final String	REMOVE A permission action to remove the device.
private static final long	serialVersionUID Hides java.security.BasicPermission.serialVersionUID.

Access	Constructor and Description
public	DevicePermission(String A filter expression that can use any device service property. The filter attribute names are processed in a case insensitive manner. A special value of "*" can be used to match all devices. filter, String `REMOVE` action. action) Creates a new `DevicePermission` with the given filter and actions.
public	DevicePermission(Device The device that needs to be checked for a permission. device, String `REMOVE` action. action) Creates a new `DevicePermission` with the given device and actions.

Method Summary

Modifier and Type	Method and Description
private static String	createPermissionName(Device device)
public boolean	Returns: `true` if two permissions are equal, `false` otherwise. equals(Object The object being compared for equality with this object. obj) Overrides java.security.BasicPermission.equals. Two `DevicePermission` instances are equal if: Represents the same filter and action. Represents the same device (in respect to device unique identifier) and action.
public String	Returns: The canonical string representation of the actions. getActions() Overrides java.security.BasicPermission.getActions. Returns the canonical string representation of `REMOVE` action.
private Dictionary<String, Object>	getDeviceProperties()
public int	Returns: 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 permission, `false` otherwise. implies(Permission The permission to be implied. It must be constructed by `DevicePermission(Device, String)`. p) Overrides java.security.BasicPermission.implies. Determines if the specified permission is implied by this object.
pack-priv boolean	implyDevicePermission(DevicePermission dp)
public PermissionCollection	Returns: A new `PermissionCollection` instance. newPermissionCollection() Overrides java.security.BasicPermission.newPermissionCollection. Returns a new `PermissionCollection` suitable for storing `DevicePermission` instances.
private static Filter	parseFilter(String filter)
private synchronized void	readObject(ObjectInputStream the `ObjectInputStream` from which data is read s) Hides java.security.BasicPermission.readObject. Called to restore the permission state from the stream.
private static void	validateAction(String action)
private synchronized void	writeObject(ObjectOutputStream s) Called when the permission state is saved to a stream.

Field Detail

device	back to summary
pack-priv transient Device device Initialized when the device permission is built with device instance. Such permissions are used only for security checks.

deviceProperties	back to summary
private transient Dictionary<String, Object> deviceProperties Device properties are initialized on the first request.

filter	back to summary
private transient Filter filter If the permission was built with filter, this filed contains LDAP filter used for matching.

REMOVE	back to summary
public static final String REMOVE A permission action to remove the device.

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

Constructor Detail

DevicePermission back to summary

DevicePermission	back to summary
public DevicePermission(String filter, String action) Creates a new `DevicePermission` with the given filter and actions. The constructor must only be used to create a permission that is going to be checked. A filter example: (dal.device.hardware.vendor=acme) An action: remove Parameters filter:String A filter expression that can use any device service property. The filter attribute names are processed in a case insensitive manner. A special value of "*" can be used to match all devices. action:String `REMOVE` action. Exceptions IllegalArgumentException: If the filter syntax is not correct or invalid action is specified. NullPointerException: If the filter or action is null.

public DevicePermission(String filter, String action)

Creates a new DevicePermission with the given filter and actions. The constructor must only be used to create a permission that is going to be checked.

A filter example: (dal.device.hardware.vendor=acme)

An action: remove

Parameters

filter:String: A filter expression that can use any device service property. The filter attribute names are processed in a case insensitive manner. A special value of "*" can be used to match all devices.
action:String: REMOVE action.

Exceptions

IllegalArgumentException:: If the filter syntax is not correct or invalid action is specified.
NullPointerException:: If the filter or action is null.

DevicePermission back to summary

DevicePermission	back to summary
public DevicePermission(Device device, String action) Creates a new `DevicePermission` with the given device and actions. The permission must be used for the security checks like: `securityManager.checkPermission(new DevicePermission(this, "remove"))` . The permissions constructed by this constructor must not be added to the `DevicePermission` permission collections. Parameters device:Device The device that needs to be checked for a permission. action:String `REMOVE` action. Exceptions IllegalArgumentException: If an invalid action is specified. NullPointerException: If the device or action is null.

public DevicePermission(Device device, String action)

Creates a new DevicePermission with the given device and actions. The permission must be used for the security checks like:

securityManager.checkPermission(new DevicePermission(this, "remove")) . The permissions constructed by this constructor must not be added to the DevicePermission permission collections.

Parameters

device:Device: The device that needs to be checked for a permission.
action:String: REMOVE action.

Exceptions

IllegalArgumentException:: If an invalid action is specified.
NullPointerException:: If the device or action is null.

Method Detail

createPermissionName	back to summary
private static String createPermissionName(Device device)

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.security.BasicPermission.equals. Two `DevicePermission` instances are equal if: Represents the same filter and action. Represents the same device (in respect to device unique identifier) and action. Parameters obj:Object The object being compared for equality with this object. Returns:boolean `true` if two permissions are equal, `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.security.BasicPermission.equals.

Two DevicePermission instances are equal if:

Represents the same filter and action.
Represents the same device (in respect to device unique identifier) and action.

Parameters

obj:Object: The object being compared for equality with this object.

Returns:boolean

true if two permissions are equal, 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 `REMOVE` action. Returns:String The canonical string representation of the actions. Annotations @Override

public String getActions()

Overrides java.security.BasicPermission.getActions.

Returns the canonical string representation of REMOVE action.

Returns:String

The canonical string representation of the actions.

Annotations

@Override

getDeviceProperties	back to summary
private Dictionary<String, Object> getDeviceProperties()

hashCode	back to summary
public int hashCode() Overrides java.security.BasicPermission.hashCode. Returns the hash code value for this object. Returns:int 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

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. The method will return `false` if the specified permission was not constructed by `DevicePermission(Device, String)`. Returns `true` if the specified permission is a `DevicePermission` and this permission filter matches the specified permission device properties. Parameters p:Permission The permission to be implied. It must be constructed by `DevicePermission(Device, String)`. Returns:boolean `true` if the specified permission is implied by this permission, `false` otherwise. Annotations @Override Exceptions IllegalArgumentException: If the specified permission is not constructed by `DevicePermission(Device, String)`.

public boolean implies(Permission p)

Overrides java.security.BasicPermission.implies.

Determines if the specified permission is implied by this object. The method will return false if the specified permission was not constructed by DevicePermission(Device, String). Returns true if the specified permission is a DevicePermission and this permission filter matches the specified permission device properties.

Parameters

p:Permission: The permission to be implied. It must be constructed by DevicePermission(Device, String).

Returns:boolean

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

Annotations

@Override

Exceptions

IllegalArgumentException:: If the specified permission is not constructed by DevicePermission(Device, String).

implyDevicePermission	back to summary
pack-priv boolean implyDevicePermission(DevicePermission dp)

newPermissionCollection back to summary

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

public PermissionCollection newPermissionCollection()

Overrides java.security.BasicPermission.newPermissionCollection.

Returns a new PermissionCollection suitable for storing DevicePermission instances.

Returns:PermissionCollection

A new PermissionCollection instance.

Annotations

@Override

parseFilter	back to summary
private static Filter parseFilter(String filter)

readObject back to summary

readObject	back to summary
private synchronized void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException Hides java.security.BasicPermission.readObject. Called to restore the permission state from the 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.

Called to restore the permission state from the 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

validateAction	back to summary
private static void validateAction(String action)

writeObject	back to summary
private synchronized void writeObject(ObjectOutputStream s) throws IOException Called when the permission state is saved to a stream. Permissions with device instance cannot be serialized.

public Class DevicePermission

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail