Package org.odpi.openmetadata.accessservices.governanceengine.api

Interface GovernanceEngineConfiguration

public interface GovernanceEngineConfiguration

Method Summary

Modifier and Type	Method	Description
String	createGovernanceEngine(String userId, String qualifiedName, String displayName, String description)	Create a new governance engine definition.
String	createGovernanceService(String userId, String qualifiedName, String displayName, String description, Connection connection)	Create a governance service definition.
void	deleteGovernanceEngine(String userId, String guid, String qualifiedName)	Remove the properties of the governance engine.
void	deleteGovernanceService(String userId, String guid, String qualifiedName)	Remove the properties of the governance service.
List<GovernanceEngineElement>	getAllGovernanceEngines(String userId, int startingFrom, int maximumResults)	Return the list of governance engine definitions that are stored.
List<GovernanceServiceElement>	getAllGovernanceServices(String userId, int startingFrom, int maximumResults)	Return the list of governance services definitions that are stored.
GovernanceEngineElement	getGovernanceEngineByGUID(String userId, String guid)	Return the properties from a governance engine definition.
GovernanceEngineElement	getGovernanceEngineByName(String userId, String name)	Return the properties from a governance engine definition.
GovernanceServiceElement	getGovernanceServiceByGUID(String userId, String guid)	Return the properties from a governance service definition.
GovernanceServiceElement	getGovernanceServiceByName(String userId, String name)	Return the properties from a governance service definition.
List<String>	getGovernanceServiceRegistrations(String userId, String governanceServiceGUID)	Return the list of governance engines that a specific governance service is registered with.
RegisteredGovernanceServiceElement	getRegisteredGovernanceService(String userId, String governanceEngineGUID, String governanceServiceGUID)	Retrieve a specific governance service registered with a governance engine.
List<String>	getRegisteredGovernanceServices(String userId, String governanceEngineGUID, int startingFrom, int maximumResults)	Retrieve the identifiers of the governance services registered with a governance engine.
void	registerGovernanceServiceWithEngine(String userId, String governanceEngineGUID, String governanceServiceGUID, String requestType, Map<String,String> requestParameters)	Register a governance service with a specific governance engine.
void	unregisterGovernanceServiceFromEngine(String userId, String governanceEngineGUID, String governanceServiceGUID)	Unregister a governance service from the governance engine.
void	updateGovernanceEngine(String userId, String guid, String qualifiedName, String displayName, String description, String typeDescription, String version, String patchLevel, String source, Map<String,String> additionalProperties, Map<String,Object> extendedProperties)	Update the properties of an existing governance engine definition.
void	updateGovernanceService(String userId, String guid, String qualifiedName, String displayName, String description, Connection connection, Map<String,String> additionalProperties, Map<String,Object> extendedProperties)	Update the properties of an existing governance service definition.

Method Detail

createGovernanceEngine

String createGovernanceEngine(String userId,
                              String qualifiedName,
                              String displayName,
                              String description)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Create a new governance engine definition.

Parameters:

userId - identifier of calling user

qualifiedName - unique name for the governance engine.

displayName - display name for messages and user interfaces.

description - description of the types of governance services that will be associated with this governance engine.

Returns:

unique identifier (guid) of the governance engine definition. This is for use on other requests.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem storing the governance engine definition.

getGovernanceEngineByGUID

GovernanceEngineElement getGovernanceEngineByGUID(String userId,
                                                  String guid)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Return the properties from a governance engine definition.

Parameters:

userId - identifier of calling user

guid - unique identifier (guid) of the governance engine definition.

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.

getGovernanceEngineByName

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

Return the properties from a governance engine definition.

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.

getAllGovernanceEngines

List<GovernanceEngineElement> getAllGovernanceEngines(String userId,
                                                      int startingFrom,
                                                      int maximumResults)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Return the list of governance engine definitions that are stored.

Parameters:

userId - identifier of calling user

startingFrom - initial position in the stored list.

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

Returns:

list of governance engine definitions.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the governance engine definitions.

updateGovernanceEngine

void updateGovernanceEngine(String userId,
                            String guid,
                            String qualifiedName,
                            String displayName,
                            String description,
                            String typeDescription,
                            String version,
                            String patchLevel,
                            String source,
                            Map<String,String> additionalProperties,
                            Map<String,Object> extendedProperties)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Update the properties of an existing governance engine definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.

Parameters:

userId - identifier of calling user

guid - unique identifier of the governance engine - used to locate the definition.

qualifiedName - new value for unique name of governance engine.

displayName - new value for the display name.

description - new description for the governance engine.

