Package org.osgi.framework
Class ServicePermission
java.lang.Object
java.security.Permission
java.security.BasicPermission
org.osgi.framework.ServicePermission
- All Implemented Interfaces:
Serializable
,Guard
A bundle's authority to register or get a service.
- The
register
action allows a bundle to register a service on the specified names. - The
get
action allows a bundle to detect a service and get it.
ServicePermission
to get the specific service.- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
private static final int
(package private) int
The actions mask.(package private) static final int
private static final int
private String
The actions in canonical form.(package private) Filter
If this ServicePermission was constructed with a filter, this holds a Filter matching object used to evaluate the filter in implies.static final String
The action stringget
.(package private) final String[]
The object classes for this ServicePermission.private String
If constructed with a name and the name ends with ".*", this contains the name without the final "*".This map holds the properties of the permission, used to match a filter in implies.static final String
The action stringregister
.(package private) static final long
(package private) final ServiceReference<?>
The service used by this ServicePermission.private boolean
True if constructed with a name and the name is "*" or ends with ".*". -
Constructor Summary
ConstructorsConstructorDescriptionServicePermission
(String name, int mask) Package private constructor used by ServicePermissionCollection.ServicePermission
(String name, String actions) Create a new ServicePermission.ServicePermission
(ServiceReference<?> reference, String actions) Creates a new requestedServicePermission
object to be used by code that must performcheckPermission
for theget
action. -
Method Summary
Modifier and TypeMethodDescriptionprivate static String
createName
(ServiceReference<?> reference) Create a permission name from a ServiceReferenceboolean
Determines the equality of two ServicePermission objects.Returns the canonical string representation of the actions.Called byimplies(Permission)
.int
hashCode()
Returns the hash code value for this object.boolean
Determines if aServicePermission
object "implies" the specified permission.(package private) boolean
implies0
(ServicePermission requested, int effective) Internal implies method.Returns a newPermissionCollection
object for storingServicePermission
objects.private static int
parseActions
(String actions) Parse action string into action mask.private static Filter
parseFilter
(String filterString) Parse filter string into a Filter object.private void
readObject is called to restore the state of this permission from a stream.private void
setTransients
(Filter f, int mask) Called by constructors and when deserialized.private void
WriteObject is called to save the state of this permission to a stream.Methods inherited from class java.security.Permission
checkGuard, getName, toString
-
Field Details
-
serialVersionUID
static final long serialVersionUID- See Also:
-
GET
The action stringget
.- See Also:
-
REGISTER
The action stringregister
.- See Also:
-
ACTION_GET
private static final int ACTION_GET- See Also:
-
ACTION_REGISTER
private static final int ACTION_REGISTER- See Also:
-
ACTION_ALL
private static final int ACTION_ALL- See Also:
-
ACTION_NONE
static final int ACTION_NONE- See Also:
-
action_mask
transient int action_maskThe actions mask. -
actions
The actions in canonical form. -
service
The service used by this ServicePermission. Must be null if not constructed with a service. -
objectClass
The object classes for this ServicePermission. Must be null if not constructed with a service. -
filter
If this ServicePermission was constructed with a filter, this holds a Filter matching object used to evaluate the filter in implies. -
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. -
wildcard
private transient boolean wildcardTrue if constructed with a name and the name is "*" or ends with ".*". -
prefix
If constructed with a name and the name ends with ".*", this contains the name without the final "*".
-
-
Constructor Details
-
ServicePermission
Create a new ServicePermission.The name of the service is specified as a fully qualified class name. Wildcards may be used.
name ::= <class name> | <class name ending in ".*"> | *
Examples:org.osgi.service.http.HttpService org.osgi.service.http.* *
For theget
action, the name can also be a filter expression. The filter gives access to the service properties as well as the following attributes:- signer - A Distinguished Name chain used to sign the bundle publishing the service. 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 bundle publishing the service.
- id - The bundle ID of the bundle publishing the service.
- name - The symbolic name of the bundle publishing the service.
There are two possible actions:
get
andregister
. Theget
permission allows the owner of this permission to obtain a service with this name. Theregister
permission allows the bundle to register a service under that name.- Parameters:
name
- The service class nameactions
-get
,register
(canonical order)- Throws:
IllegalArgumentException
- If the specified name is a filter expression and either the specified action is notget
or the filter has an invalid syntax.
-
ServicePermission
Creates a new requestedServicePermission
object to be used by code that must performcheckPermission
for theget
action.ServicePermission
objects created with this constructor cannot be added to aServicePermission
permission collection.- Parameters:
reference
- The requested service.actions
- The actionget
.- Throws:
IllegalArgumentException
- If the specified action is notget
or reference isnull
.- Since:
- 1.5
-
ServicePermission
ServicePermission(String name, int mask) Package private constructor used by ServicePermissionCollection.- Parameters:
name
- class namemask
- action mask
-
-
Method Details
-
createName
Create a permission name from a ServiceReference- Parameters:
reference
- ServiceReference to use to create permission name.- Returns:
- permission name.
-
setTransients
Called by constructors and when deserialized.- Parameters:
mask
- action mask
-
parseActions
Parse action string into action mask.- Parameters:
actions
- Action string.- Returns:
- action mask.
-
parseFilter
Parse filter string into a Filter object.- Parameters:
filterString
- The filter string to parse.- Returns:
- a Filter for this bundle. If the specified filterString is not a
filter expression, then
null
is returned. - Throws:
IllegalArgumentException
- If the filter syntax is invalid.
-
implies
Determines if aServicePermission
object "implies" the specified permission.- Overrides:
implies
in classBasicPermission
- Parameters:
p
- The target permission to check.- Returns:
true
if the specified permission is implied by this object;false
otherwise.
-
implies0
Internal implies method. Used by the implies and the permission collection implies methods.- Parameters:
requested
- The requested ServicePermission which has already be validated as a proper argument. The requested ServicePermission must not have a filter expression.effective
- The effective actions with which to start.- Returns:
true
if the specified permission is implied by this object;false
otherwise.
-
getActions
Returns the canonical string representation of the actions. Always returns present actions in the following order:get
,register
.- Overrides:
getActions
in classBasicPermission
- Returns:
- The canonical string representation of the actions.
-
newPermissionCollection
Returns a newPermissionCollection
object for storingServicePermission
objects.- Overrides:
newPermissionCollection
in classBasicPermission
- Returns:
- A new
PermissionCollection
object suitable for storingServicePermission
objects.
-
equals
Determines the equality of two ServicePermission objects. Checks that specified object has the same class name and action as thisServicePermission
.- Overrides:
equals
in classBasicPermission
- Parameters:
obj
- The object to test for equality.- Returns:
- true if obj is a
ServicePermission
, and has the same class name and actions as thisServicePermission
object;false
otherwise.
-
hashCode
public int hashCode()Returns the hash code value for this object.- Overrides:
hashCode
in classBasicPermission
- Returns:
- Hash code value for this object.
-
writeObject
WriteObject is called to save the state of this permission to a stream. The actions are serialized, and the superclass takes care of the name.- Throws:
IOException
-
readObject
readObject is called to restore the state of this permission from a stream.- Throws:
IOException
ClassNotFoundException
-
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.
-