Class GovernanceOfficerRESTServices
java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.governanceofficer.server.GovernanceOfficerRESTServices
The GovernanceOfficerRESTServices provides the server-side implementation of the Governance Officer Open Metadata
View Service (OMVS). This interface provides access to a person's profile, roles and network.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionattachSupportingDefinition
(String serverName, String viewServiceURLMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, SupportingDefinitionRequestBody requestBody) Attach a supporting governance definition.createGovernanceDefinition
(String serverName, String viewServiceURLMarker, NewGovernanceDefinitionRequestBody requestBody) Create a governance definition.createGovernanceDefinitionFromTemplate
(String serverName, String viewServiceURLMarker, TemplateRequestBody requestBody) Create a new metadata element to represent a governance definition using an existing metadata element as a template.deleteGovernanceDefinition
(String serverName, String viewServiceURLMarker, String governanceDefinitionGUID, boolean cascadedDelete, MetadataSourceRequestBody requestBody) Delete a governance definition.detachDefinitionImplementation
(String serverName, String viewServiceURLMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, MetadataSourceRequestBody requestBody) Detach a governance definition from its implementation.detachPeerDefinitions
(String serverName, String viewServiceURLMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, MetadataSourceRequestBody requestBody) Detach a governance definition from one of its peers.detachSupportingDefinition
(String serverName, String viewServiceURLMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, MetadataSourceRequestBody requestBody) Detach a governance definition from a supporting governance definition.findGovernanceDefinitions
(String serverName, String viewServiceURLMarker, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance definition metadata elements that contain the search string.getGovernanceDefinitionByGUID
(String serverName, String viewServiceURLMarker, String governanceDefinitionGUID, AnyTimeRequestBody requestBody) Retrieve the list of governance definition metadata elements that contain the search string.getGovernanceDefinitionInContext
(String serverName, String viewServiceURLMarker, String governanceDefinitionGUID, int startFrom, int pageSize, ResultsRequestBody requestBody) Return the governance definition associated with a unique identifier and the other governance definitions linked to it.getGovernanceDefinitionsByName
(String serverName, String viewServiceURLMarker, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance definition metadata elements that contain the search string.linkDefinitionImplementation
(String serverName, String viewServiceURLMarker, String technicalControlGUID, String implementationGUID, String relationshipTypeName, GovernanceImplementationRequestBody requestBody) Attach a governance definition to its implementation.linkPeerDefinitions
(String serverName, String viewServiceURLMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, PeerDefinitionRequestBody requestBody) Attach two peer governance definitions.updateGovernanceDefinition
(String serverName, String viewServiceURLMarker, String governanceDefinitionGUID, boolean replaceAllProperties, UpdateGovernanceDefinitionRequestBody requestBody) Update the properties of a governance definition.updateGovernanceDefinitionStatus
(String serverName, String viewServiceURLMarker, String governanceDefinitionGUID, GovernanceDefinitionStatusRequestBody requestBody) Update the properties of a governance definition.Methods inherited from class org.odpi.openmetadata.tokencontroller.TokenController
getUser
-
Constructor Details
-
GovernanceOfficerRESTServices
public GovernanceOfficerRESTServices()Default constructor
-
-
Method Details
-
createGovernanceDefinition
public GUIDResponse createGovernanceDefinition(String serverName, String viewServiceURLMarker, NewGovernanceDefinitionRequestBody requestBody) Create a governance definition.- Parameters:
serverName
- name of called server.viewServiceURLMarker
- view service URL markerrequestBody
- properties for the governance definition.- Returns:
- unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
createGovernanceDefinitionFromTemplate
public GUIDResponse createGovernanceDefinitionFromTemplate(String serverName, String viewServiceURLMarker, TemplateRequestBody requestBody) Create a new metadata element to represent a governance definition using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.- Parameters:
serverName
- calling userviewServiceURLMarker
- view service URL markerrequestBody
- properties that override the template- Returns:
- unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateGovernanceDefinition
public VoidResponse updateGovernanceDefinition(String serverName, String viewServiceURLMarker, String governanceDefinitionGUID, boolean replaceAllProperties, UpdateGovernanceDefinitionRequestBody requestBody) Update the properties of a governance definition.- Parameters:
serverName
- name of called server.viewServiceURLMarker
- view service URL markergovernanceDefinitionGUID
- unique identifier of the governance definition (returned from create)replaceAllProperties
- flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.requestBody
- properties for the new element.- Returns:
- void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
updateGovernanceDefinitionStatus
public VoidResponse updateGovernanceDefinitionStatus(String serverName, String viewServiceURLMarker, String governanceDefinitionGUID, GovernanceDefinitionStatusRequestBody requestBody) Update the properties of a governance definition.- Parameters:
serverName
- name of called server.viewServiceURLMarker
- view service URL markergovernanceDefinitionGUID
- unique identifier of the governance definition (returned from create)requestBody
- properties for the new element.- Returns:
- void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
linkPeerDefinitions
public VoidResponse linkPeerDefinitions(String serverName, String viewServiceURLMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, PeerDefinitionRequestBody requestBody) Attach two peer governance definitions.- Parameters:
serverName
- name of called serverviewServiceURLMarker
- view service URL markergovernanceDefinitionOneGUID
- unique identifier of the first governance definitiongovernanceDefinitionTwoGUID
- unique identifier of the second governance definitionrelationshipTypeName
- name of the relationship to userequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
detachPeerDefinitions
public VoidResponse detachPeerDefinitions(String serverName, String viewServiceURLMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, MetadataSourceRequestBody requestBody) Detach a governance definition from one of its peers.- Parameters:
serverName
- name of called serverviewServiceURLMarker
- view service URL markergovernanceDefinitionOneGUID
- unique identifier of the first governance definitiongovernanceDefinitionTwoGUID
- unique identifier of the second governance definitionrelationshipTypeName
- name of the relationship to userequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
attachSupportingDefinition
public VoidResponse attachSupportingDefinition(String serverName, String viewServiceURLMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, SupportingDefinitionRequestBody requestBody) Attach a supporting governance definition.- Parameters:
serverName
- name of called serverviewServiceURLMarker
- view service URL markergovernanceDefinitionOneGUID
- unique identifier of the first governance definitiongovernanceDefinitionTwoGUID
- unique identifier of the second governance definitionrelationshipTypeName
- name of the relationship to userequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
detachSupportingDefinition
public VoidResponse detachSupportingDefinition(String serverName, String viewServiceURLMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, MetadataSourceRequestBody requestBody) Detach a governance definition from a supporting governance definition.- Parameters:
serverName
- name of called serverviewServiceURLMarker
- view service URL markergovernanceDefinitionOneGUID
- unique identifier of the first governance definitiongovernanceDefinitionTwoGUID
- unique identifier of the second governance definitionrelationshipTypeName
- name of the relationship to userequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
linkDefinitionImplementation
public VoidResponse linkDefinitionImplementation(String serverName, String viewServiceURLMarker, String technicalControlGUID, String implementationGUID, String relationshipTypeName, GovernanceImplementationRequestBody requestBody) Attach a governance definition to its implementation.- Parameters:
serverName
- name of called serverviewServiceURLMarker
- view service URL markertechnicalControlGUID
- unique identifier of the first governance definitionimplementationGUID
- unique identifier of the second governance definitionrelationshipTypeName
- name of the relationship to userequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
detachDefinitionImplementation
public VoidResponse detachDefinitionImplementation(String serverName, String viewServiceURLMarker, String governanceDefinitionOneGUID, String governanceDefinitionTwoGUID, String relationshipTypeName, MetadataSourceRequestBody requestBody) Detach a governance definition from its implementation.- Parameters:
serverName
- name of called serverviewServiceURLMarker
- view service URL markergovernanceDefinitionOneGUID
- unique identifier of the first governance definitiongovernanceDefinitionTwoGUID
- unique identifier of the second governance definitionrelationshipTypeName
- name of the relationship to userequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
deleteGovernanceDefinition
public VoidResponse deleteGovernanceDefinition(String serverName, String viewServiceURLMarker, String governanceDefinitionGUID, boolean cascadedDelete, MetadataSourceRequestBody requestBody) Delete a governance definition.- Parameters:
serverName
- name of called serverviewServiceURLMarker
- view service URL markergovernanceDefinitionGUID
- unique identifier of the element to deletecascadedDelete
- can governance definitions be deleted if data fields are attached?requestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
getGovernanceDefinitionsByName
public GovernanceDefinitionsResponse getGovernanceDefinitionsByName(String serverName, String viewServiceURLMarker, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance definition metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request toviewServiceURLMarker
- view service URL markerstartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- string to find in the properties- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getGovernanceDefinitionByGUID
public GovernanceDefinitionResponse getGovernanceDefinitionByGUID(String serverName, String viewServiceURLMarker, String governanceDefinitionGUID, AnyTimeRequestBody requestBody) Retrieve the list of governance definition metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request toviewServiceURLMarker
- view service URL markergovernanceDefinitionGUID
- unique identifier of the required elementrequestBody
- string to find in the properties- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
findGovernanceDefinitions
public GovernanceDefinitionsResponse findGovernanceDefinitions(String serverName, String viewServiceURLMarker, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance definition metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request toviewServiceURLMarker
- view service URL markerstartsWith
- does the value start with the supplied string?endsWith
- does the value end with the supplied string?ignoreCase
- should the search ignore case?startFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- string to find in the properties- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getGovernanceDefinitionInContext
public GovernanceDefinitionGraphResponse getGovernanceDefinitionInContext(String serverName, String viewServiceURLMarker, String governanceDefinitionGUID, int startFrom, int pageSize, ResultsRequestBody requestBody) Return the governance definition associated with a unique identifier and the other governance definitions linked to it.- Parameters:
serverName
- name of the server instance to connect toviewServiceURLMarker
- view service URL markergovernanceDefinitionGUID
- unique identifier of the governance definitionstartFrom
- paging startpageSize
- max elements that can be returnedrequestBody
- additional query parameters- Returns:
- governance definition and its linked elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the caller is not authorized to issue the request PropertyServerException the metadata service has problems
-