Package org.odpi.openmetadata.accessservices.governanceprogram.client

Class GovernanceDomainManager

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramBaseClient

org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceDomainManager

All Implemented Interfaces:

GovernanceDomainInterface, RelatedElementsManagementInterface

public class GovernanceDomainManager
extends GovernanceProgramBaseClient
implements GovernanceDomainInterface

GovernanceDomainManager sets up the governance domains that are part of an organization governance. Each governance domain describes a focus for governance.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramBaseClient

nullRequestBody

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addDomainToSet(String userId, String governanceDomainSetGUID, String governanceDomainGUID)	Create a parent-child relationship between a governance domain set and a governance domain.
String	createGovernanceDomain(String userId, String setGUID, GovernanceDomainProperties properties)	Create a new metadata element to represent a governance domain.
String	createGovernanceDomainSet(String userId, GovernanceDomainSetProperties properties)	Create a new metadata element to represent the root of a Governance Domain Set.
String	createStandardGovernanceDomains(String userId)	Create a governance domain set called "EgeriaStandardDomains" containing governance domain definitions for the following governance domains.
void	deleteGovernanceDomain(String userId, String governanceDomainGUID)	Remove the metadata element representing a Governance Domain.
List<GovernanceDomainElement>	findGovernanceDomains(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of Governance Domain metadata elements that contain the search string.
List<GovernanceDomainSetElement>	findGovernanceDomainSets(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of governanceDomainSet metadata elements that contain the search string.
GovernanceDomainElement	getGovernanceDomainByGUID(String userId, String governanceDomainGUID)	Retrieve the Governance Domain metadata element with the supplied unique identifier assigned when the domain description was stored in the metadata repository.
GovernanceDomainElement	getGovernanceDomainByIdentifier(String userId, int domainIdentifier)	Retrieve the Governance Domain metadata element with the supplied domain identifier.
List<GovernanceDomainElement>	getGovernanceDomains(String userId, int startFrom, int pageSize)	Retrieve the list of Governance Domain metadata elements defined for the governance program.
List<GovernanceDomainElement>	getGovernanceDomainsByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of Governance Domain metadata elements with a matching qualified or display name.
GovernanceDomainSetElement	getGovernanceDomainSetByGUID(String userId, String governanceDomainSetGUID)	Retrieve the governanceDomainSet metadata element with the supplied unique identifier.
List<GovernanceDomainSetElement>	getGovernanceDomainSetsByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of governanceDomainSet metadata elements with a matching qualified or display name.
List<GovernanceDomainSetElement>	getSetsForGovernanceDomain(String userId, String governanceDomainGUID, int startFrom, int pageSize)	Return the list of governance domain sets that a governance domain belong.
void	removeDomainFromSet(String userId, String governanceDomainSetGUID, String governanceDomainGUID)	Remove a parent-child relationship between a governance domain set and a governance domain.
void	removeGovernanceDomainSet(String userId, String governanceDomainSetGUID)	Remove the metadata element representing a governanceDomainSet.
void	updateGovernanceDomain(String userId, String governanceDomainGUID, GovernanceDomainProperties properties)	Update the metadata element representing a Governance Domain.
void	updateGovernanceDomainSet(String userId, String governanceDomainSetGUID, GovernanceDomainSetProperties properties)	Update the metadata element representing a Governance Domain Set.

Methods inherited from class org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramBaseClient

clearAssignmentScope, clearGovernanceDefinitionScope, clearGovernanceResponsibilityAssignment, clearGovernedBy, clearMoreInformation, clearResource, clearStakeholder, getAssignedActors, getAssignedScopes, getDescriptiveElements, getGovernanceDefinitionScopes, getGovernanceDefinitionsForElement, getGovernedElements, getMoreInformation, getResourceList, getResponsibleRoles, getRoleResponsibilities, getScopedGovernanceDefinitions, getStakeholderCommissionedElements, getStakeholders, getSupportedByResource, removeReferenceable, setupAssignmentScope, setupGovernanceDefinitionScope, setupGovernanceResponsibilityAssignment, setupGovernedBy, setupMoreInformation, setupResource, setupStakeholder, updateGovernanceDefinitionStatus, updateRelationship

Methods inherited from class java.lang.Object

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

Constructor Details

GovernanceDomainManager

public GovernanceDomainManager(String serverName,
 String serverPlatformURLRoot)
                        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

Throws:

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

GovernanceDomainManager

public GovernanceDomainManager(String serverName,
 String serverPlatformURLRoot,
 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:

serverName - name of the server to connect to

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

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.

GovernanceDomainManager

public GovernanceDomainManager(String serverName,
 String serverPlatformURLRoot,
 int maxPageSize,
 AuditLog auditLog)
                        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

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

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

GovernanceDomainManager

public GovernanceDomainManager(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 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

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

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

GovernanceDomainManager

public GovernanceDomainManager(String serverName,
 String serverPlatformURLRoot,
 GovernanceProgramRESTClient restClient,
 int maxPageSize)
                        throws InvalidParameterException

Create a new client that uses the supplied rest client. This is typically used when called from another OMAG Server.

Parameters:

serverName - name of the server to connect to

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

restClient - internal client for rest calls

maxPageSize - pre-initialized parameter limit

Throws:

InvalidParameterException - bad input parameters

Method Details

createStandardGovernanceDomains

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

Create a governance domain set called "EgeriaStandardDomains" containing governance domain definitions for the following governance domains.

• Unclassified - The governance domain is not specified - that is the definition applies to all domains - this is the default value for governance definitions within the governance program.
• Data - The data (information) governance domain
• Privacy - The data privacy governance domain
• Security - The security governance domain.
• IT Infrastructure - The IT infrastructure management governance domain.
• Software Development - The software development lifecycle (SDLC) governance domain.
• Corporate - The corporate governance domain.
• Asset Management - The physical asset management governance domain.

Specified by:

createStandardGovernanceDomains in interface GovernanceDomainInterface

Parameters:

userId - calling user

Returns:

unique identifier of the governance domain set

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)

createGovernanceDomainSet

public String createGovernanceDomainSet(String userId,
 GovernanceDomainSetProperties properties)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent the root of a Governance Domain Set.

Specified by:

createGovernanceDomainSet in interface GovernanceDomainInterface

Parameters:

userId - calling user

properties - properties to store

Returns:

unique identifier of the new metadata element

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)

updateGovernanceDomainSet

public void updateGovernanceDomainSet(String userId,
 String governanceDomainSetGUID,
 GovernanceDomainSetProperties properties)
                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a Governance Domain Set.

Specified by:

updateGovernanceDomainSet in interface GovernanceDomainInterface

Parameters:

userId - calling user

governanceDomainSetGUID - unique identifier of the metadata element to remove

properties - new properties for this element

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)

removeGovernanceDomainSet

public void removeGovernanceDomainSet(String userId,
 String governanceDomainSetGUID)
                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a governanceDomainSet. The governance domains are not deleted.

Specified by:

removeGovernanceDomainSet in interface GovernanceDomainInterface

Parameters:

userId - calling user

governanceDomainSetGUID - unique identifier of the metadata element to remove

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)

