Class EndpointPermission
- java.lang.Object
-
- java.security.Permission
-
- org.osgi.service.remoteserviceadmin.EndpointPermission
-
- All Implemented Interfaces:
Serializable,Guard
public final class EndpointPermission extends Permission
A bundle's authority to export, import or read an Endpoint.- The
exportaction allows a bundle to export a service as an Endpoint. - The
importaction allows a bundle to import a service from an Endpoint. - The
readaction allows a bundle to read references to an Endpoint.
EndpointPermissionto read the specific service.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EndpointPermission(String filterString, String actions)Create a new EndpointPermission with the specified filter.EndpointPermission(EndpointDescription endpoint, String localFrameworkUUID, String actions)Creates a new requestedEndpointPermissionobject to be used by code that must performcheckPermission.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)Determines the equality of two EndpointPermission objects.StringgetActions()Returns the canonical string representation of the actions.inthashCode()Returns the hash code value for this object.booleanimplies(Permission p)Determines if aEndpointPermissionobject "implies" the specified permission.PermissionCollectionnewPermissionCollection()Returns a newPermissionCollectionobject for storingEndpointPermissionobjects.-
Methods inherited from class java.security.Permission
checkGuard, getName, toString
-
-
-
-
Field Detail
-
READ
public static final String READ
The action stringread.- See Also:
- Constant Field Values
-
IMPORT
public static final String IMPORT
The action stringimport. Theimportaction implies thereadaction.- See Also:
- Constant Field Values
-
EXPORT
public static final String EXPORT
The action stringexport. Theexportaction implies thereadaction.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EndpointPermission
public EndpointPermission(String filterString, String actions)
Create a new EndpointPermission with the specified filter.The filter will be evaluated against the endpoint properties of a requested EndpointPermission.
There are three possible actions:
read,importandexport. Thereadaction allows the owner of this permission to see the presence of distributed services. Theimportaction allows the owner of this permission to import an endpoint. Theexportaction allows the owner of this permission to export a service.- Parameters:
filterString- The filter string or "*" to match all endpoints.actions- The actionsread,import, orexport.- Throws:
IllegalArgumentException- If the filter has an invalid syntax or the actions are not valid.
-
EndpointPermission
public EndpointPermission(EndpointDescription endpoint, String localFrameworkUUID, String actions)
Creates a new requestedEndpointPermissionobject to be used by code that must performcheckPermission.EndpointPermissionobjects created with this constructor cannot be added to anEndpointPermissionpermission collection.- Parameters:
endpoint- The requested endpoint.localFrameworkUUID- The UUID of the local framework. This is used to support matching theendpoint.framework.uuidendpoint property to the<<LOCAL>>value in the filter expression.actions- The actionsread,import, orexport.- Throws:
IllegalArgumentException- If the endpoint isnullor the actions are not valid.
-
-
Method Detail
-
implies
public boolean implies(Permission p)
Determines if aEndpointPermissionobject "implies" the specified permission.- Specified by:
impliesin classPermission- Parameters:
p- The target permission to check.- Returns:
trueif the specified permission is implied by this object;falseotherwise.
-
getActions
public String getActions()
Returns the canonical string representation of the actions. Always returns present actions in the following canonical order:read,import,export.- Specified by:
getActionsin classPermission- Returns:
- The canonical string representation of the actions.
-
newPermissionCollection
public PermissionCollection newPermissionCollection()
Returns a newPermissionCollectionobject for storingEndpointPermissionobjects.- Overrides:
newPermissionCollectionin classPermission- Returns:
- A new
PermissionCollectionobject suitable for storingEndpointPermissionobjects.
-
equals
public boolean equals(Object obj)
Determines the equality of two EndpointPermission objects. Checks that specified object has the same name, actions and endpoint as thisEndpointPermission.- Specified by:
equalsin classPermission- Parameters:
obj- The object to test for equality.- Returns:
- true If obj is a
EndpointPermission, and has the same name, actions and endpoint as thisEndpointPermissionobject;falseotherwise.
-
hashCode
public int hashCode()
Returns the hash code value for this object.- Specified by:
hashCodein classPermission- Returns:
- Hash code value for this object.
-
-