com.marklogic.client.admin

Interface TransformExtensionsManager

public interface TransformExtensionsManager

A Transform Extensions Manager supports writing, reading, and deleting a Transform extension as well as listing the installed Transform extensions. A Transform extension implements conversion of content on the server. For instance, a Transform extension can convert HTML documents to XHTML documents on write or XML documents to HTML documents on read.

Method Summary

Modifier and Type	Method and Description
void	deleteTransform(java.lang.String transformName) Uninstalls the transform.
<T extends StructureReadHandle> T	listTransforms(T listHandle) Lists the installed transform extensions.
<T extends StructureReadHandle> T	listTransforms(T listHandle, boolean refresh) Lists the installed transform extensions, specifying whether to refresh the metadata about each extension by parsing the extension source.
<T> T	listTransformsAs(Format format, java.lang.Class<T> as) Reads the list of transform extensions installed on the server in a JSON or XML representation provided as an object of an IO class.
<T> T	listTransformsAs(Format format, java.lang.Class<T> as, boolean refresh) Reads the list of transform extensions installed on the server in a JSON or XML representation provided as an object of an IO class.
<T extends TextReadHandle> T	readJavascriptTransform(java.lang.String transformName, T sourceHandle) Reads the source for a transform implemented in Javascript.
<T> T	readJavascriptTransformAs(java.lang.String transformName, java.lang.Class<T> as) Reads the source for a transform implemented in Javascript in a textual representation provided as an object of an IO class.
<T extends TextReadHandle> T	readXQueryTransform(java.lang.String transformName, T sourceHandle) Reads the source for a transform implemented in XQuery.
<T> T	readXQueryTransformAs(java.lang.String transformName, java.lang.Class<T> as) Reads the source for a transform implemented in XQuery in a textual representation provided as an object of an IO class.
<T extends XMLReadHandle> T	readXSLTransform(java.lang.String transformName, T sourceHandle) Reads the source for a transform implemented in XSLT.
<T> T	readXSLTransformAs(java.lang.String transformName, java.lang.Class<T> as) Reads the source for a transform implemented in XSLT in an XML representation provided as an object of an IO class.
void	startLogging(RequestLogger logger) Starts debugging client requests.
void	stopLogging() Stops debugging client requests.
void	writeJavascriptTransform(java.lang.String transformName, TextWriteHandle sourceHandle) Installs a transform implemented in Javascript.
void	writeJavascriptTransform(java.lang.String transformName, TextWriteHandle sourceHandle, ExtensionMetadata metadata) Installs a transform implemented in Javascript.
void	writeJavascriptTransformAs(java.lang.String transformName, ExtensionMetadata metadata, java.lang.Object source) Installs a transform implemented in Javascript in a textual representation provided as an object of an IO class.
void	writeJavascriptTransformAs(java.lang.String transformName, java.lang.Object source) Installs a transform implemented in XQuery in a textual representation provided as an object of an IO class.
void	writeXQueryTransform(java.lang.String transformName, TextWriteHandle sourceHandle) Installs a transform implemented in XQuery.
void	writeXQueryTransform(java.lang.String transformName, TextWriteHandle sourceHandle, ExtensionMetadata metadata) Installs a transform implemented in XQuery.
void	writeXQueryTransformAs(java.lang.String transformName, ExtensionMetadata metadata, java.lang.Object source) Installs a transform implemented in XQuery in a textual representation provided as an object of an IO class.
void	writeXQueryTransformAs(java.lang.String transformName, java.lang.Object source) Installs a transform implemented in XQuery in a textual representation provided as an object of an IO class.
void	writeXSLTransform(java.lang.String transformName, XMLWriteHandle sourceHandle) Installs a transform implemented in XSL.
void	writeXSLTransform(java.lang.String transformName, XMLWriteHandle sourceHandle, ExtensionMetadata metadata) Installs a transform implemented in XSL.
void	writeXSLTransformAs(java.lang.String transformName, ExtensionMetadata metadata, java.lang.Object source) Installs a transform implemented in XSL in an XML representation provided as an object of an IO class.
void	writeXSLTransformAs(java.lang.String transformName, java.lang.Object source) Installs a transform implemented in XSL in an XML representation provided as an object of an IO class.

Method Detail

listTransformsAs

<T> T listTransformsAs(Format format,
                       java.lang.Class<T> as)

Reads the list of transform extensions installed on the server in a JSON or XML representation provided 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:

format - whether to provide the list in a JSON or XML representation

as - the IO class for reading the list of transform extensions

Returns:

an object of the IO class with the list of transform extensions

listTransformsAs

<T> T listTransformsAs(Format format,
                       java.lang.Class<T> as,
                       boolean refresh)

Reads the list of transform extensions installed on the server in a JSON or XML representation provided 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:

format - whether to provide the list in a JSON or XML representation

as - the IO class for reading the list of transform extensions