findGovernanceDomainSets

public List<GovernanceDomainSetElement> findGovernanceDomainSets(String userId,
 String searchString,
 int startFrom,
 int pageSize)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governanceDomainSet metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findGovernanceDomainSets in interface GovernanceDomainInterface

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

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)

getGovernanceDomainSetsByName

public List<GovernanceDomainSetElement> getGovernanceDomainSetsByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governanceDomainSet metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getGovernanceDomainSetsByName in interface GovernanceDomainInterface

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

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)

getGovernanceDomainSetByGUID

public GovernanceDomainSetElement getGovernanceDomainSetByGUID(String userId,
 String governanceDomainSetGUID)
                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governanceDomainSet metadata element with the supplied unique identifier.

Specified by:

getGovernanceDomainSetByGUID in interface GovernanceDomainInterface

Parameters:

userId - calling user

governanceDomainSetGUID - unique identifier of the requested metadata element

Returns:

matching metadata element

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)

createGovernanceDomain

public String createGovernanceDomain(String userId,
 String setGUID,
 GovernanceDomainProperties properties)
                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a governance domain.

Specified by:

createGovernanceDomain in interface GovernanceDomainInterface

Parameters:

userId - calling user

setGUID - unique identifier of the set that this identifier belongs

properties - properties about the Governance Domain to store

