com.marklogic.client.admin

Class ExtensionLibraryDescriptor

java.lang.Object

com.marklogic.client.admin.ExtensionLibraryDescriptor

public class ExtensionLibraryDescriptor
extends Object

Identifies a module in the REST server's modules database. A module is stored at a path, starting with "/ext/" in the modules database. This class wraps this path plus any permissions assigned to the module.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExtensionLibraryDescriptor.Permission Wraps assigned permissions for an extension into a Java object.

Constructor Summary

Constructors

Constructor and Description
ExtensionLibraryDescriptor() No-argument constructor.

Method Summary

Modifier and Type	Method and Description
void	addPermission(String roleName, String capability) adds a permission to this module
String	getPath() gets the path of this module/asset
List<ExtensionLibraryDescriptor.Permission>	getPermissions() gets the list of permissions assigned to this module, beyond the default permissions.
void	setPath(String path) Sets the path for this module descriptor.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExtensionLibraryDescriptor

public ExtensionLibraryDescriptor()

No-argument constructor.

Method Detail

getPath

public String getPath()

gets the path of this module/asset

Returns:

The path

setPath

public void setPath(String path)

Sets the path for this module descriptor.

Parameters:

path - The path. Must begin with "/ext/"

addPermission

public void addPermission(String roleName,
                          String capability)

adds a permission to this module

Parameters:

roleName - the role name to which the permission applies

capability - the capability of the permission.

getPermissions

public List<ExtensionLibraryDescriptor.Permission> getPermissions()

gets the list of permissions assigned to this module, beyond the default permissions.

Returns:

a List of Permission objects.