Class GovernanceDefinitionManager

  • All Implemented Interfaces:
    GovernanceDefinitionsInterface, RelatedElementsManagementInterface

    public class GovernanceDefinitionManager
    extends GovernanceProgramBaseClient
    implements GovernanceDefinitionsInterface
    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 Detail

      • GovernanceDefinitionManager

        public GovernanceDefinitionManager​(java.lang.String serverName,
                                           java.lang.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 servers
        Throws:
        InvalidParameterException - bad input parameters
      • GovernanceDefinitionManager

        public GovernanceDefinitionManager​(java.lang.String serverName,
                                           java.lang.String serverPlatformURLRoot,
                                           java.lang.String userId,
                                           java.lang.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 servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        Throws:
        InvalidParameterException - bad input parameters
      • GovernanceDefinitionManager

        public GovernanceDefinitionManager​(java.lang.String serverName,
                                           java.lang.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 servers
        maxPageSize - pre-initialized parameter limit
        auditLog - logging destination
        Throws:
        InvalidParameterException - bad input parameters
      • GovernanceDefinitionManager

        public GovernanceDefinitionManager​(java.lang.String serverName,
                                           java.lang.String serverPlatformURLRoot,
                                           java.lang.String userId,
                                           java.lang.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 servers
        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 - bad input parameters
      • GovernanceDefinitionManager

        public GovernanceDefinitionManager​(java.lang.String serverName,
                                           java.lang.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 servers
        restClient - internal client for rest calls
        maxPageSize - pre-initialized parameter limit
        Throws:
        InvalidParameterException - bad input parameters