Returns:

unique identifier of the new Governance Domain

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)

updateGovernanceDomain

public void updateGovernanceDomain(String userId,
 String governanceDomainGUID,
 GovernanceDomainProperties properties)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a Governance Domain.

Specified by:

updateGovernanceDomain in interface GovernanceDomainInterface

Parameters:

userId - calling user

governanceDomainGUID - unique identifier of the metadata element to update

properties - new properties for the metadata element

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)

deleteGovernanceDomain

public void deleteGovernanceDomain(String userId,
 String governanceDomainGUID)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a Governance Domain.

Specified by:

deleteGovernanceDomain in interface GovernanceDomainInterface

Parameters:

userId - calling user

governanceDomainGUID - unique identifier of the metadata element to remove

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)

addDomainToSet

public void addDomainToSet(String userId,
 String governanceDomainSetGUID,
 String governanceDomainGUID)
                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a parent-child relationship between a governance domain set and a governance domain.

Specified by:

addDomainToSet in interface GovernanceDomainInterface

Parameters:

userId - calling user

governanceDomainSetGUID - unique identifier of the governance domain set

governanceDomainGUID - unique identifier of the governance domain

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)

removeDomainFromSet

public void removeDomainFromSet(String userId,
 String governanceDomainSetGUID,
 String governanceDomainGUID)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a parent-child relationship between a governance domain set and a governance domain.

Specified by:

removeDomainFromSet in interface GovernanceDomainInterface

Parameters:

userId - calling user

governanceDomainSetGUID - unique identifier of the governance domain set

governanceDomainGUID - unique identifier of the governance domain

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)

getGovernanceDomains

public List<GovernanceDomainElement> getGovernanceDomains(String userId,
 int startFrom,
 int pageSize)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of Governance Domain metadata elements defined for the governance program.

Specified by:

getGovernanceDomains in interface GovernanceDomainInterface

Parameters:

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

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)

findGovernanceDomains

public List<GovernanceDomainElement> findGovernanceDomains(String userId,
 String searchString,
 int startFrom,
 int pageSize)
                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of Governance Domain metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:

findGovernanceDomains in interface GovernanceDomainInterface

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

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)

getSetsForGovernanceDomain

public List<GovernanceDomainSetElement> getSetsForGovernanceDomain(String userId,
 String governanceDomainGUID,
 int startFrom,
 int pageSize)
                                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of governance domain sets that a governance domain belong.

Specified by:

getSetsForGovernanceDomain in interface GovernanceDomainInterface

Parameters:

userId - calling user

governanceDomainGUID - unique identifier of the governance domain to query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of metadata elements describing the sets associated with the requested governanceDomainSet

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)

getGovernanceDomainsByName

public List<GovernanceDomainElement> getGovernanceDomainsByName(String userId,
 String name,
 int startFrom,
 int pageSize)
                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of Governance Domain metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:

getGovernanceDomainsByName in interface GovernanceDomainInterface

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

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)

getGovernanceDomainByGUID

public GovernanceDomainElement getGovernanceDomainByGUID(String userId,
 String governanceDomainGUID)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the Governance Domain metadata element with the supplied unique identifier assigned when the domain description was stored in the metadata repository.

Specified by:

getGovernanceDomainByGUID in interface GovernanceDomainInterface

Parameters:

userId - calling user

governanceDomainGUID - unique identifier of the requested metadata element

Returns:

requested metadata element

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)

getGovernanceDomainByIdentifier

public GovernanceDomainElement getGovernanceDomainByIdentifier(String userId,
 int domainIdentifier)
                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the Governance Domain metadata element with the supplied domain identifier.

Specified by:

getGovernanceDomainByIdentifier in interface GovernanceDomainInterface

Parameters:

userId - calling user

domainIdentifier - identifier used to identify the domain

Returns:

requested metadata element

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)