|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Not Implemented in CS Java Connector v3.0.
AMarking
object represents a single item in a set of
markings. For example, if a set of markings is called Security Codes,
items within the set might be Top Secret, Secret, Confidential, and so on.
To provide another level of security on the object, you can assign one or more
of these markings to an object. To then be able to access that object, a user must
be granted sufficient access from all assigned markings.
Objects to which markings can be assigned are: Annotation, CustomObject, Custom Events (that is, Event objects of class "Custom Event"), Document, EventAction, Folder, Link, PublishTemplate, SecurityPolicy, StoredSearch, StyleTemplate, Subscription, and WorkflowDefinition.
You cannot create a Marking
object but you can instantiate one
in the following ways:
ActiveMarking
item from the
returned collection (using an approach of your choice), and finally, call
ActiveMarking.getMarking()
.PropertyDescription
object's MarkingSet
object-valued property, then get the Values
collection of markings
from the MarkingSet
object's Markings property,
and finally, instantiate a Marking
object from the value of
an item in the Values
collection.
Method Summary | |
int |
getAccessMask()
Not Implemented in CS Java Connector v3.0. |
java.lang.String |
getClassId()
Not Implemented in CS Java Connector v3.0. |
int |
getConstraintMask()
Not Implemented in CS Java Connector v3.0. |
java.lang.String |
getId()
Not Implemented in CS Java Connector v3.0. |
java.lang.String |
getMarkingValue()
Not Implemented in CS Java Connector v3.0. |
Permissions |
getPermissions()
Not Implemented in CS Java Connector v3.0. |
Method Detail |
public java.lang.String getClassId()
Not Implemented in CS Java Connector v3.0.
Returns the ID of the class description of thisMarking
object.
String
representing the class description ID of this object.public java.lang.String getId()
Not Implemented in CS Java Connector v3.0.
Returns theMarking
object's ID.
The ID is a GUID (the value of the object's Id property).
String
representing the ID of this object.public java.lang.String getMarkingValue()
Not Implemented in CS Java Connector v3.0.
Returns the value that is associated with thisMarking
object.
A marking is assigned to an object by setting the object's String-valued
property that has been associated with the marking set.
For example, if the value of a marking is "Confidential", the string
returned by this method will contain "Confidential".
String
representing this marking's value.public Permissions getPermissions()
Not Implemented in CS Java Connector v3.0.
Returns the set of permissions associated with thisMarking
object. Marking permissions control access to the object on which the
marking is applied. Use the permissions to determine:
Marking
object
is assigned to the object.Marking
object to an
object.Marking
object from an
object after it has been assigned.To determine the access rights, iterate through the returned
collection and retrieve each Permission
object. Then call
getAccess()
on each
Permission
object
to determine the access right associated with the grantee. For
example, if the grantee has been granted Add
(RIGHT_ADD_MARKING
) or Remove (RIGHT_REMOVE_MARKING
)
permission, that user or group is allowed to, respectively, assign this
marking to an object or remove this marking from an object.
If the grantee has been granted Use permission (RIGHT_USE_MARKING
),
then that user or group is authorized to access the object to which this
marking has been assigned.
Permissions
collection containing the
Permission
objects associated with this Marking
object.public int getConstraintMask()
Not Implemented in CS Java Connector v3.0.
Returns a value that represents the set of access rights affected by thisMarking
object when it is assigned to an object. A
constraint mask is used to remove any access rights to an object when this
marking is assigned. For example, if you assign a marking to an object,
and the marking's permissions have not granted the user or group the "Use"
access right (Permission.RIGHT_USE_MARKING
), then the rights
represented by bits in the constraint mask are subtracted (removed) from the preliminary
Effective Access Mask that was computed by the authorization service. The
computed result of this subtraction is the Effective Access Mask for the object.
integer
that represents a bit mask of access rights.
The integer represents any combination of Permission.RIGHT_XXX
values.
For example, a value of 0xFFFFFFFF indicates that all access rights in the
constraint mask will be removed from the preliminary Effective
Access Mask, resulting in a computed Effective Access Mask that
prevents all access to the object in question.public int getAccessMask()
Not Implemented in CS Java Connector v3.0.
Returns the effective mask for thisMarking
object based on
the current user and the Marking
object's permissions.
(The current user is identified in the Session
object.)
Use the returned integer to determine if a given user has the appropriate
rights to perform marking-related operations on an object.
Possible return values are 0, Permission.RIGHT_ADD_MARKING
,
Permission.RIGHT_USE_MARKING
, Permission.RIGHT_REMOVE_MARKING
, or
combinations of these values.
For example, if this method returns Permission.RIGHT_ADD_MARKING
,
you know that the current user has the right to assign this marking to an object.
If this method returns 0, the user cannot add the marking to or remove
the marking from an object, and is not granted Use privileges if the marking
is assigned to an object.
In this case, if this was the only marking assigned to an object,
the object's Effective Access Mask would deny access to those rights
defined by the marking's constraint mask.
integer
that represents the Effective Access Mask
for this Marking
object.
|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |