public interface TransformExtensionsManager
Modifier and Type | Method and Description |
---|---|
void |
deleteTransform(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,
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,
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(String transformName,
T sourceHandle)
Reads the source for a transform implemented in Javascript.
|
<T> T |
readJavascriptTransformAs(String transformName,
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(String transformName,
T sourceHandle)
Reads the source for a transform implemented in XQuery.
|
<T> T |
readXQueryTransformAs(String transformName,
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(String transformName,
T sourceHandle)
Reads the source for a transform implemented in XSLT.
|
<T> T |
readXSLTransformAs(String transformName,
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(String transformName,
TextWriteHandle sourceHandle)
Installs a transform implemented in Javascript.
|
void |
writeJavascriptTransform(String transformName,
TextWriteHandle sourceHandle,
ExtensionMetadata metadata)
Installs a transform implemented in Javascript.
|
void |
writeJavascriptTransformAs(String transformName,
ExtensionMetadata metadata,
Object source)
Installs a transform implemented in Javascript
in a textual representation provided as an object of an IO class.
|
void |
writeJavascriptTransformAs(String transformName,
Object source)
Installs a transform implemented in XQuery
in a textual representation provided as an object of an IO class.
|
void |
writeXQueryTransform(String transformName,
TextWriteHandle sourceHandle)
Installs a transform implemented in XQuery.
|
void |
writeXQueryTransform(String transformName,
TextWriteHandle sourceHandle,
ExtensionMetadata metadata)
Installs a transform implemented in XQuery.
|
void |
writeXQueryTransform(String transformName,
TextWriteHandle sourceHandle,
ExtensionMetadata metadata,
Map<String,String> paramTypes)
Deprecated.
|
void |
writeXQueryTransformAs(String transformName,
ExtensionMetadata metadata,
Object source)
Installs a transform implemented in XQuery
in a textual representation provided as an object of an IO class.
|
void |
writeXQueryTransformAs(String transformName,
Object source)
Installs a transform implemented in XQuery
in a textual representation provided as an object of an IO class.
|
void |
writeXSLTransform(String transformName,
XMLWriteHandle sourceHandle)
Installs a transform implemented in XSL.
|
void |
writeXSLTransform(String transformName,
XMLWriteHandle sourceHandle,
ExtensionMetadata metadata)
Installs a transform implemented in XSL.
|
void |
writeXSLTransform(String transformName,
XMLWriteHandle sourceHandle,
ExtensionMetadata metadata,
Map<String,String> paramTypes)
Deprecated.
|
void |
writeXSLTransformAs(String transformName,
ExtensionMetadata metadata,
Object source)
Installs a transform implemented in XSL
in an XML representation provided as an object of an IO class.
|
void |
writeXSLTransformAs(String transformName,
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, 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, 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 listForbiddenUserException
FailedRequestException
<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 sourceForbiddenUserException
FailedRequestException
<T> T readXSLTransformAs(String transformName, 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 XMLResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends XMLReadHandle> T readXSLTransform(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.FailedRequestException
ResourceNotFoundException
ForbiddenUserException
<T> T readXQueryTransformAs(String transformName, 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 textResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends TextReadHandle> T readXQueryTransform(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.FailedRequestException
ResourceNotFoundException
ForbiddenUserException
<T> T readJavascriptTransformAs(String transformName, 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 textResourceNotFoundException
ForbiddenUserException
FailedRequestException
<T extends TextReadHandle> T readJavascriptTransform(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.FailedRequestException
ResourceNotFoundException
ForbiddenUserException
void writeXSLTransformAs(String transformName, 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 codeResourceNotFoundException
ResourceNotResendableException
ForbiddenUserException
FailedRequestException
void writeXSLTransformAs(String transformName, ExtensionMetadata metadata, 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 codeResourceNotFoundException
ResourceNotResendableException
ForbiddenUserException
FailedRequestException
void writeXSLTransform(String transformName, XMLWriteHandle sourceHandle) throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException
transformName
- the name of the resourcesourceHandle
- a handle on the source for the XSL implementationResourceNotFoundException
ResourceNotResendableException
ForbiddenUserException
FailedRequestException
void writeXSLTransform(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 transformResourceNotFoundException
ResourceNotResendableException
ForbiddenUserException
FailedRequestException
@Deprecated void writeXSLTransform(String transformName, XMLWriteHandle sourceHandle, ExtensionMetadata metadata, Map<String,String> paramTypes) throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException
transformName
- the name of the resourcesourceHandle
- a handle on the source for the XSL implementationmetadata
- the metadata about the transformparamTypes
- the names and XML Schema datatypes of the transform parametersResourceNotFoundException
ResourceNotResendableException
ForbiddenUserException
FailedRequestException
void writeXQueryTransformAs(String transformName, 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 codeResourceNotFoundException
ResourceNotResendableException
ForbiddenUserException
FailedRequestException
void writeXQueryTransformAs(String transformName, ExtensionMetadata metadata, 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 codeResourceNotFoundException
ResourceNotResendableException
ForbiddenUserException
FailedRequestException
void writeXQueryTransform(String transformName, TextWriteHandle sourceHandle) throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException
transformName
- the name of the resourcesourceHandle
- a handle on the source for the XQuery implementationResourceNotFoundException
ResourceNotResendableException
ForbiddenUserException
FailedRequestException
void writeXQueryTransform(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 transformResourceNotFoundException
ResourceNotResendableException
ForbiddenUserException
FailedRequestException
@Deprecated void writeXQueryTransform(String transformName, TextWriteHandle sourceHandle, ExtensionMetadata metadata, Map<String,String> paramTypes) throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException
transformName
- the name of the resourcesourceHandle
- a handle on the source for the XQuery implementationmetadata
- the metadata about the transformparamTypes
- the names and XML Schema datatypes of the transform parametersResourceNotFoundException
ResourceNotResendableException
ForbiddenUserException
FailedRequestException
void writeJavascriptTransformAs(String transformName, 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 codeResourceNotFoundException
ResourceNotResendableException
ForbiddenUserException
FailedRequestException
void writeJavascriptTransformAs(String transformName, ExtensionMetadata metadata, 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 codeResourceNotFoundException
ResourceNotResendableException
ForbiddenUserException
FailedRequestException
void writeJavascriptTransform(String transformName, TextWriteHandle sourceHandle) throws ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException, FailedRequestException
transformName
- the name of the resourcesourceHandle
- a handle on the source for the Javascript implementationResourceNotFoundException
ResourceNotResendableException
ForbiddenUserException
FailedRequestException
void writeJavascriptTransform(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 transformResourceNotFoundException
ResourceNotResendableException
ForbiddenUserException
FailedRequestException
void deleteTransform(String transformName) throws ResourceNotFoundException, ForbiddenUserException, FailedRequestException
transformName
- the name of the transformResourceNotFoundException
ForbiddenUserException
FailedRequestException
void startLogging(RequestLogger logger)
logger
- the logger that receives debugging outputvoid stopLogging()
Copyright © 2013-2016 MarkLogic Corporation.