com.marklogic.xdmp
Class XDMPPermission

java.lang.Object
  com.marklogic.xdmp.XDMPPermission

public class XDMPPermission

extends Object

Specifies a document permission when opening a document insert stream.

See Also:

XDMPConnection.openDocInsertStream(java.lang.String, java.util.Locale, boolean, com.marklogic.xdmp.XDMPPermission[]), XDMPConnection.openDocInsertStream(java.lang.String, java.util.Locale, boolean, com.marklogic.xdmp.XDMPPermission[], java.lang.String[])

Field Summary

static int	INSERT Specifies insert capability.
static int	READ Specifies read capability.
static int	UPDATE Specifies update capability.

Constructor Summary

XDMPPermission(int capability, String role)
Constructor for an XDMPPermission.

Method Summary

int	getCapability() Returns the capability.
String	getRole() Returns the role name.
String	toString() Returns a string representation of this XDMPPermission object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

READ

public static final int READ

Specifies read capability.

See Also:

XDMPPermission(int, java.lang.String), getCapability(), Constant Field Values

INSERT

public static final int INSERT

Specifies insert capability.

See Also:

XDMPPermission(int, java.lang.String), getCapability(), Constant Field Values

UPDATE

public static final int UPDATE

Specifies update capability.

See Also:

XDMPPermission(int, java.lang.String), getCapability(), Constant Field Values

Constructor Detail

XDMPPermission

public XDMPPermission(int capability,
                      String role)

Constructor for an XDMPPermission.

Parameters:

capability - a capability.

role - a role name.

See Also:

READ, INSERT, UPDATE

Method Detail

getRole

public String getRole()

Returns the role name.

Returns:

the role name.

getCapability

public int getCapability()

Returns the capability.

Returns:

the capability.

See Also:

READ, INSERT, UPDATE

toString

public String toString()

Returns a string representation of this XDMPPermission object.

Returns:

a string representation of this XDMPPermission.