Package org.odpi.openmetadata.frameworkservices.gaf.client

Class GovernanceConfigurationClientBase

java.lang.Object

org.odpi.openmetadata.frameworks.opengovernance.client.GovernanceConfiguration

org.odpi.openmetadata.frameworkservices.gaf.client.GovernanceConfigurationClientBase

Direct Known Subclasses:

GovernanceConfigurationClient

public class GovernanceConfigurationClientBase
extends GovernanceConfiguration

GovernanceEngineConfigurationClient supports the configuration of governance engine and governance services.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.opengovernance.client.GovernanceConfiguration

serverName, serverPlatformURLRoot, serviceURLMarker

Constructor Summary

Constructors

Constructor	Description
GovernanceConfigurationClientBase(String serverName, String serverPlatformURLRoot, String serviceURLMarker, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.
GovernanceConfigurationClientBase(String serverName, String serverPlatformURLRoot, String serviceURLMarker, String userId, String password, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
GovernanceConfigurationClientBase(String serverName, String serverPlatformURLRoot, String serviceURLMarker, GAFRESTClient restClient, int maxPageSize, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.

Method Summary

Modifier and Type	Method	Description
String	getConfigurationServerName()	Return the name of the server where configuration is supposed to be stored.
GovernanceEngineElement	getGovernanceEngineByName(String userId, String name)	Return the properties from a governance engine definition.
List<String>	getIntegrationConnectorRegistrations(String userId, String integrationConnectorGUID)	Return the list of integration groups that a specific integration connector is registered with.
IntegrationGroupElement	getIntegrationGroupByName(String userId, String name)	Return the properties from an integration group definition.
RegisteredGovernanceServiceElement	getRegisteredGovernanceService(String userId, String governanceEngineGUID, String governanceServiceGUID)	Retrieve a specific governance service registered with a governance engine.
List<RegisteredGovernanceServiceElement>	getRegisteredGovernanceServices(String userId, String governanceEngineGUID, int startingFrom, int maximumResults)	Retrieve the identifiers of the governance services registered with a governance engine.
RegisteredIntegrationConnectorElement	getRegisteredIntegrationConnector(String userId, String integrationGroupGUID, String integrationConnectorGUID)	Retrieve a specific integration connector registered with an integration group.
List<RegisteredIntegrationConnectorElement>	getRegisteredIntegrationConnectors(String userId, String integrationGroupGUID, int startingFrom, int maximumResults)	Retrieve the identifiers of the integration connectors registered with an integration group.

Methods inherited from class java.lang.Object

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

Constructor Details

GovernanceConfigurationClientBase

public GovernanceConfigurationClientBase(String serverName,
 String serverPlatformURLRoot,
 String serviceURLMarker,
 int maxPageSize)
                                  throws InvalidParameterException

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

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)

maxPageSize - pre-initialized parameter limit

Throws:

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

GovernanceConfigurationClientBase

public GovernanceConfigurationClientBase(String serverName,
 String serverPlatformURLRoot,
 String serviceURLMarker,
 String userId,
 String password,
 int maxPageSize)
                                  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:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - pre-initialized parameter limit

Throws:

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

GovernanceConfigurationClientBase

public GovernanceConfigurationClientBase(String serverName,
 String serverPlatformURLRoot,
 String serviceURLMarker,
 GAFRESTClient restClient,
 int maxPageSize,
 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:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)

restClient - pre-initialized REST client

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem with the information about the remote OMAS

Method Details

getConfigurationServerName

public String getConfigurationServerName()

Return the name of the server where configuration is supposed to be stored.

Returns:

server name

getGovernanceEngineByName

public GovernanceEngineElement getGovernanceEngineByName(String userId,
 String name)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from a governance engine definition.

Specified by:

getGovernanceEngineByName in class GovernanceConfiguration

Parameters:

userId - identifier of calling user

name - qualified name or display name (if unique).

Returns:

properties from the governance engine definition.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the governance engine definition.

getRegisteredGovernanceService

public RegisteredGovernanceServiceElement getRegisteredGovernanceService(String userId,
 String governanceEngineGUID,
 String governanceServiceGUID)
                                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve a specific governance service registered with a governance engine.

Specified by:

getRegisteredGovernanceService in class GovernanceConfiguration

Parameters:

userId - identifier of calling user

governanceEngineGUID - unique identifier of the governance engine.

governanceServiceGUID - unique identifier of the governance service.

Returns:

details of the governance service and the asset types it is registered for.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the governance service and/or governance engine definitions.

getRegisteredGovernanceServices

public List<RegisteredGovernanceServiceElement> getRegisteredGovernanceServices(String userId,
 String governanceEngineGUID,
 int startingFrom,
 int maximumResults)
                                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the identifiers of the governance services registered with a governance engine.

Specified by:

getRegisteredGovernanceServices in class GovernanceConfiguration

Parameters:

userId - identifier of calling user

governanceEngineGUID - unique identifier of the governance engine.

startingFrom - initial position in the stored list.

maximumResults - maximum number of definitions to return on this call.

Returns:

list of registered services

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the governance service and/or governance engine definitions.

getIntegrationGroupByName

public IntegrationGroupElement getIntegrationGroupByName(String userId,
 String name)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from an integration group definition.

Specified by:

getIntegrationGroupByName in class GovernanceConfiguration

Parameters:

userId - identifier of calling user

name - qualified name or display name (if unique).

Returns:

properties from the integration group definition.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration group definition.

getIntegrationConnectorRegistrations

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

Return the list of integration groups that a specific integration connector is registered with.

Specified by:

getIntegrationConnectorRegistrations in class GovernanceConfiguration

Parameters:

userId - identifier of calling user

integrationConnectorGUID - integration connector to search for.

Returns:

list of integration group unique identifiers (guids)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration connector and/or integration group definitions.

getRegisteredIntegrationConnector

public RegisteredIntegrationConnectorElement getRegisteredIntegrationConnector(String userId,
 String integrationGroupGUID,
 String integrationConnectorGUID)
                                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve a specific integration connector registered with an integration group.

Specified by:

getRegisteredIntegrationConnector in class GovernanceConfiguration

Parameters:

userId - identifier of calling user

integrationGroupGUID - unique identifier of the integration group.

integrationConnectorGUID - unique identifier of the integration connector.

Returns:

details of the integration connector and the asset types it is registered for.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration connector and/or integration group definitions.

getRegisteredIntegrationConnectors

public List<RegisteredIntegrationConnectorElement> getRegisteredIntegrationConnectors(String userId,
 String integrationGroupGUID,
 int startingFrom,
 int maximumResults)
                                                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the identifiers of the integration connectors registered with an integration group.

Specified by:

getRegisteredIntegrationConnectors in class GovernanceConfiguration

Parameters:

userId - identifier of calling user

integrationGroupGUID - unique identifier of the integration group.

startingFrom - initial position in the stored list.

maximumResults - maximum number of definitions to return on this call.

Returns:

list of registered services

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration connector and/or integration group definitions.