refresh - whether to parse metadata from the extension source

Returns:

an object of the IO class with the list of transform extensions

listTransforms

<T extends StructureReadHandle> T listTransforms(T listHandle)
                                          throws ForbiddenUserException,
                                                 FailedRequestException

Lists the installed transform extensions.

Type Parameters:

T - the type of StructureReadHandle to return

Parameters:

listHandle - a handle on a JSON or XML representation of the list

Returns:

the list handle

Throws:

ForbiddenUserException

FailedRequestException

listTransforms

<T extends StructureReadHandle> T listTransforms(T listHandle,
                                                 boolean refresh)
                                          throws ForbiddenUserException,
                                                 FailedRequestException

Lists the installed transform extensions, specifying whether to refresh the metadata about each extension by parsing the extension source.

Type Parameters:

T - the type of StructureReadHandle to return

Parameters:

listHandle - a handle on a JSON or XML representation of the list

refresh - whether to parse metadata from the extension source

Returns:

the list handle

Throws:

ForbiddenUserException

FailedRequestException

readXSLTransformAs

<T> T readXSLTransformAs(java.lang.String transformName,
                         java.lang.Class<T> as)
                  throws ResourceNotFoundException,
                         ForbiddenUserException,
                         FailedRequestException

Reads the source for a transform implemented in XSLT in an XML representation provided 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:

transformName - the name of the transform

as - the IO class for reading the source code as XML

Returns:

an object of the IO class with the XSLT source code

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

readXSLTransform

<T extends XMLReadHandle> T readXSLTransform(java.lang.String transformName,
                                             T sourceHandle)
                                      throws FailedRequestException,
                                             ResourceNotFoundException,
                                             ForbiddenUserException

Reads the source for a transform implemented in XSLT.

Type Parameters:

T - the type of XMLReadHandle to return

Parameters:

transformName - the name of the transform

sourceHandle - a handle for reading the text of the XSLT implementation.

Returns:

the XSLT source code

Throws:

FailedRequestException

ResourceNotFoundException

ForbiddenUserException

readXQueryTransformAs

<T> T readXQueryTransformAs(java.lang.String transformName,
                            java.lang.Class<T> as)
                     throws ResourceNotFoundException,
                            ForbiddenUserException,
                            FailedRequestException

Reads the source for a transform implemented in XQuery in a textual representation provided 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:

transformName - the name of the transform

as - the IO class for reading the source code as text

Returns:

an object of the IO class with the XQuery source code

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

readXQueryTransform

<T extends TextReadHandle> T readXQueryTransform(java.lang.String transformName,
                                                 T sourceHandle)
                                          throws FailedRequestException,
                                                 ResourceNotFoundException,
                                                 ForbiddenUserException

Reads the source for a transform implemented in XQuery.

Type Parameters:

T - the type of TextReadHandle to return

Parameters:

transformName - the name of the transform

sourceHandle - a handle for reading the text of the XQuery implementation.

Returns:

the XQuery source code

Throws:

FailedRequestException

ResourceNotFoundException

ForbiddenUserException

readJavascriptTransformAs

<T> T readJavascriptTransformAs(java.lang.String transformName,
                                java.lang.Class<T> as)
                         throws ResourceNotFoundException,
                                ForbiddenUserException,
                                FailedRequestException

Reads the source for a transform implemented in Javascript in a textual representation provided 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:

transformName - the name of the transform

as - the IO class for reading the source code as text

Returns:

an object of the IO class with the Javascript source code

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

readJavascriptTransform

<T extends TextReadHandle> T readJavascriptTransform(java.lang.String transformName,
                                                     T sourceHandle)
                                              throws FailedRequestException,
                                                     ResourceNotFoundException,
                                                     ForbiddenUserException

Reads the source for a transform implemented in Javascript.

Type Parameters:

T - the type of TextReadHandle to return

Parameters:

transformName - the name of the transform

sourceHandle - a handle for reading the text of the Javascript implementation.

Returns:

the Javascript source code

Throws:

FailedRequestException

ResourceNotFoundException

ForbiddenUserException

writeXSLTransformAs

void writeXSLTransformAs(java.lang.String transformName,
                         java.lang.Object source)
                  throws ResourceNotFoundException,
                         ResourceNotResendableException,
                         ForbiddenUserException,
                         FailedRequestException

Installs a transform implemented in XSL in an XML representation provided 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:

transformName - the name of the transform

source - an IO representation of the source code

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

writeXSLTransformAs

void writeXSLTransformAs(java.lang.String transformName,
                         ExtensionMetadata metadata,
                         java.lang.Object source)
                  throws ResourceNotFoundException,
                         ResourceNotResendableException,
                         ForbiddenUserException,
                         FailedRequestException

Installs a transform implemented in XSL in an XML representation provided 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:

transformName - the name of the transform

metadata - the metadata about the transform

source - an IO representation of the source code

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

writeXSLTransform

