Interface ResourceExtensionsManager

• Nested Class Summary

  Nested Classes
  Modifier and Type

  Interface

  Description

  static class 

  ResourceExtensionsManager.MethodParameters

  Method Parameters declare the parameters accepted by the Resource Services extension.

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  void

  deleteServices(String resourceName)

  Uninstalls the services that implement a resource.

  <T extends StructureReadHandle>
T

  listServices(T listHandle)

  Reads the list of resource service extensions installed on the server.

  <T extends StructureReadHandle>
T

  listServices(T listHandle, boolean refresh)

  Reads the list of resource service extensions installed on the server, specifying whether to refresh the metadata about each extension by parsing the extension source.

  <T> T

  listServicesAs(Format format, Class<T> as)

  Reads the list of resource service extensions installed on the server in a JSON or XML representation provided as an object of an IO class.

  <T> T

  listServicesAs(Format format, Class<T> as, boolean refresh)

  Reads the list of resource service extensions installed on the server in a JSON or XML representation provided as an object of an IO class.

  <T extends TextReadHandle>
T

  readServices(String resourceName, T sourceHandle)

  Reads the XQuery implementation of the services for a resource.

  <T> T

  readServicesAs(String resourceName, Class<T> as)

  Reads the XQuery implementation of the services for a resource in a textual representation provided as an object of an IO class.

  void

  startLogging(RequestLogger logger)

  Starts debugging client requests.

  void

  stopLogging()

  Stops debugging client requests.

  void

  writeServices(String resourceName, TextWriteHandle sourceHandle, ExtensionMetadata metadata, ResourceExtensionsManager.MethodParameters... methodParams)

  Installs the services that implement a resource.

  void

  writeServicesAs(String resourceName, Object source, ExtensionMetadata metadata, ResourceExtensionsManager.MethodParameters... methodParams)

  Installs the services that implement a resource in a textual representation provided as an object of an IO class.

• Method Details

  • listServicesAs

    <T> T listServicesAs(Format format, Class<T> as)
    Reads the list of resource service 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 resource service extensions

    Returns:

    an object of the IO class with the list of resource service extensions

  • listServicesAs

    <T> T listServicesAs(Format format, Class<T> as, boolean refresh)
    Reads the list of resource service 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 resource service extensions

    refresh - whether to parse metadata from the extension source

    Returns:

    an object of the IO class with the list of resource service extensions

  • listServices

    <T extends StructureReadHandle> T listServices(T listHandle)
    Reads the list of resource service extensions installed on the server.

    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

  • listServices

    <T extends StructureReadHandle> T listServices(T listHandle, boolean refresh)
    Reads the list of resource service extensions installed on the server, 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

  • readServicesAs

    <T> T readServicesAs(String resourceName, Class<T> as)
    Reads the XQuery implementation of the services for a resource 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:

    resourceName - the name of the resource

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

    Returns:

    an object of the IO class with the source code for the service

  • readServices

    <T extends TextReadHandle> T readServices(String resourceName, T sourceHandle)
    Reads the XQuery implementation of the services for a resource.

    Type Parameters:

    T - the type of TextReadHandle to return

    Parameters:

    resourceName - the name of the resource

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

    Returns:

    the XQuery source code

  • writeServicesAs

    void writeServicesAs(String resourceName, Object source, ExtensionMetadata metadata, ResourceExtensionsManager.MethodParameters... methodParams)
    Installs the services that implement a resource 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:

    resourceName - the name of the resource

    source - an IO representation of the source code

    metadata - the metadata about the resource services

    methodParams - a declaration of the parameters for the services

  • writeServices

    void writeServices(String resourceName, TextWriteHandle sourceHandle, ExtensionMetadata metadata, ResourceExtensionsManager.MethodParameters... methodParams)
    Installs the services that implement a resource.

    Parameters:

    resourceName - the name of the resource

    sourceHandle - a handle on the source for the XQuery implementation

    metadata - the metadata about the resource services

    methodParams - a declaration of the parameters for the services

  • deleteServices

    void deleteServices(String resourceName)
    Uninstalls the services that implement a resource.

    Parameters:

    resourceName - the name of the resource

  • 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.

Copyright (c) 2010-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.