public interface TransformExtensionsManager
| Modifier and Type | Method | Description |
|---|---|---|
void |
deleteTransform(java.lang.String transformName) |
Uninstalls the transform.
|
<T extends StructureReadHandle> |
listTransforms(T listHandle) |
Lists the installed transform extensions.
|
<T extends StructureReadHandle> |
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> |
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> |
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> |
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.
|
<T> T listTransformsAs(Format format, java.lang.Class<T> as)
ContentHandle are registered.
Learn more about shortcut methodsT - the type of object that will be returned by the handle registered for itformat - whether to provide the list in a JSON or XML representationas - the IO class for reading the list of transform extensions<T> T listTransformsAs(Format format, java.lang.Class<T> as, boolean refresh)
ContentHandle are registered.
Learn more about shortcut methodsT - the type of object that will be returned by the handle registered for itformat - whether to provide the list in a JSON or XML representationas - the IO class for reading the list of transform extensionsrefresh - whether to parse metadata from the extension source<T extends StructureReadHandle> T listTransforms(T listHandle) throws ForbiddenUserException, FailedRequestException
T - the type of StructureReadHandle to returnlistHandle - a handle on a JSON or XML representation of the listForbiddenUserExceptionFailedRequestException<T extends StructureReadHandle> T listTransforms(T listHandle, boolean refresh) throws ForbiddenUserException, FailedRequestException
T - the type of StructureReadHandle to returnlistHandle - a handle on a JSON or XML representation of the listrefresh - whether to parse metadata from the extension sourceForbiddenUserExceptionFailedRequestException<T> T readXSLTransformAs(java.lang.String transformName,
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 ittransformName - the name of the transformas - the IO class for reading the source code as XMLResourceNotFoundExceptionForbiddenUserExceptionFailedRequestException<T extends XMLReadHandle> T readXSLTransform(java.lang.String transformName, T sourceHandle) throws FailedRequestException, ResourceNotFoundException, ForbiddenUserException
T - the type of XMLReadHandle to returntransformName - the name of the transformsourceHandle - a handle for reading the text of the XSLT implementation.FailedRequestExceptionResourceNotFoundExceptionForbiddenUserException<T> T readXQueryTransformAs(java.lang.String transformName,
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 ittransformName - the name of the transformas - the IO class for reading the source code as textResourceNotFoundExceptionForbiddenUserExceptionFailedRequestException<T extends TextReadHandle> T readXQueryTransform(java.lang.String transformName, T sourceHandle) throws FailedRequestException, ResourceNotFoundException, ForbiddenUserException
T - the type of TextReadHandle to returntransformName - the name of the transformsourceHandle - a handle for reading the text of the XQuery implementation.FailedRequestExceptionResourceNotFoundExceptionForbiddenUserException<T> T readJavascriptTransformAs(java.lang.String transformName,
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 ittransformName - the name of the transformas - the IO class for reading the source code as textResourceNotFoundExceptionForbiddenUserExceptionFailedRequestException<T extends TextReadHandle> T readJavascriptTransform(java.lang.String transformName, T sourceHandle) throws FailedRequestException, ResourceNotFoundException, ForbiddenUserException
T - the type of TextReadHandle to returntransformName - the name of the transformsourceHandle - a handle for reading the text of the Javascript implementation.FailedRequestExceptionResourceNotFoundExceptionForbiddenUserExceptionvoid writeXSLTransformAs(java.lang.String transformName,
java.lang.Object source)
throws ResourceNotFoundException,
ResourceNotResendableException,
ForbiddenUserException,
FailedRequestException
ContentHandle are registered.
Learn more about shortcut methodstransformName - the name of the transformsource - an IO representation of the source codeResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid writeXSLTransformAs(java.lang.String transformName,
ExtensionMetadata metadata,
java.lang.Object source)
throws ResourceNotFoundException,
ResourceNotResendableException,
ForbiddenUserException,
FailedRequestException
ContentHandle are registered.
Learn more about shortcut methodstransformName - the name of the transformmetadata - the metadata about the transformsource - an IO representation of the source codeResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid writeXSLTransform(java.lang.String transformName,
XMLWriteHandle sourceHandle)
throws ResourceNotFoundException,
ResourceNotResendableException,
ForbiddenUserException,
FailedRequestException
transformName - the name of the resourcesourceHandle - a handle on the source for the XSL implementationResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid writeXSLTransform(java.lang.String transformName,
XMLWriteHandle sourceHandle,
ExtensionMetadata metadata)
throws ResourceNotFoundException,
ResourceNotResendableException,
ForbiddenUserException,
FailedRequestException
transformName - the name of the resourcesourceHandle - a handle on the source for the XSL implementationmetadata - the metadata about the transformResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid writeXQueryTransformAs(java.lang.String transformName,
java.lang.Object source)
throws ResourceNotFoundException,
ResourceNotResendableException,
ForbiddenUserException,
FailedRequestException
ContentHandle are registered.
Learn more about shortcut methodstransformName - the name of the transformsource - an IO representation of the source codeResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid writeXQueryTransformAs(java.lang.String transformName,
ExtensionMetadata metadata,
java.lang.Object source)
throws ResourceNotFoundException,
ResourceNotResendableException,
ForbiddenUserException,
FailedRequestException
ContentHandle are registered.
Learn more about shortcut methodstransformName - the name of the transformmetadata - the metadata about the transformsource - an IO representation of the source codeResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid writeXQueryTransform(java.lang.String transformName,
TextWriteHandle sourceHandle)
throws ResourceNotFoundException,
ResourceNotResendableException,
ForbiddenUserException,
FailedRequestException
transformName - the name of the resourcesourceHandle - a handle on the source for the XQuery implementationResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid writeXQueryTransform(java.lang.String transformName,
TextWriteHandle sourceHandle,
ExtensionMetadata metadata)
throws ResourceNotFoundException,
ResourceNotResendableException,
ForbiddenUserException,
FailedRequestException
transformName - the name of the resourcesourceHandle - a handle on the source for the XQuery implementationmetadata - the metadata about the transformResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid writeJavascriptTransformAs(java.lang.String transformName,
java.lang.Object source)
throws ResourceNotFoundException,
ResourceNotResendableException,
ForbiddenUserException,
FailedRequestException
ContentHandle are registered.
Learn more about shortcut methodstransformName - the name of the transformsource - an IO representation of the source codeResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid writeJavascriptTransformAs(java.lang.String transformName,
ExtensionMetadata metadata,
java.lang.Object source)
throws ResourceNotFoundException,
ResourceNotResendableException,
ForbiddenUserException,
FailedRequestException
ContentHandle are registered.
Learn more about shortcut methodstransformName - the name of the transformmetadata - the metadata about the transformsource - an IO representation of the source codeResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid writeJavascriptTransform(java.lang.String transformName,
TextWriteHandle sourceHandle)
throws ResourceNotFoundException,
ResourceNotResendableException,
ForbiddenUserException,
FailedRequestException
transformName - the name of the resourcesourceHandle - a handle on the source for the Javascript implementationResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid writeJavascriptTransform(java.lang.String transformName,
TextWriteHandle sourceHandle,
ExtensionMetadata metadata)
throws ResourceNotFoundException,
ResourceNotResendableException,
ForbiddenUserException,
FailedRequestException
transformName - the name of the resourcesourceHandle - a handle on the source for the Javascript implementationmetadata - the metadata about the transformResourceNotFoundExceptionResourceNotResendableExceptionForbiddenUserExceptionFailedRequestExceptionvoid deleteTransform(java.lang.String transformName)
throws ResourceNotFoundException,
ForbiddenUserException,
FailedRequestException
transformName - the name of the transformResourceNotFoundExceptionForbiddenUserExceptionFailedRequestExceptionvoid startLogging(RequestLogger logger)
logger - the logger that receives debugging outputvoid stopLogging()
Copyright © 2013-2019 MarkLogic Corporation.