GovernanceZoneHandler (GAF Metadata Management Server-side Handlers 2.0 API)

java.lang.Object
- org.odpi.openmetadata.commonservices.gaf.metadatamanagement.handlers.GovernanceZoneHandler

```
public class GovernanceZoneHandler
extends Object
```
GovernanceZoneHandler provides the exchange of metadata about governance zones between the repository and the OMAS.

Constructor Summary

Constructors
Constructor and Description
`GovernanceZoneHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper)` Construct the handler information needed to interact with the repository services

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`createGovernanceZone(String userId, String qualifiedName, String displayName, String description, String criteria, Map<String,String> additionalProperties, Map<String,Object> extendedProperties, String methodName)` Create a definition of a governance zone.
`GovernanceZone`	`getGovernanceZone(String userId, String qualifiedName, String methodName)` Return information about a specific governance zone.
`List<GovernanceZone>`	`getGovernanceZones(String userId, int startingFrom, int maximumResults, String methodName)` 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

GovernanceZoneHandler

public GovernanceZoneHandler(String serviceName,
                             String serverName,
                             InvalidParameterHandler invalidParameterHandler,
                             RepositoryHandler repositoryHandler,
                             OMRSRepositoryHelper repositoryHelper)

Construct the handler information needed to interact with the repository services

Parameters:: serviceName - name of this service; serverName - name of the local server; invalidParameterHandler - handler for managing parameter errors; repositoryHandler - manages calls to the repository services; repositoryHelper - provides utilities for manipulating the repository services objects

Method Detail

createGovernanceZone

public void createGovernanceZone(String userId,
                                 String qualifiedName,
                                 String displayName,
                                 String description,
                                 String criteria,
                                 Map<String,String> additionalProperties,
                                 Map<String,Object> extendedProperties,
                                 String methodName)
                          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.

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; additionalProperties - additional properties for a governance zone; extendedProperties - properties for a governance zone subtype; methodName - calling method
Throws:: InvalidParameterException - qualifiedName or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getGovernanceZone

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

Return information about a specific governance zone.

Parameters:: userId - calling user; qualifiedName - unique name for the zone; methodName - calling method
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<GovernanceZone> getGovernanceZones(String userId,
                                               int startingFrom,
                                               int maximumResults,
                                               String methodName)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Return information about the defined governance zones.

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; methodName - calling method
Returns:: properties of the governance zone
Throws:: InvalidParameterException - qualifiedName or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

Class GovernanceZoneHandler