Class RuntimeManagerRESTServices
java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.runtimemanager.server.RuntimeManagerRESTServices
The RuntimeManagerRESTServices provides the server-side implementation of the Runtime Manager Open Metadata
View Service (OMVS).
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionactivateWithStoredConfig
(String serverName, String serverGUID) Activate the open metadata and governance services using the stored configuration information.addOpenMetadataArchiveContent
(String serverName, String serverGUID, OpenMetadataArchive openMetadataArchive) Add a new open metadata archive to running repository.addOpenMetadataArchiveFile
(String serverName, String serverGUID, String fileName) Add a new open metadata archive to running repository.connectToCohort
(String serverName, String serverGUID, String cohortName) A new server needs to register the metadataCollectionId for its metadata repository with the other servers in the open metadata repository.disconnectFromCohort
(String serverName, String serverGUID, String cohortName) Disconnect communications from a specific cohort.getConfigurationProperties
(String serverName, String serverGUID, String connectorName) Retrieve the configuration properties of the named integration connector running in the integration daemon.getPlatformByGUID
(String serverName, String platformGUID, EffectiveTimeQueryRequestBody requestBody) Returns details about the platform's catalog entry (asset).getPlatformReport
(String serverName, String platformGUID) Returns details about the running platform.getPlatformsByDeployedImplType
(String serverName, int startFrom, int pageSize, boolean getTemplates, FilterRequestBody requestBody) Returns the list of platforms with a particular deployed implementation type.getPlatformsByName
(String serverName, int startFrom, int pageSize, FilterRequestBody requestBody) Returns the list of platforms with a particular qualifiedName or name.getServerByGUID
(String serverName, String serverGUID, EffectiveTimeQueryRequestBody requestBody) Returns details about the server's catalog entry (asset).getServerReport
(String serverName, String serverGUID) Returns details about the running server.getServersByDeployedImplType
(String serverName, int startFrom, int pageSize, boolean getTemplates, FilterRequestBody requestBody) Returns the list of servers with a particular deployed implementation type.getServersByName
(String serverName, int startFrom, int pageSize, FilterRequestBody requestBody) Returns the list of platforms with a particular qualifiedName or name.publishOpenLineageEvent
(String serverName, String serverGUID, String event) Pass an open lineage event to the integration service.refreshConfig
(String serverName, String serverGUID, String governanceEngineName) Request that the governance engine refresh its configuration by calling the metadata server.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.refreshIntegrationGroupConfig
(String serverName, String serverGUID, String integrationGroupName) Request that the integration group refresh its configuration by calling the metadata access server.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.shutdownAndUnregisterServer
(String serverName, String serverGUID) Terminate any running open metadata and governance services, remove the server from any open metadata cohorts.shutdownServer
(String serverName, String serverGUID) Temporarily deactivate any open metadata and governance services for the requested server.unregisterFromCohort
(String serverName, String serverGUID, String cohortName) Unregister from a specific cohort and disconnect from cohort communications.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.updateConnectorConnection
(String serverName, String serverGUID, String connectorName, Connection requestBody) Update the connection for a specific integration connector.updateEndpointNetworkAddress
(String serverName, String serverGUID, String connectorName, StringRequestBody requestBody) Update the endpoint network address for a specific integration connector.Methods inherited from class org.odpi.openmetadata.tokencontroller.TokenController
getUser
-
Constructor Details
-
RuntimeManagerRESTServices
public RuntimeManagerRESTServices()Default constructor
-
-
Method Details
-
getPlatformsByName
public SoftwareServerPlatformsResponse getPlatformsByName(String serverName, int startFrom, int pageSize, FilterRequestBody requestBody) Returns the list of platforms with a particular qualifiedName or name.- Parameters:
serverName
- name of called serverstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to returnrequestBody
- 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 SoftwareServerPlatformsResponse getPlatformsByDeployedImplType(String serverName, int startFrom, int pageSize, boolean getTemplates, FilterRequestBody requestBody) Returns the list of platforms with a particular deployed implementation type.- Parameters:
serverName
- name of called serverstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to returngetTemplates
- 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 SoftwareServerPlatformResponse getPlatformByGUID(String serverName, String platformGUID, EffectiveTimeQueryRequestBody requestBody) Returns details about the platform's catalog entry (asset).- Parameters:
serverName
- name of called serverplatformGUID
- unique identifier of the platformrequestBody
- 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
Returns details about the running platform.- Parameters:
serverName
- name of called serverplatformGUID
- 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 SoftwareServersResponse getServersByName(String serverName, int startFrom, int pageSize, FilterRequestBody requestBody) Returns the list of platforms with a particular qualifiedName or name.- Parameters:
serverName
- name of called serverstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to returnrequestBody
- 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 SoftwareServersResponse getServersByDeployedImplType(String serverName, int startFrom, int pageSize, boolean getTemplates, FilterRequestBody requestBody) Returns the list of servers with a particular deployed implementation type.- Parameters:
serverName
- name of called serverstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to returngetTemplates
- 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 SoftwareServerResponse getServerByGUID(String serverName, String serverGUID, EffectiveTimeQueryRequestBody requestBody) Returns details about the server's catalog entry (asset).- Parameters:
serverName
- name of called serverserverGUID
- unique identifier of the platformrequestBody
- 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
Returns details about the running server.- Parameters:
serverName
- name of called serverserverGUID
- 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
Activate the open metadata and governance services using the stored configuration information.- Parameters:
serverName
- local server nameserverGUID
- 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
Temporarily deactivate any open metadata and governance services for the requested server.- Parameters:
serverName
- local server nameserverGUID
- 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
Terminate any running open metadata and governance services, remove the server from any open metadata cohorts.- Parameters:
serverName
- local server nameserverGUID
- 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.
-
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 callfileName
- 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 callopenMetadataArchive
- 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 serverserverGUID
- unique identifier of the server to callgovernanceEngineName
- 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.
-
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 nameserverGUID
- unique identifier of the server to callconnectorName
- 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 nameserverGUID
- unique identifier of the server to callrequestBody
- 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 nameserverGUID
- unique identifier of the server to callconnectorName
- name of a specific connectorrequestBody
- 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 nameserverGUID
- unique identifier of the server to callconnectorName
- name of a specific connectorrequestBody
- 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 nameserverGUID
- unique identifier of the server to callrequestBody
- 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 nameserverGUID
- unique identifier of the server to callrequestBody
- 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 serverserverGUID
- unique identifier of the server to callintegrationGroupName
- 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
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 nameserverGUID
- unique identifier of the server to callevent
- open lineage event to publish.
-
connectToCohort
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 queryserverGUID
- unique identifier of the server to callcohortName
- name of cohort- 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) Disconnect communications from a specific cohort.- Parameters:
serverName
- server to queryserverGUID
- unique identifier of the server to callcohortName
- name of cohort- 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) Unregister from a specific cohort and disconnect from cohort communications.- Parameters:
serverName
- server to queryserverGUID
- unique identifier of the server to callcohortName
- name of cohort- Returns:
- boolean to indicate that the request has been issued. If false it is likely that the cohort name is not known
-