public interface ExtensionLibrariesManager
| Modifier and Type | Method | Description |
|---|---|---|
void |
delete(ExtensionLibraryDescriptor libraryDescriptor) |
Removes a library asset from the server.
|
void |
delete(java.lang.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(java.lang.String directory) |
Lists all of the library files in one directory (infinite depth) on the server.
|
<T> T |
read(ExtensionLibraryDescriptor libraryDescriptor,
java.lang.Class<T> as) |
Reads the contents of a library asset as an object of an IO class.
|
<T extends AbstractReadHandle> |
read(ExtensionLibraryDescriptor libraryDescriptor,
T readHandle) |
Reads the contents of a library asset into a handle.
|
<T extends AbstractReadHandle> |
read(java.lang.String libraryPath,
T readHandle) |
Reads the contents of a library asset into a handle.
|
<T> T |
readAs(java.lang.String libraryPath,
java.lang.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(java.lang.String libraryPath,
AbstractWriteHandle contentHandle) |
Writes the contents of a handle to the provided path on the REST server.
|
void |
writeAs(ExtensionLibraryDescriptor libraryDescriptor,
java.lang.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(java.lang.String libraryPath,
java.lang.Object content) |
Writes the contents of a handle to the provided path on the REST server
as an object of an IO class.
|
ExtensionLibraryDescriptor[] list() throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
ResourceNotFoundExceptionForbiddenUserExceptionFailedRequestExceptionExtensionLibraryDescriptor[] list(java.lang.String directory) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
directory - The directory to list.ResourceNotFoundExceptionForbiddenUserExceptionFailedRequestException<T> T readAs(java.lang.String libraryPath,
java.lang.Class<T> as)
throws ResourceNotFoundException,
ForbiddenUserException,
FailedRequestException
ContentHandle are registered.
Learn more about shortcut methodsT - the type of object that will be returned by the handle registered for itlibraryPath - the path to the libraryas - the IO class for reading the library assetResourceNotFoundExceptionForbiddenUserExceptionFailedRequestException<T> T read(ExtensionLibraryDescriptor libraryDescriptor, java.lang.Class<T> as) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
ContentHandle are registered.
Learn more about shortcut methodsT - the type of AbstractReadHandle to returnlibraryDescriptor - a descriptor that locates the libraryas - the IO class for reading the library assetResourceNotFoundExceptionForbiddenUserExceptionFailedRequestException<T extends AbstractReadHandle> T read(java.lang.String libraryPath, T readHandle) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T - the type of AbstractReadHandle to returnlibraryPath - the path to the libraryreadHandle - a handle for reading the contents of the fileResourceNotFoundExceptionForbiddenUserExceptionFailedRequestException<T extends AbstractReadHandle> T read(ExtensionLibraryDescriptor libraryDescriptor, T readHandle) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
T - the type of AbstractReadHandle to returnlibraryDescriptor - a descriptor that locates the library.readHandle - A handle for reading the contents of the file.ResourceNotFoundExceptionForbiddenUserExceptionFailedRequestExceptionvoid writeAs(java.lang.String libraryPath,
java.lang.Object content)
throws ResourceNotFoundException,
ResourceNotResendableException,
ForbiddenUserException,
FailedRequestException
ContentHandle are registered.
Learn more about shortcut methodslibraryPath - The path at which to install the library.content - an IO representation of the library assetResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid writeAs(ExtensionLibraryDescriptor libraryDescriptor, java.lang.Object content) throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException
ContentHandle are registered.
Learn more about shortcut methodslibraryDescriptor - The descriptory which locates where to install the library.content - an IO representation of the library assetResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid write(java.lang.String libraryPath,
AbstractWriteHandle contentHandle)
throws ResourceNotFoundException,
ResourceNotResendableException,
ForbiddenUserException,
FailedRequestException
libraryPath - The path at which to install the library.contentHandle - The handle containing the contents of the library.ResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid write(ExtensionLibraryDescriptor libraryDescriptor, AbstractWriteHandle contentHandle) throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException
libraryDescriptor - The descriptory which locates where to install the library.contentHandle - The handle containing the contents of the library.ResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid delete(java.lang.String libraryPath)
throws ResourceNotFoundException,
ForbiddenUserException,
FailedRequestException
libraryPath - The path to the library to delete.ResourceNotFoundExceptionForbiddenUserExceptionFailedRequestExceptionvoid delete(ExtensionLibraryDescriptor libraryDescriptor) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
libraryDescriptor - A descriptor locating the library to delete.ResourceNotFoundExceptionForbiddenUserExceptionFailedRequestExceptionCopyright © 2013-2021 MarkLogic Corporation.