Package org.osgi.service.application
Class ApplicationAdminPermission
- java.lang.Object
-
- java.security.Permission
-
- org.osgi.service.application.ApplicationAdminPermission
-
- All Implemented Interfaces:
java.io.Serializable
,java.security.Guard
public class ApplicationAdminPermission extends java.security.Permission
This class implements permissions for manipulating applications and their instances.ApplicationAdminPermission can be targeted to applications that matches the specified filter.
ApplicationAdminPermission may be granted for different actions:
lifecycle
,schedule
andlock
. The permissionschedule
implies the permissionlifecycle
.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
ApplicationAdminPermission.SignerWrapper
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
actions
private static java.util.Vector
ACTIONS
private java.util.Vector
actionsVector
private ApplicationDescriptor
applicationDescriptor
private java.lang.String
applicationID
private org.osgi.framework.Filter
appliedFilter
private java.lang.String
filter
static java.lang.String
LIFECYCLE_ACTION
Allows the lifecycle management of the target applications.static java.lang.String
LOCK_ACTION
Allows setting/unsetting the locking state of the target applications.static java.lang.String
SCHEDULE_ACTION
Allows scheduling of the target applications.private static long
serialVersionUID
-
Constructor Summary
Constructors Constructor Description ApplicationAdminPermission(java.lang.String filter, java.lang.String actions)
Constructs an ApplicationAdminPermission.ApplicationAdminPermission(ApplicationDescriptor application, java.lang.String actions)
This constructor should be used when creatingApplicationAdminPermission
instance forcheckPermission
call.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static java.util.Vector
actionsVector(java.lang.String actions)
private static boolean
equal(java.lang.Object a, java.lang.Object b)
Compares parameters for equality.boolean
equals(java.lang.Object with)
java.lang.String
getActions()
Returns the actions of this permission.private org.osgi.framework.Filter
getFilter()
int
hashCode()
boolean
implies(java.security.Permission otherPermission)
Checks if the specifiedpermission
is implied by this permission.private void
init()
ApplicationAdminPermission
setCurrentApplicationId(java.lang.String applicationId)
This method can be used in theProtectionDomain
implementation in theimplies
method to insert the application ID of the current application into the permission being checked.
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
LIFECYCLE_ACTION
public static final java.lang.String LIFECYCLE_ACTION
Allows the lifecycle management of the target applications.- See Also:
- Constant Field Values
-
SCHEDULE_ACTION
public static final java.lang.String SCHEDULE_ACTION
Allows scheduling of the target applications. The permission to schedule an application implies that the scheduler can also manage the lifecycle of that application i.e.schedule
implieslifecycle
- See Also:
- Constant Field Values
-
LOCK_ACTION
public static final java.lang.String LOCK_ACTION
Allows setting/unsetting the locking state of the target applications.- See Also:
- Constant Field Values
-
applicationDescriptor
private ApplicationDescriptor applicationDescriptor
-
applicationID
private java.lang.String applicationID
-
ACTIONS
private static final java.util.Vector ACTIONS
-
actionsVector
private java.util.Vector actionsVector
-
filter
private final java.lang.String filter
-
actions
private final java.lang.String actions
-
appliedFilter
private org.osgi.framework.Filter appliedFilter
-
-
Constructor Detail
-
ApplicationAdminPermission
public ApplicationAdminPermission(java.lang.String filter, java.lang.String actions) throws org.osgi.framework.InvalidSyntaxException
Constructs an ApplicationAdminPermission. Thefilter
specifies the target application. Thefilter
is an LDAP-style filter, the recognized properties aresigner
andpid
. The pattern specified in thesigner
is matched with the Distinguished Name chain used to sign the application. Wildcards in a DN are not matched according to the filter string rules, but according to the rules defined for a DN chain. The attributepid
is matched with the PID of the application according to the filter string rules.If the
filter
isnull
then it matches"*"
. Ifactions
is"*"
then it identifies all the possible actions.- Parameters:
filter
- filter to identify application. The valuenull
is equivalent to"*"
and it indicates "all application".actions
- comma-separated list of the desired actions granted on the applications or "*" means all the actions. It must not benull
. The order of the actions in the list is not significant.- Throws:
org.osgi.framework.InvalidSyntaxException
- is thrown if the specifiedfilter
is not syntactically correct.java.lang.NullPointerException
- is thrown if the actions parameter isnull
- See Also:
ApplicationDescriptor
,AdminPermission
-
ApplicationAdminPermission
public ApplicationAdminPermission(ApplicationDescriptor application, java.lang.String actions)
This constructor should be used when creatingApplicationAdminPermission
instance forcheckPermission
call.- Parameters:
application
- The target of the operation, it must not benull
.actions
- The required operation, it must not benull
.- Throws:
java.lang.NullPointerException
- If any of the arguments is null.
-
-
Method Detail
-
setCurrentApplicationId
public ApplicationAdminPermission setCurrentApplicationId(java.lang.String applicationId)
This method can be used in theProtectionDomain
implementation in theimplies
method to insert the application ID of the current application into the permission being checked. This enables the evaluation of the<<SELF>>
pseudo targets.- Parameters:
applicationId
- the ID of the current application.- Returns:
- the permission updated with the ID of the current application
-
implies
public boolean implies(java.security.Permission otherPermission)
Checks if the specifiedpermission
is implied by this permission. The method returns true under the following conditions:- This permission was created by specifying a filter (see
ApplicationAdminPermission(String, String)
) - The implied
otherPermission
was created for a particularApplicationDescriptor
(seeApplicationAdminPermission(ApplicationDescriptor, String)
) - The
filter
of this permission matches theApplicationDescriptor
specified in theotherPermission
. If the filter in this permission is the<<SELF>>
pseudo target, then the currentApplicationId set in theotherPermission
is compared to the application Id of the targetApplicationDescriptor
. - The list of permitted actions in this permission contains all actions
required in the
otherPermission
- Specified by:
implies
in classjava.security.Permission
- Parameters:
otherPermission
- the implied permission- Returns:
- true if this permission implies the
otherPermission
, false otherwise.
- This permission was created by specifying a filter (see
-
equals
public boolean equals(java.lang.Object with)
- Specified by:
equals
in classjava.security.Permission
-
equal
private static boolean equal(java.lang.Object a, java.lang.Object b)
Compares parameters for equality. If both object are null, they are considered equal.- Parameters:
a
- object to compareb
- other object to compare- Returns:
- true if both objects are equal or both are null
-
hashCode
public int hashCode()
- Specified by:
hashCode
in classjava.security.Permission
-
getActions
public java.lang.String getActions()
Returns the actions of this permission.- Specified by:
getActions
in classjava.security.Permission
- Returns:
- the actions specified when this permission was created
-
actionsVector
private static java.util.Vector actionsVector(java.lang.String actions)
-
init
private void init()
-
getFilter
private org.osgi.framework.Filter getFilter()
-
-