Package org.odpi.openmetadata.platformservices.client

Class PlatformServicesClient

java.lang.Object

org.odpi.openmetadata.platformservices.client.PlatformServicesClient

public class PlatformServicesClient
extends Object

PlatformServicesClient is the client for issuing queries to the OMAG Server Platform platform-services interface

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditLog	auditLog

Constructor Summary

Constructors

Constructor	Description
PlatformServicesClient(String platformName, String platformRootURL)	Create a new client with no authentication embedded in the HTTP request.
PlatformServicesClient(String platformName, String platformRootURL, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
PlatformServicesClient(String platformName, String platformRootURL, String userId, String password, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
PlatformServicesClient(String platformName, String platformRootURL, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
List<RegisteredOMAGService>	getAccessServices(String userId)	Retrieve a list of the access services registered on the platform
List<String>	getActiveServers(String userId)	Retrieve a list of the active servers on the platform
List<String>	getActiveServices(String userId, String serverName)	Retrieve a list of the active services on a server
List<RegisteredOMAGService>	getCommonServices(String userId)	Retrieve a list of the common services registered on the platform
ConnectorType	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.
List<RegisteredOMAGService>	getEngineServices(String userId)	Retrieve a list of the engine services registered on the platform
List<RegisteredOMAGService>	getGovernanceServices(String userId)	Retrieve a list of the governance services registered on the platform
List<RegisteredOMAGService>	getIntegrationServices(String userId)	Retrieve a list of the integration services registered on the platform
List<String>	getKnownServers(String userId)	Retrieve a list of the known servers on the platform
String	getPlatformOrigin(String userId)	Retrieve the platform origin
ServerStatus	getServerStatus(String userId, String serverName)	Retrieve the server status
List<RegisteredOMAGService>	getViewServices(String userId)	Retrieve a list of the access services registered on the platform

Methods inherited from class java.lang.Object

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

Field Detail

auditLog

protected AuditLog auditLog

Constructor Detail

PlatformServicesClient

public PlatformServicesClient(String platformName,
                              String platformRootURL,
                              AuditLog auditLog)
                       throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

platformName - name of the platform to connect to

platformRootURL - the network address of the server running the OMAG Platform

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

PlatformServicesClient

public PlatformServicesClient(String platformName,
                              String platformRootURL)
                       throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

platformName - name of the platform to connect to

platformRootURL - the network address of the server running the OMAS REST servers

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

PlatformServicesClient

public PlatformServicesClient(String platformName,
                              String platformRootURL,
                              String userId,
                              String password,
                              AuditLog auditLog)
                       throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

platformName - name of the platform to connect to

platformRootURL - the network address of the platform

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

PlatformServicesClient

public PlatformServicesClient(String platformName,
                              String platformRootURL,
                              String userId,
                              String password)
                       throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

platformName - name of the server to connect to

platformRootURL - the network address of the platform

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

getPlatformOrigin

public String getPlatformOrigin(String userId)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Retrieve the platform origin

Parameters:

userId - calling user

Returns:

List of server names

Throws:

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)

getConnectorType

public ConnectorType getConnectorType(String userId,
                                      String connectorProviderClassName)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

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

Throws:

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)

getServerStatus

public ServerStatus getServerStatus(String userId,
                                    String serverName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Retrieve the server status

Parameters:

userId - calling user

serverName - the name of the server

Returns:

The server status

Throws:

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)

getActiveServices

public List<String> getActiveServices(String userId,
                                      String serverName)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Retrieve a list of the active services on a server

Parameters:

userId - calling user

serverName - name of the server

Returns:

List of service names

Throws:

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)

getActiveServers

public List<String> getActiveServers(String userId)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Retrieve a list of the active servers on the platform

Parameters:

userId - calling user

Returns:

List of server names

Throws:

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)

getKnownServers

public List<String> getKnownServers(String userId)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Retrieve a list of the known servers on the platform

Parameters:

userId - calling user

Returns:

List of server names

Throws:

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)

getAccessServices

public List<RegisteredOMAGService> getAccessServices(String userId)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Retrieve a list of the access services registered on the platform

Parameters:

userId - calling user

Returns:

List of access services

Throws:

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)

getEngineServices

public List<RegisteredOMAGService> getEngineServices(String userId)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Retrieve a list of the engine services registered on the platform

Parameters:

userId - calling user

Returns:

List of engine services

Throws:

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)

getViewServices

public List<RegisteredOMAGService> getViewServices(String userId)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Retrieve a list of the access services registered on the platform

Parameters:

userId - calling user

Returns:

List of view services

Throws:

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)

getGovernanceServices

public List<RegisteredOMAGService> getGovernanceServices(String userId)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException

Retrieve a list of the governance services registered on the platform

Parameters:

userId - calling user

Returns:

List of governance services

Throws:

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)

getIntegrationServices

public List<RegisteredOMAGService> getIntegrationServices(String userId)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

Retrieve a list of the integration services registered on the platform

Parameters:

userId - calling user

Returns:

List of integration services

Throws:

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)

getCommonServices

public List<RegisteredOMAGService> getCommonServices(String userId)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Retrieve a list of the common services registered on the platform

Parameters:

userId - calling user

Returns:

List of common services

Throws:

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)