com.marklogic.client.admin

Interface ExtensionLibrariesManager

public interface ExtensionLibrariesManager

ExtensionLibrariesManager provides methods to read, list and update server-side XQuery modules that reside in the REST instanance's modules database. It can be used for any assets or code that an application needs to store on the server as part of the server-side logic.

Method Summary

Modifier and Type	Method and Description
void	delete(ExtensionLibraryDescriptor libraryDescriptor) Removes a library asset from the server.
void	delete(String libraryPath) Removes a library asset from the server.
ExtensionLibraryDescriptor[]	list() Lists all of the library files that are installed on the server.
ExtensionLibraryDescriptor[]	list(String directory) Lists all of the library files in one directory (infinite depth) on the server.
<T> T	read(ExtensionLibraryDescriptor libraryDescriptor, Class<T> as) Reads the contents of a library asset as an object of an IO class.
<T extends AbstractReadHandle> T	read(ExtensionLibraryDescriptor libraryDescriptor, T readHandle) Reads the contents of a library asset into a handle.
<T extends AbstractReadHandle> T	read(String libraryPath, T readHandle) Reads the contents of a library asset into a handle.
<T> T	readAs(String libraryPath, Class<T> as) Reads the contents of a library asset as an object of an IO class.
void	write(ExtensionLibraryDescriptor libraryDescriptor, AbstractWriteHandle contentHandle) Writes the contents of a handle to the provided path on the REST server.
void	write(String libraryPath, AbstractWriteHandle contentHandle) Writes the contents of a handle to the provided path on the REST server.
void	writeAs(ExtensionLibraryDescriptor libraryDescriptor, Object content) Writes the contents of a handle to the provided path on the REST server as an object of an IO class.
void	writeAs(String libraryPath, Object content) Writes the contents of a handle to the provided path on the REST server as an object of an IO class.

Method Detail

list

ExtensionLibraryDescriptor[] list()
                           throws ResourceNotFoundException,
                                  ForbiddenUserException,
                                  FailedRequestException

Lists all of the library files that are installed on the server.

Returns:

An array of ExtensionLibraryDescriptor objects.

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

list

ExtensionLibraryDescriptor[] list(String directory)
                           throws ResourceNotFoundException,
                                  ForbiddenUserException,
                                  FailedRequestException

Lists all of the library files in one directory (infinite depth) on the server.

Parameters:

directory - The directory to list.

Returns:

An array of ExtensionLibraryDescriptor objects.

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

readAs

<T> T readAs(String libraryPath,
             Class<T> as)
      throws ResourceNotFoundException,
             ForbiddenUserException,
             FailedRequestException

Reads the contents of a library asset as an object of an IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

Type Parameters:

T - the type of object that will be returned by the handle registered for it

Parameters:

libraryPath - the path to the library

as - the IO class for reading the library asset

Returns:

an object of the IO class with the library asset

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

read

<T> T read(ExtensionLibraryDescriptor libraryDescriptor,
           Class<T> as)
    throws ResourceNotFoundException,
           ForbiddenUserException,
           FailedRequestException

Reads the contents of a library asset as an object of an IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

Type Parameters:

T - the type of AbstractReadHandle to return

Parameters:

libraryDescriptor - a descriptor that locates the library

as - the IO class for reading the library asset

Returns:

an object of the IO class with the library asset

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

read

<T extends AbstractReadHandle> T read(String libraryPath,
                                      T readHandle)
                               throws ResourceNotFoundException,
                                      ForbiddenUserException,
                                      FailedRequestException

Reads the contents of a library asset into a handle.

Type Parameters:

T - the type of AbstractReadHandle to return

Parameters:

libraryPath - the path to the library

readHandle - a handle for reading the contents of the file

Returns:

the handle for the library asset

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

read

<T extends AbstractReadHandle> T read(ExtensionLibraryDescriptor libraryDescriptor,
                                      T readHandle)
                               throws ResourceNotFoundException,
                                      ForbiddenUserException,
                                      FailedRequestException

Reads the contents of a library asset into a handle.

Type Parameters:

T - the type of AbstractReadHandle to return

Parameters:

libraryDescriptor - a descriptor that locates the library.

readHandle - A handle for reading the contents of the file.

Returns:

The handle.

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

writeAs

void writeAs(String libraryPath,
             Object content)
      throws ResourceNotFoundException,
             ResourceNotResendableException,
             ForbiddenUserException,
             FailedRequestException

Writes the contents of a handle to the provided path on the REST server as an object of an IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

Parameters:

libraryPath - The path at which to install the library.

content - an IO representation of the library asset

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

writeAs

void writeAs(ExtensionLibraryDescriptor libraryDescriptor,
             Object content)
      throws ResourceNotFoundException,
             ResourceNotResendableException,
             ForbiddenUserException,
             FailedRequestException

Writes the contents of a handle to the provided path on the REST server as an object of an IO class. The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered. Learn more about shortcut methods

Parameters:

libraryDescriptor - The descriptory which locates where to install the library.

content - an IO representation of the library asset

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

write

void write(String libraryPath,
           AbstractWriteHandle contentHandle)
    throws ResourceNotFoundException,
           ResourceNotResendableException,
           ForbiddenUserException,
           FailedRequestException

Writes the contents of a handle to the provided path on the REST server.

Parameters:

libraryPath - The path at which to install the library.

contentHandle - The handle containing the contents of the library.

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

write

void write(ExtensionLibraryDescriptor libraryDescriptor,
           AbstractWriteHandle contentHandle)
    throws ResourceNotFoundException,
           ResourceNotResendableException,
           ForbiddenUserException,
           FailedRequestException

Writes the contents of a handle to the provided path on the REST server.

Parameters:

libraryDescriptor - The descriptory which locates where to install the library.

contentHandle - The handle containing the contents of the library.

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

delete

void delete(String libraryPath)
     throws ResourceNotFoundException,
            ForbiddenUserException,
            FailedRequestException

Removes a library asset from the server.

Parameters:

libraryPath - The path to the library to delete.

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

delete

void delete(ExtensionLibraryDescriptor libraryDescriptor)
     throws ResourceNotFoundException,
            ForbiddenUserException,
            FailedRequestException

Removes a library asset from the server.

Parameters:

libraryDescriptor - A descriptor locating the library to delete.

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException