|
XCC/J 6.0-6 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.marklogic.xcc.ContentPermission
public class ContentPermission
An individual Content (document) permission, a capability/role pair. Instances of
ContentPermission are immutable and may be shared.
ContentCapability| Field Summary | |
|---|---|
static ContentCapability |
EXECUTE
Convenience reference to ContentCapability.EXECUTE |
static ContentCapability |
INSERT
Convenience reference to ContentCapability.INSERT |
static ContentCapability |
READ
Convenience reference to ContentCapability.READ |
static ContentCapability |
UPDATE
Convenience reference to ContentCapability.UPDATE |
| Constructor Summary | |
|---|---|
ContentPermission(ContentCapability capability,
java.lang.String role)
Instantiate a new permission object with the given capability and role. |
|
| Method Summary | |
|---|---|
boolean |
equals(java.lang.Object obj)
|
ContentCapability |
getCapability()
Get this permission's capability. |
java.lang.String |
getRole()
Get the name of the role associated with this permission. |
int |
hashCode()
|
static ContentPermission |
newExecutePermission(java.lang.String role)
Convenience factory method to create a permission object with execute capability and the given role. |
static ContentPermission |
newInsertPermission(java.lang.String role)
Convenience factory method to create a permission object with insert capability and the given role. |
static ContentPermission |
newReadPermission(java.lang.String role)
Convenience factory method to create a permission object with read capability and the given role. |
static ContentPermission |
newUpdatePermission(java.lang.String role)
Convenience factory method to create a permission object with update capability and the given role. |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final ContentCapability READ
ContentCapability.READ
public static final ContentCapability INSERT
ContentCapability.INSERT
public static final ContentCapability UPDATE
ContentCapability.UPDATE
public static final ContentCapability EXECUTE
ContentCapability.EXECUTE
| Constructor Detail |
|---|
public ContentPermission(ContentCapability capability,
java.lang.String role)
capability - One of the capabilities defined in the typesafe enumeration class
ContentCapabilityrole - A Role name.| Method Detail |
|---|
public static ContentPermission newReadPermission(java.lang.String role)
role - A Role name
public static ContentPermission newInsertPermission(java.lang.String role)
role - A Role name
public static ContentPermission newUpdatePermission(java.lang.String role)
role - A Role name
public static ContentPermission newExecutePermission(java.lang.String role)
role - A Role name
public ContentCapability getCapability()
ContentCapability enumeration.public java.lang.String getRole()
public java.lang.String toString()
toString in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Object
|
XCC/J 6.0-6 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Complete online documentation for MarkLogic Server, XQuery and related components may be found at developer.marklogic.com