Package org.odpi.openmetadata.integrationservices.catalog.connector

Class OpenMetadataGovernanceService

java.lang.Object

org.odpi.openmetadata.integrationservices.catalog.connector.OpenMetadataGovernanceService

public class OpenMetadataGovernanceService
extends Object

OpenMetadataGovernanceService provides services for invoking metadata governance services in Egeria.

Method Summary

Modifier and Type	Method	Description
void	clearTranslation(String elementGUID, String language, String locale)	Remove the translation for a particular language/locale for a metadata element.
void	clearValidMetadataValue(String typeName, String propertyName, String preferredValue)	Remove a valid value for a property.
String	createIncidentReport(String qualifiedName, int domainIdentifier, String background, List<IncidentImpactedElement> impactedResources, List<IncidentDependency> previousIncidents, Map<String,Integer> incidentClassifiers, Map<String,String> additionalProperties, String originatorGUID)	Create an incident report to capture the situation detected by this governance action service.
TranslationDetail	getTranslation(String elementGUID, String language, String locale)	Retrieve the translation for the matching language/locale.
List<TranslationDetail>	getTranslations(String elementGUID, int startFrom, int pageSize)	Retrieve all translations associated with a metadata element.
ValidMetadataValue	getValidMetadataValue(String typeName, String propertyName, String preferredValue)	Retrieve details of a specific valid value for a property.
List<ValidMetadataValue>	getValidMetadataValues(String typeName, String propertyName, int startFrom, int pageSize)	Retrieve all the valid values for the requested property.
String	openToDo(String toDoQualifiedName, String title, String instructions, int priority, Date dueDate, String assignTo)	Create a To-Do request for someone to work on.
void	setTranslation(String elementGUID, TranslationDetail translationDetail)	Create or update the translation for a particular language/locale for a metadata element.
void	setUpValidMetadataValue(String typeName, String propertyName, ValidMetadataValue validMetadataValue)	Create or update the valid value for a particular open metadata property name.
boolean	validateMetadataValue(String typeName, String propertyName, String actualValue)	Validate whether the value found in an open metadata property is valid.

Methods inherited from class java.lang.Object

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

Method Detail

createIncidentReport

public String createIncidentReport(String qualifiedName,
                                   int domainIdentifier,
                                   String background,
                                   List<IncidentImpactedElement> impactedResources,
                                   List<IncidentDependency> previousIncidents,
                                   Map<String,Integer> incidentClassifiers,
                                   Map<String,String> additionalProperties,
                                   String originatorGUID)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Create an incident report to capture the situation detected by this governance action service. This incident report will be processed by other governance activities.

Parameters:

qualifiedName - unique identifier to give this new incident report

domainIdentifier - governance domain associated with this action (0=ALL)

background - description of the situation

impactedResources - details of the resources impacted by this situation

previousIncidents - links to previous incident reports covering this situation

incidentClassifiers - initial classifiers for the incident report

additionalProperties - additional arbitrary properties for the incident reports

originatorGUID - the unique identifier of the person or process that created the incident

Returns:

unique identifier of the resulting incident report

Throws:

InvalidParameterException - null or non-unique qualified name for the incident report

UserNotAuthorizedException - this governance action service is not authorized to create an incident report

PropertyServerException - there is a problem with the metadata store

openToDo

public String openToDo(String toDoQualifiedName,
                       String title,
                       String instructions,
                       int priority,
                       Date dueDate,
                       String assignTo)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

Create a To-Do request for someone to work on.

Parameters:

toDoQualifiedName - unique name for the to do. (Could be the engine name and a guid?)

title - short meaningful phrase for the person receiving the request

instructions - further details on what to do

priority - priority value (based on organization's scale)

dueDate - date/time this needs to be completed

assignTo - qualified name of the PersonRole element for the recipient

Returns:

unique identifier of new to do element

Throws:

InvalidParameterException - either todoQualifiedName or assignedTo are null or not recognized

UserNotAuthorizedException - the governance action service is not authorized to create a to-do

PropertyServerException - there is a problem connecting to (or inside) the metadata store

setTranslation

public void setTranslation(String elementGUID,
                           TranslationDetail translationDetail)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Create or update the translation for a particular language/locale for a metadata element.

Parameters:

elementGUID - unique identifier of the element that this translation is related to

translationDetail - properties of the translation

Throws:

InvalidParameterException - the unique identifier is null or not known.

UserNotAuthorizedException - the service is not able to access the element

PropertyServerException - there is a problem accessing the metadata store

clearTranslation

public void clearTranslation(String elementGUID,
                             String language,
                             String locale)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Remove the translation for a particular language/locale for a metadata element.

Parameters:

elementGUID - unique identifier of the element that this translation is related to

language - language requested

locale - optional locale to qualify which translation if there are multiple translations for the language.

Throws:

InvalidParameterException - the language is null or not known or not unique (add locale)

UserNotAuthorizedException - the service is not able to access the element

PropertyServerException - there is a problem accessing the metadata store

getTranslation

public TranslationDetail getTranslation(String elementGUID,
                                        String language,
                                        String locale)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Retrieve the translation for the matching language/locale.

Parameters:

elementGUID - unique identifier of the element that this translation is related to

language - language requested

locale - optional locale to qualify which translation if there are multiple translations for the language.

Returns:

the properties of the translation or null if there is none

Throws:

InvalidParameterException - the unique identifier is null or not known.

UserNotAuthorizedException - the service is not able to access the element

PropertyServerException - there is a problem accessing the metadata store

getTranslations

public List<TranslationDetail> getTranslations(String elementGUID,
                                               int startFrom,
                                               int pageSize)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Retrieve all translations associated with a metadata element.

Parameters:

elementGUID - unique identifier of the element that this translation is related to

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return

Returns:

list of translation properties or null if there are none

Throws:

InvalidParameterException - the unique identifier is null or not known.

UserNotAuthorizedException - the service is not able to access the element

PropertyServerException - there is a problem accessing the metadata store

setUpValidMetadataValue

public void setUpValidMetadataValue(String typeName,
                                    String propertyName,
                                    ValidMetadataValue validMetadataValue)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Create or update the valid value for a particular open metadata property name. If the typeName is null, this valid value applies to properties of this name from all types. The valid value is stored in the preferredValue property. If a valid value is already set up for this property (with overlapping effective dates) then the valid value is updated.

Parameters:

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

validMetadataValue - preferred value to use in the open metadata types plus additional descriptive values.

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

clearValidMetadataValue

public void clearValidMetadataValue(String typeName,
                                    String propertyName,
                                    String preferredValue)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Remove a valid value for a property.

Parameters:

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

preferredValue - specific valid value to remove

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

validateMetadataValue

public boolean validateMetadataValue(String typeName,
                                     String propertyName,
                                     String actualValue)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Validate whether the value found in an open metadata property is valid.

Parameters:

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

actualValue - value stored in the property - if this is null, true is only returned if null is set up as a valid value.

Returns:

boolean flag - true if the value is one of the defined valid values or there are no valid values set up for the property (and so any value is value).

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

getValidMetadataValue

public ValidMetadataValue getValidMetadataValue(String typeName,
                                                String propertyName,
                                                String preferredValue)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Retrieve details of a specific valid value for a property.

Parameters:

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

preferredValue - valid value to match

Returns:

specific valid value definition or none if there is no definition stored

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

getValidMetadataValues

public List<ValidMetadataValue> getValidMetadataValues(String typeName,
                                                       String propertyName,
                                                       int startFrom,
                                                       int pageSize)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException

Retrieve all the valid values for the requested property.

Parameters:

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of valid values defined for the property

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store