Package com.levigo.jadice.annotation.auth.web

Class DocumentAnnotationPermission

java.lang.Object
com.levigo.jadice.annotation.auth.web.DocumentAnnotationPermission
All Implemented Interfaces:
Permission<Document>, Serializable
public final class DocumentAnnotationPermission extends Object implements Permission<Document>, Serializable

Attention: this class is a web technology adaption of the jadice document platform version. The original can be found in DocumentAnnotationPermission When using the jadice web toolkit, it is expected to use this implementation on the client at all times.

The default behavior is the following: on the server side, document platform permissions are automatically transformed into a json object when sending data to the client. On the opposite way, i.e. sending a message from client side to be later prcessed by a MessageListener, the json-serialized permissions are transformed again into corresponding document platform versions.

An annotation permission object to be used to define per document annotation permissions. This class contains several predefined permissions which can be used to generate a suitable permission set. As an example take a look at the following code. Assume you would like to define a permission that the removal of annotations within a document should be denied.
At -1- you can use this class to get a predefined annotation permission. For a deny permission use the static constant DENY, otherwise use ALLOW. Then use one of the predefined permissions, in this case the REMOVE_ANNOTATION permission.
At -2- you see an example of how to apply the permission to a single Document instance. Doing so denies the removal of any annotation from this Document; other Documents are not touched by this permission.

    // -1-
    final DocumentAnnotationPermission<Object> re = DocumentAnnotationPermission. DENY.REMOVE;

    // -2-
    final Document document = ...;
    document.getPermissions().getPermissions().add(re);

See Also: