Package org.odpi.openmetadata.viewservices.locationarena.server

Class LocationArenaRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.locationarena.server.LocationArenaRESTServices
public class LocationArenaRESTServices extends TokenController
The LocationArenaRESTServices provides the server-side implementation of the Location Arena Open Metadata View Service (OMVS). This interface provides access to a person's profile, roles and network.

  • Constructor Details

    • LocationArenaRESTServices

      public LocationArenaRESTServices()
      Default constructor

  • Method Details

    • createLocation

      public GUIDResponse createLocation(String serverName, NewElementRequestBody requestBody)
      Create a location.
      Parameters:
      serverName - name of called server.
      requestBody - properties for the location.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createLocationFromTemplate

      public GUIDResponse createLocationFromTemplate(String serverName, TemplateRequestBody requestBody)
      Create a new metadata element to represent a location 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 user
      requestBody - 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 a problem reported in the open metadata server(s)

    • updateLocation

      public BooleanResponse updateLocation(String serverName, String locationGUID, UpdateElementRequestBody requestBody)
      Update the properties of a location.
      Parameters:
      serverName - name of called server.
      locationGUID - unique identifier of the location (returned from create)
      requestBody - properties for the new element.
      Returns:
      boolean or InvalidParameterException one of the parameters is invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkPeerLocation

      public VoidResponse linkPeerLocation(String serverName, String locationOneGUID, String locationTwoGUID, NewRelationshipRequestBody requestBody)
      Attach a location to one of its peers.
      Parameters:
      serverName - name of called server
      locationOneGUID - unique identifier of the first location
      locationTwoGUID - unique identifier of the second location
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachPeerLocations

      public VoidResponse detachPeerLocations(String serverName, String locationOneGUID, String locationTwoGUID, DeleteRelationshipRequestBody requestBody)
      Detach a location from one of its peers.
      Parameters:
      serverName - name of called server
      locationOneGUID - unique identifier of the first location
      locationTwoGUID - unique identifier of the second location
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkNestedLocation

      public VoidResponse linkNestedLocation(String serverName, String locationGUID, String nestedLocationGUID, NewRelationshipRequestBody requestBody)
      Attach a super location to a nested location.
      Parameters:
      serverName - name of called server
      locationGUID - unique identifier of the super location
      nestedLocationGUID - unique identifier of the nested location
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachNestedLocation

      public VoidResponse detachNestedLocation(String serverName, String locationGUID, String nestedLocationGUID, DeleteRelationshipRequestBody requestBody)
      Detach a super location from a nested location.
      Parameters:
      serverName - name of called server
      locationGUID - unique identifier of the super location
      nestedLocationGUID - unique identifier of the nested location
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkKnownLocation

      public VoidResponse linkKnownLocation(String serverName, String elementGUID, String locationGUID, NewRelationshipRequestBody requestBody)
      Attach an element to its location.
      Parameters:
      serverName - name of called server
      elementGUID - unique identifier of the asset
      locationGUID - unique identifier of the location
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachKnownLocation

      public VoidResponse detachKnownLocation(String serverName, String elementGUID, String locationGUID, DeleteRelationshipRequestBody requestBody)
      Detach an element from its location.
      Parameters:
      serverName - name of called server
      elementGUID - unique identifier of the element
      locationGUID - unique identifier of the location
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteLocation

      public VoidResponse deleteLocation(String serverName, String locationGUID, DeleteElementRequestBody requestBody)
      Delete a location.
      Parameters:
      serverName - name of called server
      locationGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getLocationsByName

      public OpenMetadataRootElementsResponse getLocationsByName(String serverName, FilterRequestBody requestBody)
      Retrieve the list of location metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - 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 a problem reported in the open metadata server(s)

    • getLocationByGUID

      public OpenMetadataRootElementResponse getLocationByGUID(String serverName, String locationGUID, GetRequestBody requestBody)
      Retrieve the list of location metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      locationGUID - unique identifier of the required element
      requestBody - 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 a problem reported in the open metadata server(s)

    • findLocations

      public OpenMetadataRootElementsResponse findLocations(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of location metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - 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 a problem reported in the open metadata server(s)

    • setLocationAsFixedLocation

      public VoidResponse setLocationAsFixedLocation(String serverName, String locationGUID, NewClassificationRequestBody requestBody)
      Classify a location to say that it is a fixed physical location.
      Parameters:
      serverName - name of the server to route the request to
      locationGUID - unique identifier of the location
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearLocationAsFixedLocation

      public VoidResponse clearLocationAsFixedLocation(String serverName, String locationGUID, DeleteClassificationRequestBody requestBody)
      Remove the fixed location designation from a location.
      Parameters:
      serverName - name of the server to route the request to
      locationGUID - unique identifier of the location
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setLocationAsCyberLocation

      public VoidResponse setLocationAsCyberLocation(String serverName, String locationGUID, NewClassificationRequestBody requestBody)
      Classify a location to say that it is a cyber location reached over a network.
      Parameters:
      serverName - name of the server to route the request to
      locationGUID - unique identifier of the location
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearLocationAsCyberLocation

      public VoidResponse clearLocationAsCyberLocation(String serverName, String locationGUID, DeleteClassificationRequestBody requestBody)
      Remove the cyber location designation from a location.
      Parameters:
      serverName - name of the server to route the request to
      locationGUID - unique identifier of the location
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setLocationAsSecureLocation

      public VoidResponse setLocationAsSecureLocation(String serverName, String locationGUID, NewClassificationRequestBody requestBody)
      Classify a location to say that access to it is restricted.
      Parameters:
      serverName - name of the server to route the request to
      locationGUID - unique identifier of the location
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearLocationAsSecureLocation

      public VoidResponse clearLocationAsSecureLocation(String serverName, String locationGUID, DeleteClassificationRequestBody requestBody)
      Remove the secure location designation from a location.
      Parameters:
      serverName - name of the server to route the request to
      locationGUID - unique identifier of the location
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)