void writeXSLTransform(java.lang.String transformName,
                       XMLWriteHandle sourceHandle)
                throws ResourceNotFoundException,
                       ResourceNotResendableException,
                       ForbiddenUserException,
                       FailedRequestException

Installs a transform implemented in XSL.

Parameters:

transformName - the name of the resource

sourceHandle - a handle on the source for the XSL implementation

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

writeXSLTransform

void writeXSLTransform(java.lang.String transformName,
                       XMLWriteHandle sourceHandle,
                       ExtensionMetadata metadata)
                throws ResourceNotFoundException,
                       ResourceNotResendableException,
                       ForbiddenUserException,
                       FailedRequestException

Installs a transform implemented in XSL.

Parameters:

transformName - the name of the resource

sourceHandle - a handle on the source for the XSL implementation

metadata - the metadata about the transform

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

writeXQueryTransformAs

void writeXQueryTransformAs(java.lang.String transformName,
                            java.lang.Object source)
                     throws ResourceNotFoundException,
                            ResourceNotResendableException,
                            ForbiddenUserException,
                            FailedRequestException

Installs a transform implemented in XQuery in a textual representation provided 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:

transformName - the name of the transform

source - an IO representation of the source code

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

writeXQueryTransformAs

void writeXQueryTransformAs(java.lang.String transformName,
                            ExtensionMetadata metadata,
                            java.lang.Object source)
                     throws ResourceNotFoundException,
                            ResourceNotResendableException,
                            ForbiddenUserException,
                            FailedRequestException

Installs a transform implemented in XQuery in a textual representation provided 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:

transformName - the name of the transform

metadata - the metadata about the transform

source - an IO representation of the source code

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

writeXQueryTransform

void writeXQueryTransform(java.lang.String transformName,
                          TextWriteHandle sourceHandle)
                   throws ResourceNotFoundException,
                          ResourceNotResendableException,
                          ForbiddenUserException,
                          FailedRequestException

Installs a transform implemented in XQuery.

Parameters:

transformName - the name of the resource

sourceHandle - a handle on the source for the XQuery implementation

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

writeXQueryTransform

void writeXQueryTransform(java.lang.String transformName,
                          TextWriteHandle sourceHandle,
                          ExtensionMetadata metadata)
                   throws ResourceNotFoundException,
                          ResourceNotResendableException,
                          ForbiddenUserException,
                          FailedRequestException

Installs a transform implemented in XQuery.

Parameters:

transformName - the name of the resource

sourceHandle - a handle on the source for the XQuery implementation

metadata - the metadata about the transform

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

writeJavascriptTransformAs

void writeJavascriptTransformAs(java.lang.String transformName,
                                java.lang.Object source)
                         throws ResourceNotFoundException,
                                ResourceNotResendableException,
                                ForbiddenUserException,
                                FailedRequestException

Installs a transform implemented in XQuery in a textual representation provided 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:

transformName - the name of the transform

source - an IO representation of the source code

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

writeJavascriptTransformAs

void writeJavascriptTransformAs(java.lang.String transformName,
                                ExtensionMetadata metadata,
                                java.lang.Object source)
                         throws ResourceNotFoundException,
                                ResourceNotResendableException,
                                ForbiddenUserException,
                                FailedRequestException

Installs a transform implemented in Javascript in a textual representation provided 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:

transformName - the name of the transform

metadata - the metadata about the transform

source - an IO representation of the source code

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

writeJavascriptTransform

void writeJavascriptTransform(java.lang.String transformName,
                              TextWriteHandle sourceHandle)
                       throws ResourceNotFoundException,
                              ResourceNotResendableException,
                              ForbiddenUserException,
                              FailedRequestException

Installs a transform implemented in Javascript.

Parameters:

transformName - the name of the resource

sourceHandle - a handle on the source for the Javascript implementation

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

writeJavascriptTransform

void writeJavascriptTransform(java.lang.String transformName,
                              TextWriteHandle sourceHandle,
                              ExtensionMetadata metadata)
                       throws ResourceNotFoundException,
                              ResourceNotResendableException,
                              ForbiddenUserException,
                              FailedRequestException

Installs a transform implemented in Javascript.

Parameters:

transformName - the name of the resource

sourceHandle - a handle on the source for the Javascript implementation

metadata - the metadata about the transform

Throws:

ResourceNotFoundException

ResourceNotResendableException

ForbiddenUserException

FailedRequestException

deleteTransform

void deleteTransform(java.lang.String transformName)
              throws ResourceNotFoundException,
                     ForbiddenUserException,
                     FailedRequestException

Uninstalls the transform.

Parameters:

transformName - the name of the transform

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

startLogging

void startLogging(RequestLogger logger)

Starts debugging client requests. You can suspend and resume debugging output using the methods of the logger.

Parameters:

logger - the logger that receives debugging output

stopLogging

void stopLogging()

Stops debugging client requests.