Implementing review zone providers
A default implementation of Content Services provides a
default review zone provider for the building block. You can replace
the default review zone provider implementation with a custom review
zone provider.
To implement a custom review zone provider, you create a custom
component based on the ReviewZoneProvider interface. (See
com.adobe.livecycle.rca.rzp.ReviewZoneProvider
interface
in
Solution Accelerators API Reference
.)
The review zone provider handles the interactions between the
Review Commenting & Approval Core service and the content repository.
The review zone provider interactions can be categorized as follows:
-
Storage and retrieval: Provides the functionality to
retrieve review content, review comments, and documents created
during a review. You implement methods such as retrieveContent,
createSpace, and nodeExists to provide the functionality. The following
terms are used in the ReviewZoneProvider interface:
-
Space: A folder in the content repository.
-
Content: The file that is stored in the content repository,
usually in a space.
-
Node: Generically refers to a space or content in the content
repository.
-
Permissions: Provides the permissions to access spaces and
content in the content repository. You implement the methods such
as grantPermission and revokePermission to provide the functionality.
Contributors are people that participate in a review and approval
process, such as review initiators, reviewers, and approvers. There
are three permissions used by the review zone provider:
-
The
read
permission allows a contributor to view all
the contents in a space. Read permissions on content indicate that
a contributor can read the contents.
-
The
write
permission allows a contributor add content
to a space and modify existing content in a space, which includes
deleting content. The write permission includes all the permissions
from the read permission.
-
An optimized
contribute
permission is provided with
Content Services. Contribute permissions that allow a contributor
to:
-
See the contents of space.
-
View content created by other users in the same space. The
contributor cannot modify or delete content created by others in
the same space..
-
Create content in a space and have full ownership of the
content.
Some content repositories systems
do not support the contribute permission. Therefore, a default implementation
allows you to provide an implementation without the contribute permission.
For
the default ReviewZoneProvider implementation, customers can configure
the ReviewZoneProvider to use basic permission, such as read and write
permissions for backward compatibility. (See
LiveCycle
ES2.5 Administration Help
.)