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

Class GovernanceDefinitionManager

java.lang.Object

org.odpi.openmetadata.frameworkservices.omf.client.handlers.GovernanceDefinitionHandler

org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceDefinitionManager

public class GovernanceDefinitionManager
extends GovernanceDefinitionHandler

GovernanceDefinitionManager is the java client for managing the definitions for the governance drivers, policies and controls that define the motivation, goals and implementation approach for the governance program. Governance drivers document of the business strategy and regulations that provide the motivation behind the governance program. They feed into the governance program's policymaking phase ensuring the governance program is focused on activity that delivers value to the organization. A governance driver could be a governance strategy statement, a business imperative, a regulation or a regulation's article. Governance policies define the goals and best practices for the governance program. There are three types of governance policies:

• Governance Principles define the invariants that the organization tries to maintain.
• Governance Obligations define the requirements coming from regulations and policy makers of the organization.
• Governance Approaches describe preferred approaches and methods to follow

Within the definition of each governance policy is a description of what the policy is trying to achieve along with the implications to the organization's operation when they adopt this. These implications help to estimate the cost of the policy's implementation and the activities that need to happen. The governance definitions that define how the governance program is to be implemented. There are two types of governance definitions:

• Technical Controls define the use of technology to implement governance definitions. They consist of either:
  • GovernanceRule - a rule that need to be enforced to support a requirement of the governance program.
  • GovernanceProcess - a series of automated steps that need to run to support a requirement of the governance program.
• Organizational controls define roles, teams and manual procedures that implement an aspect of governance. They consist of either:
  • GovernanceResponsibility - a set of responsibilities that can be associated with a governance role
  • GovernanceProcedure - an manual procedure

Within the definition of each governance definition is a description of what the control is trying to achieve along with the implications to the organization's operation when they adopt this. These implications help to estimate the cost of the control's implementation and the activities that need to happen.

Constructor Summary

Constructors

Constructor	Description
GovernanceDefinitionManager(String localServerName, String serverName, String serverPlatformURLRoot, AuditLog auditLog, String accessServiceURLMarker, String serviceName, int maxPageSize)	Create a new client.

Method Summary

Methods inherited from class org.odpi.openmetadata.frameworkservices.omf.client.handlers.GovernanceDefinitionHandler

attachSupportingDefinition, createGovernanceDefinition, createGovernanceDefinitionFromTemplate, deleteGovernanceDefinition, detachDefinitionImplementation, detachPeerDefinitions, detachSupportingDefinition, findGovernanceDefinitions, getGovernanceDefinitionByGUID, getGovernanceDefinitionInContext, getGovernanceDefinitionsByName, linkDefinitionImplementation, linkPeerDefinitions, updateGovernanceDefinition, updateGovernanceDefinitionStatus

Methods inherited from class java.lang.Object

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

Constructor Details

GovernanceDefinitionManager

public GovernanceDefinitionManager(String localServerName,
 String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog,
 String accessServiceURLMarker,
 String serviceName,
 int maxPageSize)
                            throws InvalidParameterException

Create a new client.

Parameters:

serverName - name of the server to connect to

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

accessServiceURLMarker - optional access service URL marker used to identify which back end service to call

auditLog - logging destination

maxPageSize - maximum value allowed for page size

serviceName - name of calling service

Throws:

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