typeDescription - new description of the type ofg governance engine.

version - new version number for the governance engine implementation.

patchLevel - new patch level for the governance engine implementation.

source - new source description for the implementation of the governance engine.

additionalProperties - additional properties for the governance engine.

extendedProperties - properties to populate the subtype of the governance engine.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem storing the governance engine definition.

deleteGovernanceEngine

void deleteGovernanceEngine(String userId,
                            String guid,
                            String qualifiedName)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Remove the properties of the governance engine. Both the guid and the qualified name is supplied to validate that the correct governance engine is being deleted.

Parameters:

userId - identifier of calling user

guid - unique identifier of the governance engine - used to locate the definition.

qualifiedName - unique name for the governance engine.

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.

createGovernanceService

String createGovernanceService(String userId,
                               String qualifiedName,
                               String displayName,
                               String description,
                               Connection connection)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Create a governance service definition. The same governance service can be associated with multiple governance engines.

Parameters:

userId - identifier of calling user

qualifiedName - unique name for the governance service.

displayName - display name for the governance service.

description - description of the analysis provided by the governance service.

connection - connection to instanciate the governance service implementation.

Returns:

unique identifier of the governance service.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem storing the governance service definition.

getGovernanceServiceByGUID

GovernanceServiceElement getGovernanceServiceByGUID(String userId,
                                                    String guid)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

Return the properties from a governance service definition.

Parameters:

userId - identifier of calling user

guid - unique identifier (guid) of the governance service definition.

Returns:

properties of the governance service.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the governance service definition.

getGovernanceServiceByName

GovernanceServiceElement getGovernanceServiceByName(String userId,
                                                    String name)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

Return the properties from a governance service definition.

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.

getAllGovernanceServices

List<GovernanceServiceElement> getAllGovernanceServices(String userId,
                                                        int startingFrom,
                                                        int maximumResults)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Return the list of governance services definitions that are stored.

Parameters:

userId - identifier of calling user

startingFrom - initial position in the stored list.

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

Returns:

list of governance service definitions.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the governance service definitions.

getGovernanceServiceRegistrations

List<String> getGovernanceServiceRegistrations(String userId,
                                               String governanceServiceGUID)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Return the list of governance engines that a specific governance service is registered with.

Parameters:

userId - identifier of calling user

governanceServiceGUID - governance service to search for.

Returns:

list of governance engine 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 governance service and/or governance engine definitions.

updateGovernanceService

void updateGovernanceService(String userId,
                             String guid,
                             String qualifiedName,
                             String displayName,
                             String description,
                             Connection connection,
                             Map<String,String> additionalProperties,
                             Map<String,Object> extendedProperties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Update the properties of an existing governance service definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.

Parameters:

userId - identifier of calling user

guid - unique identifier of the governance service - used to locate the definition.

qualifiedName - new value for unique name of governance service.

displayName - new value for the display name.

description - new value for the description.

connection - connection used to create an instance of this governance service.

additionalProperties - additional properties for the governance engine.

extendedProperties - properties to populate the subtype of the governance service.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem storing the governance service definition.

deleteGovernanceService

void deleteGovernanceService(String userId,
                             String guid,
                             String qualifiedName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Remove the properties of the governance service. Both the guid and the qualified name is supplied to validate that the correct governance service is being deleted. The governance service is also unregistered from its governance engines.

Parameters:

userId - identifier of calling user

guid - unique identifier of the governance service - used to locate the definition.

qualifiedName - unique name for the governance service.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the governance service definition.

registerGovernanceServiceWithEngine

void registerGovernanceServiceWithEngine(String userId,
                                         String governanceEngineGUID,
                                         String governanceServiceGUID,
                                         String requestType,
                                         Map<String,String> requestParameters)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Register a governance service with a specific governance engine.

Parameters:

userId - identifier of calling user

governanceEngineGUID - unique identifier of the governance engine.

governanceServiceGUID - unique identifier of the governance service.

requestType - request type that this governance service is able to process.

requestParameters - list of parameters that are passed the the governance service (via the context). These values can be overridden on the actual governance service request.

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.

getRegisteredGovernanceService

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

Retrieve a specific governance service registered with a governance engine.

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

List<String> 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.

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 unique identifiers

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.

unregisterGovernanceServiceFromEngine

void unregisterGovernanceServiceFromEngine(String userId,
                                           String governanceEngineGUID,
                                           String governanceServiceGUID)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Unregister a governance service from the governance engine.

Parameters:

userId - identifier of calling user

governanceEngineGUID - unique identifier of the governance engine.

governanceServiceGUID - unique identifier of the governance service.

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.