Package org.odpi.openmetadata.platformservices.server.spring

Class OMAGServerPlatformActiveResource

java.lang.Object

org.odpi.openmetadata.platformservices.server.spring.OMAGServerPlatformActiveResource

@RestController
@RequestMapping("/open-metadata/platform-services/users/{userId}/server-platform")
public class OMAGServerPlatformActiveResource
extends Object

OMAGServerPlatformActiveResource allow an external caller to determine which servers are active on the platform and the services that are active within them.

Constructor Summary

Constructors

Constructor	Description
OMAGServerPlatformActiveResource()

Method Summary

Modifier and Type	Method	Description
ServerListResponse	getActiveServerList(String userId)	Return the list of OMAG Servers that are active on this OMAG Server Platform.
ServerServicesListResponse	getActiveServiceListForServer(String userId, String serverName)	Return the list of services that are active on a specific OMAG Server that is active on this OMAG Server Platform.
RegisteredOMAGServicesResponse	getAllRegisteredServices(String userId)	Return the list of all services that are registered (supported) in this OMAG Server Platform.
ConnectorTypeResponse	getConnectorType(String userId, String connectorProviderClassName)	Return the connector type for the requested connector provider after validating that the connector provider is available on the OMAGServerPlatform's class path.
ServerListResponse	getKnownServerList(String userId)	Return the list of OMAG Servers that have run or are running in this OMAG Server Platform.
RegisteredOMAGServicesResponse	getRegisteredAccessServices(String userId)	Return the list of access services that are registered (supported) in this OMAG Server Platform and can be configured for a metadata server.
RegisteredOMAGServicesResponse	getRegisteredCommonServices(String userId)	Return the list of common services that are registered (supported) in this OMAG Server Platform and can be configured as part of any server.
RegisteredOMAGServicesResponse	getRegisteredEngineServices(String userId)	Return the list of engine services that are implemented in this OMAG Server Platform and can be configured for an engine host server.
RegisteredOMAGServicesResponse	getRegisteredGovernanceServices(String userId)	Return the list of governance services that are registered (supported) in this OMAG Server Platform and can be configured as part of a governance server.
RegisteredOMAGServicesResponse	getRegisteredIntegrationServices(String userId)	Return the list of integration services that are implemented in this OMAG Server Platform and can be configured for an integration daemon server.
RegisteredOMAGServicesResponse	getRegisteredViewServices(String userId)	Return the list of view services that are registered (supported) in this OMAG Server Platform and can be configured for a view server.
ServerStatusResponse	getServerStatus(String userId, String serverName)	Return information about when the server has been active.
BooleanResponse	isServerKnown(String userId, String serverName)	Return a flag to indicate if this server has ever run on this OMAG Server Platform.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OMAGServerPlatformActiveResource

public OMAGServerPlatformActiveResource()

Method Detail

getRegisteredAccessServices

@GetMapping(path="/registered-services/access-services")
public RegisteredOMAGServicesResponse getRegisteredAccessServices(@PathVariable
                                                                  String userId)

Return the list of access services that are registered (supported) in this OMAG Server Platform and can be configured for a metadata server.

Parameters:

userId - calling user

Returns:

list of service descriptions

getRegisteredEngineServices

@GetMapping(path="/registered-services/engine-services")
public RegisteredOMAGServicesResponse getRegisteredEngineServices(@PathVariable
                                                                  String userId)

Return the list of engine services that are implemented in this OMAG Server Platform and can be configured for an engine host server.

Parameters:

userId - calling user

Returns:

list of service descriptions

getRegisteredIntegrationServices

@GetMapping(path="/registered-services/integration-services")
public RegisteredOMAGServicesResponse getRegisteredIntegrationServices(@PathVariable
                                                                       String userId)

Return the list of integration services that are implemented in this OMAG Server Platform and can be configured for an integration daemon server.

Parameters:

userId - calling user

Returns:

list of service descriptions

getRegisteredViewServices

@GetMapping(path="/registered-services/view-services")
public RegisteredOMAGServicesResponse getRegisteredViewServices(@PathVariable
                                                                String userId)

Return the list of view services that are registered (supported) in this OMAG Server Platform and can be configured for a view server.

Parameters:

userId - calling user

Returns:

list of service descriptions

getRegisteredGovernanceServices

@GetMapping(path="/registered-services/governance-services")
public RegisteredOMAGServicesResponse getRegisteredGovernanceServices(@PathVariable
                                                                      String userId)

Return the list of governance services that are registered (supported) in this OMAG Server Platform and can be configured as part of a governance server.

Parameters:

userId - calling user

Returns:

list of service descriptions

getRegisteredCommonServices

@GetMapping(path="/registered-services/common-services")
public RegisteredOMAGServicesResponse getRegisteredCommonServices(@PathVariable
                                                                  String userId)

Return the list of common services that are registered (supported) in this OMAG Server Platform and can be configured as part of any server.

Parameters:

userId - calling user

Returns:

list of service descriptions

getAllRegisteredServices

@GetMapping(path="/registered-services")
public RegisteredOMAGServicesResponse getAllRegisteredServices(@PathVariable
                                                               String userId)

Return the list of all services that are registered (supported) in this OMAG Server Platform.

Parameters:

userId - calling user

Returns:

list of service descriptions

getConnectorType

@GetMapping(path="/connector-types/{connectorProviderClassName}")
public ConnectorTypeResponse getConnectorType(@PathVariable
                                              String userId,
                                              @PathVariable
                                              String connectorProviderClassName)

Return the connector type for the requested connector provider after validating that the connector provider is available on the OMAGServerPlatform's class path. This method is for tools that are configuring connectors into an Egeria server. It does not validate that the connector will load and initialize.

Parameters:

userId - calling user

connectorProviderClassName - name of the connector provider class

Returns:

ConnectorType bean or exceptions that occur when trying to create the connector

isServerKnown

@GetMapping(path="/servers/{serverName}/is-known")
public BooleanResponse isServerKnown(@PathVariable
                                     String userId,
                                     @PathVariable
                                     String serverName)

Return a flag to indicate if this server has ever run on this OMAG Server Platform.

Parameters:

userId - calling user

serverName - server of interest

Returns:

flag

getKnownServerList

@GetMapping(path="/servers")
public ServerListResponse getKnownServerList(@PathVariable
                                             String userId)

Return the list of OMAG Servers that have run or are running in this OMAG Server Platform.

Parameters:

userId - calling user

Returns:

list of OMAG server names

getActiveServerList

@GetMapping(path="/servers/active")
public ServerListResponse getActiveServerList(@PathVariable
                                              String userId)

Return the list of OMAG Servers that are active on this OMAG Server Platform.

Parameters:

userId - name of the user making the request

Returns:

list of server names

getServerStatus

@GetMapping(path="/servers/{serverName}/status")
public ServerStatusResponse getServerStatus(@PathVariable
                                            String userId,
                                            @PathVariable
                                            String serverName)

Return information about when the server has been active.

Parameters:

userId - name of the user making the request

serverName - name of the server of interest

Returns:

details of the server status

getActiveServiceListForServer

@GetMapping(path="/servers/{serverName}/services")
public ServerServicesListResponse getActiveServiceListForServer(@PathVariable
                                                                String userId,
                                                                @PathVariable
                                                                String serverName)

Return the list of services that are active on a specific OMAG Server that is active on this OMAG Server Platform.

Parameters:

userId - name of the user making the request

serverName - name of the server of interest

Returns:

server name and list od services running within