org.odpi.openmetadata.accessservices.governanceprogram.client

Class GovernanceZoneManager

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceZoneManager

All Implemented Interfaces:

GovernanceZoneManagerInterface

public class GovernanceZoneManager
extends Object
implements GovernanceZoneManagerInterface

GovernanceZoneManager is the client used to manage governance zones.

Constructor Summary

Constructors

Constructor and Description
GovernanceZoneManager(String serverName, String serverPlatformURLRoot) Create a new client with no authentication embedded in the HTTP request.
GovernanceZoneManager(String serverName, String serverPlatformURLRoot, int maxPageSize, AuditLog auditLog) Create a new client with no authentication embedded in the HTTP request.
GovernanceZoneManager(String serverName, String serverPlatformURLRoot, String userId, String password) Create a new client that passes userId and password in each HTTP request.
GovernanceZoneManager(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.

Method Summary

Modifier and Type	Method and Description
void	createGovernanceZone(String userId, String qualifiedName, String displayName, String description, String criteria, String scope, int domainIdentifier, Map<String,String> additionalProperties) Create a definition of a governance zone.
GovernanceZoneElement	getGovernanceZone(String userId, String qualifiedName) Return information about a specific governance zone.
List<GovernanceZoneElement>	getGovernanceZones(String userId, int startingFrom, int maximumResults) Return information about the defined governance zones.

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceZoneManager

public GovernanceZoneManager(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 servers

Throws:

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

GovernanceZoneManager

public GovernanceZoneManager(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 servers

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.

GovernanceZoneManager

public GovernanceZoneManager(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 servers

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.

GovernanceZoneManager

public GovernanceZoneManager(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 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 - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

createGovernanceZone

public void createGovernanceZone(String userId,
                                 String qualifiedName,
                                 String displayName,
                                 String description,
                                 String criteria,
                                 String scope,
                                 int domainIdentifier,
                                 Map<String,String> additionalProperties)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Create a definition of a governance zone. The qualified name of these governance zones can be added to the supportedZones and defaultZones properties of an OMAS to control which assets are processed and how they are set up. In addition the qualified names of zones can be added to Asset definitions to indicate which zone(s) they belong to.

Specified by:

createGovernanceZone in interface GovernanceZoneManagerInterface

Parameters:

userId - calling user

qualifiedName - unique name for the zone - used in other configuration

displayName - short display name for the zone

description - description of the governance zone

criteria - the criteria for inclusion in a governance zone

scope - scope of the organization that this some applies to

domainIdentifier - the identifier of the governance domain where the zone is managed - 0 means ALL

additionalProperties - additional properties for a governance zone

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceZone

public GovernanceZoneElement getGovernanceZone(String userId,
                                               String qualifiedName)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Return information about a specific governance zone.

Specified by:

getGovernanceZone in interface GovernanceZoneManagerInterface

Parameters:

userId - calling user

qualifiedName - unique name for the zone

Returns:

properties of the governance zone

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceZones

public List<GovernanceZoneElement> getGovernanceZones(String userId,
                                                      int startingFrom,
                                                      int maximumResults)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Return information about the defined governance zones.

Specified by:

getGovernanceZones in interface GovernanceZoneManagerInterface

Parameters:

userId - calling user

startingFrom - position in the list (used when there are so many reports that paging is needed

maximumResults - maximum number of elements to return an this call

Returns:

properties of the governance zone

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem