Package org.odpi.openmetadata.viewservices.runtimemanager.server

Class RuntimeManagerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.runtimemanager.server.RuntimeManagerRESTServices
public class RuntimeManagerRESTServices extends TokenController
The RuntimeManagerRESTServices provides the server-side implementation of the Runtime Manager Open Metadata View Service (OMVS).

  • Constructor Details

    • RuntimeManagerRESTServices

      public RuntimeManagerRESTServices()
      Default constructor

  • Method Details

    • getPlatformsByName

      public OpenMetadataRootElementsResponse getPlatformsByName(String serverName, FilterRequestBody requestBody)
      Returns the list of platforms with a particular qualifiedName or name.
      Parameters:
      serverName - name of called server
      requestBody - qualified name or display name of the platform
      Returns:
      a list of projects InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getPlatformsByDeployedImplType

      public OpenMetadataRootElementsResponse getPlatformsByDeployedImplType(String serverName, boolean getTemplates, FilterRequestBody requestBody)
      Returns the list of platforms with a particular deployed implementation type.
      Parameters:
      serverName - name of called server
      getTemplates - boolean indicating whether templates or non-template platforms should be returned.
      requestBody - qualified name or display name of the platform
      Returns:
      a list of projects InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getPlatformByGUID

      public OpenMetadataRootElementResponse getPlatformByGUID(String serverName, String platformGUID, GetRequestBody requestBody)
      Returns details about the platform's catalog entry (asset).
      Parameters:
      serverName - name of called server
      platformGUID - unique identifier of the platform
      requestBody - effective time
      Returns:
      a list of platforms InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getPlatformReport

      public PlatformReportResponse getPlatformReport(String serverName, String platformGUID)
      Returns details about the running platform.
      Parameters:
      serverName - name of called server
      platformGUID - unique identifier of the platform
      Returns:
      a list of platforms InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getServersByName

      public OpenMetadataRootElementsResponse getServersByName(String serverName, FilterRequestBody requestBody)
      Returns the list of platforms with a particular qualifiedName or name.
      Parameters:
      serverName - name of called server
      requestBody - qualified name or display name of the platform
      Returns:
      a list of projects InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getServersByDeployedImplType

      public OpenMetadataRootElementsResponse getServersByDeployedImplType(String serverName, boolean getTemplates, FilterRequestBody requestBody)
      Returns the list of servers with a particular deployed implementation type.
      Parameters:
      serverName - name of called server
      getTemplates - boolean indicating whether templates or non-template platforms should be returned.
      requestBody - qualified name or display name of the platform
      Returns:
      a list of projects InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getServerByGUID

      public OpenMetadataRootElementResponse getServerByGUID(String serverName, String serverGUID, GetRequestBody requestBody)
      Returns details about the server's catalog entry (asset).
      Parameters:
      serverName - name of called server
      serverGUID - unique identifier of the platform
      requestBody - effective time
      Returns:
      a list of platforms InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getServerReport

      public ServerReportResponse getServerReport(String serverName, String serverGUID)
      Returns details about the running server.
      Parameters:
      serverName - name of called server
      serverGUID - unique identifier of the server
      Returns:
      a list of platforms InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • activateWithStoredConfig

      public SuccessMessageResponse activateWithStoredConfig(String serverName, String serverGUID)
      Activate the open metadata and governance services using the stored configuration information.
      Parameters:
      serverName - local server name
      serverGUID - unique identifier of the server to call
      Returns:
      success message response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the server name is invalid or OMAGConfigurationErrorException there is a problem using the supplied configuration.

    • shutdownServer

      public VoidResponse shutdownServer(String serverName, String serverGUID)
      Temporarily deactivate any open metadata and governance services for the requested server.
      Parameters:
      serverName - local server name
      serverGUID - unique identifier of the server to call
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the serverName is invalid.

    • shutdownAndUnregisterServer

      public VoidResponse shutdownAndUnregisterServer(String serverName, String serverGUID)
      Terminate any running open metadata and governance services, remove the server from any open metadata cohorts.
      Parameters:
      serverName - local server name
      serverGUID - unique identifier of the server to call
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the serverName is invalid.

    • createMetadataRepositoryCohort

      public GUIDResponse createMetadataRepositoryCohort(String serverName, NewElementRequestBody requestBody)
      Create an open metadata repository cohort.
      Parameters:
      serverName - name of called server.
      requestBody - properties for the cohort.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createMetadataRepositoryCohortFromTemplate

      public GUIDResponse createMetadataRepositoryCohortFromTemplate(String serverName, TemplateRequestBody requestBody)
      Create a new metadata element to represent an open metadata repository cohort using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateMetadataRepositoryCohort

      public VoidResponse updateMetadataRepositoryCohort(String serverName, String metadataRepositoryCohortGUID, UpdateElementRequestBody requestBody)
      Update the properties of an open metadata repository cohort.
      Parameters:
      serverName - name of called server.
      metadataRepositoryCohortGUID - unique identifier of the cohort (returned from create)
      requestBody - properties for the new element.
      Returns:
      void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteMetadataRepositoryCohort

      public VoidResponse deleteMetadataRepositoryCohort(String serverName, String metadataRepositoryCohortGUID, DeleteElementRequestBody requestBody)
      Delete an open metadata repository cohort.
      Parameters:
      serverName - name of called server
      metadataRepositoryCohortGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getMetadataRepositoryCohortsByName

      public OpenMetadataRootElementsResponse getMetadataRepositoryCohortsByName(String serverName, FilterRequestBody requestBody)
      Retrieve the list of cohort metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getMetadataRepositoryCohortByGUID

      public OpenMetadataRootElementResponse getMetadataRepositoryCohortByGUID(String serverName, String metadataRepositoryCohortGUID, GetRequestBody requestBody)
      Retrieve the list of cohort metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      metadataRepositoryCohortGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findMetadataRepositoryCohorts

      public OpenMetadataRootElementsResponse findMetadataRepositoryCohorts(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of cohort metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • linkCohortMember

      public VoidResponse linkCohortMember(String serverName, String cohortGUID, String cohortMemberGUID, NewRelationshipRequestBody requestBody)
      Link cohort to one of its members.
      Parameters:
      serverName - name of called server
      cohortGUID - unique identifier of the cohort.
      cohortMemberGUID - unique identifier of the cohort member.
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachCohortMember

      public VoidResponse detachCohortMember(String serverName, String cohortGUID, String cohortMemberGUID, DeleteRelationshipRequestBody requestBody)
      Detach a member form a cohort.
      Parameters:
      serverName - name of called server
      cohortGUID - unique identifier of the parent subject area.
      cohortMemberGUID - unique identifier of the nested subject area.
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • addOpenMetadataArchiveFile

      public VoidResponse addOpenMetadataArchiveFile(String serverName, String serverGUID, String fileName)
      Add a new open metadata archive to running repository.
      Parameters:
      serverName - local server name.
      serverGUID - unique identifier of the server to call
      fileName - name of the open metadata archive file.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or fileName parameter.

    • addOpenMetadataArchiveContent

      public VoidResponse addOpenMetadataArchiveContent(String serverName, String serverGUID, OpenMetadataArchive openMetadataArchive)
      Add a new open metadata archive to running repository.
      Parameters:
      serverName - local server name.
      serverGUID - unique identifier of the server to call
      openMetadataArchive - contents of the open metadata archive file.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or openMetadataArchive parameter.

    • refreshConfig

      public VoidResponse refreshConfig(String serverName, String serverGUID, String governanceEngineName)
      Request that the governance engine refresh its configuration by calling the metadata server. This request is useful if the metadata server has an outage, particularly while the governance server is initializing. This request just ensures that the latest configuration is in use.
      Parameters:
      serverName - name of the governance server
      serverGUID - unique identifier of the server to call
      governanceEngineName - unique name of the governance engine
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or GovernanceEngineException there was a problem detected by the governance engine.

    • refreshConfig

      public VoidResponse refreshConfig(String serverName, String serverGUID)
      Request that all governance engines refresh their configuration by calling the metadata server. This request is useful if the metadata server has an outage, particularly while the governance server is initializing. This request just ensures that the latest configuration is in use.
      Parameters:
      serverName - name of the governance server
      serverGUID - unique identifier of the server to call
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or GovernanceEngineException there was a problem detected by the governance engine.

    • getConfigurationProperties

      public PropertiesResponse getConfigurationProperties(String serverName, String serverGUID, String connectorName)
      Retrieve the configuration properties of the named integration connector running in the integration daemon.
      Parameters:
      serverName - integration daemon server name
      serverGUID - unique identifier of the server to call
      connectorName - name of a specific connector
      Returns:
      properties map or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.

    • updateConfigurationProperties

      public VoidResponse updateConfigurationProperties(String serverName, String serverGUID, ConnectorConfigPropertiesRequestBody requestBody)
      Update the configuration properties of the integration connectors, or specific integration connector if a connector name is supplied. This update is in memory and will not persist over a server restart.
      Parameters:
      serverName - integration daemon server name
      serverGUID - unique identifier of the server to call
      requestBody - name of a specific connector or null for all connectors and the properties to change
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.

    • updateEndpointNetworkAddress

      public VoidResponse updateEndpointNetworkAddress(String serverName, String serverGUID, String connectorName, StringRequestBody requestBody)
      Update the endpoint network address for a specific integration connector. This update is in memory and will not persist over a server restart.
      Parameters:
      serverName - integration daemon server name
      serverGUID - unique identifier of the server to call
      connectorName - name of a specific connector
      requestBody - new endpoint address
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.

    • updateConnectorConnection

      public VoidResponse updateConnectorConnection(String serverName, String serverGUID, String connectorName, Connection requestBody)
      Update the connection for a specific integration connector. This update is in memory and will not persist over a server restart.
      Parameters:
      serverName - integration daemon server name
      serverGUID - unique identifier of the server to call
      connectorName - name of a specific connector
      requestBody - new connection object
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration service.

    • refreshConnectors

      public VoidResponse refreshConnectors(String serverName, String serverGUID, NameRequestBody requestBody)
      Issue a refresh() request on all connectors running in the integration daemon, or a specific connector if the connector name is specified.
      Parameters:
      serverName - integration daemon server name
      serverGUID - unique identifier of the server to call
      requestBody - optional name of the connector to target - if no connector name is specified, all connectors managed by this integration service are refreshed.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration daemon.

    • restartConnectors

      public VoidResponse restartConnectors(String serverName, String serverGUID, NameRequestBody requestBody)
      Restart all connectors running in the integration daemon, or restart a specific connector if the connector name is specified.
      Parameters:
      serverName - integration daemon server name
      serverGUID - unique identifier of the server to call
      requestBody - optional name of the connector to target - if no connector name is specified, all connectors managed by this integration service are refreshed.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException there was a problem detected by the integration daemon.

    • refreshIntegrationGroupConfig

      public VoidResponse refreshIntegrationGroupConfig(String serverName, String serverGUID, String integrationGroupName)
      Request that the integration group refresh its configuration by calling the metadata access server. Changes to the connector configuration will result in the affected connectors being restarted. This request is useful if the metadata access server has an outage, particularly while the integration daemon is initializing. This request just ensures that the latest configuration is in use.
      Parameters:
      serverName - name of the governance server
      serverGUID - unique identifier of the server to call
      integrationGroupName - unique name of the integration group
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or IntegrationGroupException there was a problem detected by the integration group.

    • publishOpenLineageEvent

      public VoidResponse publishOpenLineageEvent(String serverName, String serverGUID, String event)
      Pass an open lineage event to the integration service. It will pass it on to the integration connectors that have registered a listener for open lineage events.
      Parameters:
      serverName - integration daemon server name
      serverGUID - unique identifier of the server to call
      event - open lineage event to publish.

    • connectToCohort

      public BooleanResponse connectToCohort(String serverName, String serverGUID, String cohortName, NullRequestBody requestBody)
      A new server needs to register the metadataCollectionId for its metadata repository with the other servers in the open metadata repository. It only needs to do this once and uses a timestamp to record that the registration event has been sent. If the server has already registered in the past, it sends a reregistration request.
      Parameters:
      serverName - server to query
      serverGUID - unique identifier of the server to call
      cohortName - name of cohort
      requestBody - null request body
      Returns:
      boolean to indicate that the request has been issued. If false it is likely that the cohort name is not known

    • disconnectFromCohort

      public BooleanResponse disconnectFromCohort(String serverName, String serverGUID, String cohortName, NullRequestBody requestBody)
      Disconnect communications from a specific cohort.
      Parameters:
      serverName - server to query
      serverGUID - unique identifier of the server to call
      cohortName - name of cohort
      requestBody - null request body
      Returns:
      boolean to indicate that the request has been issued. If false it is likely that the cohort name is not known

    • unregisterFromCohort

      public BooleanResponse unregisterFromCohort(String serverName, String serverGUID, String cohortName, NullRequestBody requestBody)
      Unregister from a specific cohort and disconnect from cohort communications.
      Parameters:
      serverName - server to query
      serverGUID - unique identifier of the server to call
      cohortName - name of cohort
      requestBody - null request body
      Returns:
      boolean to indicate that the request has been issued. If false it is likely that the cohort name is not known