|
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.
ASecurityPolicy
object is an independently persistable, subclassable container
object for a list of SecurityTemplate
objects.
A SecurityPolicy
object is associated with a Document
,
CustomObject
, or Folder
object, and subclasses of
those objects, through the object's SecurityPolicy property. When you create
an object of one of these types, you can optionally
assign a SecurityPolicy
object to it. If not explicitly assigned,
the object's SecurityPolicy property is assigned a value given by the class's
default. If the object has no
associated security policy, its permissions remain unchanged when it undergoes
a versioning change.
If the object has an associated SecurityPolicy
object,
its permissions are modified according to the non-disabled, applicable
security templates of its SecurityPolicy
when:
changeClass
method).In addition, an application can modify the security on the object by
explicitly applying individual security templates contained in the
security policy. For more information, see the applySecurityTemplate
methods on the Document
, CustomObject
, or
Folder
interfaces.
You can create a new SecurityPolicy
object in the following ways:
createObject
method on an ObjectStore
object, specifying a constant of
ClassDescription.SECURITY_POLICY
for the class ID.createObject
method on an ObjectStore
object, specifying the class ID
of the applicable SecurityPolicy
subclass.
You can instantiate a persisted SecurityPolicy
object in the following ways:
getObject
method on an ObjectStore
object, specifying a constant of
BaseObject.TYPE_SECURITY_POLICY
for the object type.SecurityPolicies
collection, then obtaining
a SecurityPolicy
object from the collection. For ways to instantiate
a SecurityPolicies
collection, see the
SecurityPolicies
interface.Document
,
CustomObject
, or Folder
object, or on a subclass
of one of those objects.
Field Summary |
Method Summary | |
void |
delete()
Not Implemented in CS Java Connector v3.0. |
java.lang.String |
getPermissionsXML()
Not Implemented in CS Java Connector v3.0. |
java.lang.String |
getTemplatesXML()
Not Implemented in CS Java Connector v3.0. |
Permissions |
getUserAccess()
Not Implemented in CS Java Connector v3.0. |
Permissions |
getUserAccess(java.lang.String collectionType)
Not Implemented in CS Java Connector v3.0. |
Permissions |
getUserAccess(java.lang.String collectionType,
java.lang.String userId)
Not Implemented in CS Java Connector v3.0. |
Permissions |
getUserAccess(java.lang.String collectionType,
java.lang.String userId,
java.lang.String domain)
Deprecated. Use getUserAccess(collectionType, userId) form of this method. |
java.lang.String |
getUserAccessXML()
Not Implemented in CS Java Connector v3.0. |
Methods inherited from interface com.filenet.wcm.api.BaseObject |
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject |
Methods inherited from interface com.filenet.wcm.api.WriteableSecurityObject |
setPermissions, setPermissions |
Methods inherited from interface com.filenet.wcm.api.WriteableMetadataObject |
setProperties |
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject |
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh |
Methods inherited from interface com.filenet.wcm.api.ReadableSecurityObject |
getPermissions, getPermissions |
Method Detail |
public java.lang.String getPermissionsXML()
Not Implemented in CS Java Connector v3.0.
Retrieves aString
in XML representing the
permissions for this SecurityPolicy
object. The user must have
Read permission on the object's security (either Permission.LEVEL_VIEW
or
Permission.RIGHT_READ_ACL
) to retrieve the object's permissions.
Note that the returned string represents basic object permissions (that is,
an object's Permissions property).
String
in XML representing the
basic object permissions for this object. For documentation
that describes the XML schema used to generate the string, refer to
Schemas
in the FileNet P8 Developer's Roadmap.
public Permissions getUserAccess()
Not Implemented in CS Java Connector v3.0.
Returns a collection ofPermission
objects representing the
access rights for the current user on this
SecurityPolicy
object. (The current user is identified in the
Session
object.) The elements in
the returned collection are the access rights assigned to the current
user and to any groups to which this user belongs. If the user does not
have explicit rights, this method returns only the access rights of the
groups to which the user belongs.
Note that the returned Permissions
collection represents
basic object permissions (that is, an object's Permissions property).
To specify the type of permissions (basic object or audit) to retrieve
for the current user, use getUserAccess(collectionType)
.
To retrieve permissions for a specific user, use
getUserAccess(collectionType, userId, domain)
.
Permissions
collection containing the access
rights for the current user on this SecurityPolicy
object.public Permissions getUserAccess(java.lang.String collectionType)
Not Implemented in CS Java Connector v3.0.
Returns a collection ofPermission
objects representing the
access rights of the specified type for the
current user on this SecurityPolicy
object. (The current user
is identified in the Session
object.
The elements in the returned collection are the access rights assigned
to the current user and to any groups to which this user belongs. If
the user does not have explicit rights, this method returns only the
access rights of the groups to which the user belongs.
Specify the type of permissions (basic object or audit) to return in the
collectionType
parameter.
If the user is not an Administrator and does not have specific
privileges to access audit permissions, this method throws an
InsufficientPermissionException if the specified collection type is
Property.AUDIT_PERMISSIONS
. This exception occurs even if the user
has been granted full control access rights (Permission.LEVEL_FULL_CONTROL
)
to the object. To set audit permissions privileges for the user, refer to the
Enable security auditing
topic.
To retrieve permissions for a specific user, use the
getUserAccess(collectionType, userId, domain)
form of this method.
collectionType
- A String
that is the name of a property whose value is a
collection of Content Services Permission
objects.
Use Property.PERMISSIONS
for basic object
permissions or Property.AUDIT_PERMISSIONS
for audit permissions.
Permissions
collection of the specified type containing the
access rights for the current user on this
SecurityPolicy
object.public Permissions getUserAccess(java.lang.String collectionType, java.lang.String userId)
Not Implemented in CS Java Connector v3.0.
Returns a collection ofPermission
objects representing the
access rights of the specified type for a
specified user on this SecurityPolicy
object.
The elements in the returned collection are the access rights assigned
to the specified user and to any groups to which this user belongs. If
the user does not have explicit rights, this method returns only the
access rights of the groups to which the user belongs.
Specify the type of permissions to return in the
collectionType
parameter. The only valid value for
collectionType
is the
Property.PERMISSIONS
constant for basic object permissions.
To retrieve the access rights for the current user, call either
getUserAccess()
(to retrieve basic object permissions) or
getUserAccess(collectionType)
(to specify the type of permissions to retrieve).
collectionType
- A String
that is the name of a property whose value is a
collection of Content Services Permission
objects.
Use Property.PERMISSIONS
for basic object
permissions.
userId
- A String
(whose value is the User
object's Name property) that identifies the user for whom
permissions are to be retrieved.
Permissions
collection of the specified type containing the
access rights for the specified user on this
SecurityPolicy
object.public Permissions getUserAccess(java.lang.String collectionType, java.lang.String userId, java.lang.String domain)
Not Implemented in CS Java Connector v3.0.
public java.lang.String getUserAccessXML()
Not Implemented in CS Java Connector v3.0.
Retrieves aString
in XML representing the access rights
for the current user on this SecurityPolicy
object. (The current user is identified
in the Session
object.) The elements
in the returned collection are the access rights assigned to the current
user and to any groups to which this user belongs. If the user does not
have explicit rights, this method returns only the access rights of the
groups to which the user belongs.
Note that the returned String
represents basic object permissions (that
is, an object's Permissions property).
String
containing an XML representation of the current user's
access rights for this SecurityPolicy
object. For documentation
that describes the XML schema used to generate the string, refer to
Schemas
in the FileNet P8 Developer's Roadmap.
public void delete()
Not Implemented in CS Java Connector v3.0.
Deletes thisSecurityPolicy
object and all its contained
SecurityTemplate
objects from the object store. To successfully
execute this method, the user must have Delete permission
(Permission.RIGHT_DELETE
) on this SecurityPolicy
object.
You cannot delete this SecurityPolicy
object if it is in use.
This SecurityPolicy
object is considered in use if the SecurityPolicy
property of at least one Document
, Folder
, or
CustomObject
object is set to this SecurityPolicy
object.
public java.lang.String getTemplatesXML()
Not Implemented in CS Java Connector v3.0.
Retrieves aString
in XML representing the
SecurityTemplate
objects contained in this
SecurityPolicy
object.
String
in XML representing the
SecurityTemplate
objects contained in this
SecurityPolicy
object. For documentation
that describes the XML schema used to generate the string, refer to
Schemas
in the FileNet P8 Developer's Roadmap.
|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |