Package org.odpi.openmetadata.accessservices.governanceprogram.server

Class GovernanceZoneRESTServices

  • public class GovernanceZoneRESTServices
extends Object
    GovernanceZoneRESTServices provides the server side logic for the Governance Zone Manager. It manages the definitions of governance zones and their linkage to the rest of the governance program.

    • Constructor Detail

      • GovernanceZoneRESTServices

        public GovernanceZoneRESTServices()
        Default constructor

    • Method Detail

      • createGovernanceZone

        public GUIDResponse createGovernanceZone​(String serverName,
                                         String userId,
                                         GovernanceZoneProperties requestBody)
        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:
        serverName - name of the server instance to connect to
        userId - calling user
        requestBody - other properties for a governance zone
        Returns:
        unique identifier of the new zone or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

      • updateGovernanceZone

        public VoidResponse updateGovernanceZone​(String serverName,
                                         String userId,
                                         String zoneGUID,
                                         boolean isMergeUpdate,
                                         GovernanceZoneProperties requestBody)
        Update the definition of a zone.
        Parameters:
        serverName - name of the server instance to connect to
        userId - calling user
        zoneGUID - unique identifier of zone
        isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?
        requestBody - properties to change
        Returns:
        void or InvalidParameterException guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • deleteGovernanceZone

        public VoidResponse deleteGovernanceZone​(String serverName,
                                         String userId,
                                         String zoneGUID,
                                         NullRequestBody requestBody)
        Remove the definition of a zone.
        Parameters:
        serverName - name of the server instance to connect to
        userId - calling user
        zoneGUID - unique identifier of zone
        requestBody - null request body
        Returns:
        void or InvalidParameterException guid or userId is null; guid is not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • linkZonesInHierarchy

        public VoidResponse linkZonesInHierarchy​(String serverName,
                                         String userId,
                                         String parentZoneGUID,
                                         String childZoneGUID,
                                         NullRequestBody requestBody)
        Link two related governance zones together as part of a hierarchy. A zone can only have one parent but many child zones.
        Parameters:
        serverName - name of the server instance to connect to
        userId - calling user
        parentZoneGUID - unique identifier of the parent zone
        childZoneGUID - unique identifier of the child zone
        requestBody - null requestBody
        Returns:
        void or InvalidParameterException one of the guids is null or not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • unlinkZonesInHierarchy

        public VoidResponse unlinkZonesInHierarchy​(String serverName,
                                           String userId,
                                           String parentZoneGUID,
                                           String childZoneGUID,
                                           NullRequestBody requestBody)
        Remove the link between two zones in the zone hierarchy.
        Parameters:
        serverName - name of the server instance to connect to
        userId - calling user
        parentZoneGUID - unique identifier of the parent zone
        childZoneGUID - unique identifier of the child zone
        requestBody - null requestBody
        Returns:
        void or InvalidParameterException one of the guids is null or not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • linkZoneToGovernanceDefinition

        public VoidResponse linkZoneToGovernanceDefinition​(String serverName,
                                                   String userId,
                                                   String zoneGUID,
                                                   String definitionGUID,
                                                   NullRequestBody requestBody)
        Link a governance zone to a governance definition that controls how the assets in the zone should be governed.
        Parameters:
        serverName - name of the server instance to connect to
        userId - calling user
        zoneGUID - unique identifier of the zone
        definitionGUID - unique identifier of the governance definition
        requestBody - null requestBody
        Returns:
        void or InvalidParameterException one of the guids is null or not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • unlinkZoneFromGovernanceDefinition

        public VoidResponse unlinkZoneFromGovernanceDefinition​(String serverName,
                                                       String userId,
                                                       String zoneGUID,
                                                       String definitionGUID,
                                                       NullRequestBody requestBody)
        Remove the link between a zone and a governance definition.
        Parameters:
        serverName - name of the server instance to connect to
        userId - calling user
        zoneGUID - unique identifier of the zone
        definitionGUID - unique identifier of the governance definition
        requestBody - null requestBody
        Returns:
        void or InvalidParameterException one of the guids is null or not known PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • getGovernanceZoneByGUID

        public GovernanceZoneResponse getGovernanceZoneByGUID​(String serverName,
                                                      String userId,
                                                      String zoneGUID)
        Return information about a specific governance zone.
        Parameters:
        serverName - name of the server instance to connect to
        userId - calling user
        zoneGUID - unique identifier for the zone
        Returns:
        properties of the governance zone or InvalidParameterException zoneGUID or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • getGovernanceZoneByName

        public GovernanceZoneResponse getGovernanceZoneByName​(String serverName,
                                                      String userId,
                                                      String qualifiedName)
        Return information about a specific governance zone.
        Parameters:
        serverName - name of the server instance to connect to
        userId - calling user
        qualifiedName - unique name for the zone
        Returns:
        properties of the governance zone or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • getGovernanceZonesForDomain

        public GovernanceZoneListResponse getGovernanceZonesForDomain​(String serverName,
                                                              String userId,
                                                              int domainIdentifier,
                                                              int startFrom,
                                                              int pageSize)
        Return information about the defined governance zones.
        Parameters:
        serverName - name of the server instance to connect to
        userId - calling user
        domainIdentifier - identifier for the desired governance domain - 0 for all domains
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        properties of the governance zone or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • getGovernanceZoneDefinitionByGUID

        public GovernanceZoneDefinitionResponse getGovernanceZoneDefinitionByGUID​(String serverName,
                                                                          String userId,
                                                                          String zoneGUID)
        Return information about a specific governance zone and its linked governance definitions.
        Parameters:
        serverName - name of the server instance to connect to
        userId - calling user
        zoneGUID - unique identifier for the zone
        Returns:
        properties of the governance zone linked to the associated governance definitions or InvalidParameterException zoneGUID or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem