org.odpi.openmetadata.accessservices.digitalarchitecture.server

Class LocationRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.digitalarchitecture.server.LocationRESTServices

public class LocationRESTServices
extends Object

LocationRESTServices provides the API operations to create and maintain location information.

Constructor Summary

Constructors

Constructor and Description
LocationRESTServices() Default constructor

Method Summary

Modifier and Type	Method and Description
VoidResponse	clearAdjacentLocation(String serverName, String userId, String locationOneGUID, String locationTwoGUID, NullRequestBody requestBody) Remove a peer-to-peer relationship between two locations.
VoidResponse	clearLocationAsDigital(String serverName, String userId, String locationGUID, NullRequestBody requestBody) Remove the digital/cyber location designation from the location.
VoidResponse	clearLocationAsFixedPhysical(String serverName, String userId, String locationGUID, NullRequestBody requestBody) Remove the fixed physical location designation from the location.
VoidResponse	clearLocationAsSecure(String serverName, String userId, String locationGUID, NullRequestBody requestBody) Remove the secure location designation from the location.
VoidResponse	clearNestedLocation(String serverName, String userId, String parentLocationGUID, String childLocationGUID, NullRequestBody requestBody) Remove a parent-child relationship between two locations.
GUIDResponse	createLocation(String serverName, String userId, LocationProperties locationProperties) Create a new metadata element to represent a location.
GUIDResponse	createLocationFromTemplate(String serverName, String userId, String templateGUID, TemplateProperties templateProperties) Create a new metadata element to represent a location using an existing metadata element as a template.
LocationsResponse	findLocations(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of location metadata elements that contain the search string.
LocationResponse	getLocationByGUID(String serverName, String userId, String locationGUID) Retrieve the location metadata element with the supplied unique identifier.
LocationsResponse	getLocationsByName(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of location metadata elements with a matching qualified or display name.
VoidResponse	removeLocation(String serverName, String userId, String locationGUID, NullRequestBody requestBody) Remove the metadata element representing a location.
VoidResponse	setLocationAsDigital(String serverName, String userId, String locationGUID, DigitalLocationRequestBody requestBody) Classify the location to indicate that it represents a digital/cyber location.
VoidResponse	setLocationAsFixedPhysical(String serverName, String userId, String locationGUID, FixedLocationRequestBody requestBody) Classify the location to indicate that it represents a fixed physical location.
VoidResponse	setLocationAsSecure(String serverName, String userId, String locationGUID, SecureLocationRequestBody requestBody) Classify the location to indicate that it represents a secure location.
VoidResponse	setupAdjacentLocation(String serverName, String userId, String locationOneGUID, String locationTwoGUID, NullRequestBody requestBody) Create a peer-to-peer relationship between two locations.
VoidResponse	setupNestedLocation(String serverName, String userId, String parentLocationGUID, String childLocationGUID, NullRequestBody requestBody) Create a parent-child relationship between two locations.
VoidResponse	updateLocation(String serverName, String userId, String locationGUID, LocationProperties locationProperties) Update the metadata element representing a location.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationRESTServices

public LocationRESTServices()

Default constructor

Method Detail

createLocation

public GUIDResponse createLocation(String serverName,
                                   String userId,
                                   LocationProperties locationProperties)

Create a new metadata element to represent a location. Classifications can be added later to define the type of location.

Parameters:

serverName - name of calling server

userId - calling user

locationProperties - properties to store

Returns:

unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

createLocationFromTemplate

public GUIDResponse createLocationFromTemplate(String serverName,
                                               String userId,
                                               String templateGUID,
                                               TemplateProperties templateProperties)

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 location.

Parameters:

serverName - name of calling server

userId - calling user

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

updateLocation

public VoidResponse updateLocation(String serverName,
                                   String userId,
                                   String locationGUID,
                                   LocationProperties locationProperties)

Update the metadata element representing a location.

Parameters:

serverName - name of calling server

userId - calling user

locationGUID - unique identifier of the metadata element to update

locationProperties - new properties for this element

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

setLocationAsFixedPhysical

public VoidResponse setLocationAsFixedPhysical(String serverName,
                                               String userId,
                                               String locationGUID,
                                               FixedLocationRequestBody requestBody)

Classify the location to indicate that it represents a fixed physical location.

Parameters:

serverName - name of calling server

userId - calling user

locationGUID - unique identifier of the metadata element to classify

requestBody - properties of the location

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

clearLocationAsFixedPhysical

public VoidResponse clearLocationAsFixedPhysical(String serverName,
                                                 String userId,
                                                 String locationGUID,
                                                 NullRequestBody requestBody)

Remove the fixed physical location designation from the location.

Parameters:

serverName - name of calling server

userId - calling user

locationGUID - unique identifier of the metadata element to unclassify

requestBody - null request body

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

setLocationAsSecure

public VoidResponse setLocationAsSecure(String serverName,
                                        String userId,
                                        String locationGUID,
                                        SecureLocationRequestBody requestBody)

Classify the location to indicate that it represents a secure location.

Parameters:

serverName - name of calling server

userId - calling user

locationGUID - unique identifier of the metadata element to classify

requestBody - properties of the location

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

clearLocationAsSecure

public VoidResponse clearLocationAsSecure(String serverName,
                                          String userId,
                                          String locationGUID,
                                          NullRequestBody requestBody)

Remove the secure location designation from the location.

Parameters:

serverName - name of calling server

userId - calling user

locationGUID - unique identifier of the metadata element to unclassify

requestBody - null request body

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

setLocationAsDigital

public VoidResponse setLocationAsDigital(String serverName,
                                         String userId,
                                         String locationGUID,
                                         DigitalLocationRequestBody requestBody)

Classify the location to indicate that it represents a digital/cyber location.

Parameters:

serverName - name of calling server

userId - calling user

locationGUID - unique identifier of the metadata element to classify

requestBody - position of the location

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

clearLocationAsDigital

public VoidResponse clearLocationAsDigital(String serverName,
                                           String userId,
                                           String locationGUID,
                                           NullRequestBody requestBody)

Remove the digital/cyber location designation from the location.

Parameters:

serverName - name of calling server

userId - calling user

locationGUID - unique identifier of the metadata element to unclassify

requestBody - null request body

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

removeLocation

public VoidResponse removeLocation(String serverName,
                                   String userId,
                                   String locationGUID,
                                   NullRequestBody requestBody)

Remove the metadata element representing a location.

Parameters:

serverName - name of calling server

userId - calling user

locationGUID - unique identifier of the metadata element to remove

requestBody - null request body

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

setupNestedLocation

public VoidResponse setupNestedLocation(String serverName,
                                        String userId,
                                        String parentLocationGUID,
                                        String childLocationGUID,
                                        NullRequestBody requestBody)

Create a parent-child relationship between two locations.

Parameters:

serverName - name of calling server

userId - calling user

parentLocationGUID - unique identifier of the location that is the broader location

childLocationGUID - unique identifier of the location that is the smaller, nested location

requestBody - null request body

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

clearNestedLocation

public VoidResponse clearNestedLocation(String serverName,
                                        String userId,
                                        String parentLocationGUID,
                                        String childLocationGUID,
                                        NullRequestBody requestBody)

Remove a parent-child relationship between two locations.

Parameters:

serverName - name of calling server

userId - calling user

parentLocationGUID - unique identifier of the location that is the broader location

childLocationGUID - unique identifier of the location that is the smaller, nested location

requestBody - null request body

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

setupAdjacentLocation

public VoidResponse setupAdjacentLocation(String serverName,
                                          String userId,
                                          String locationOneGUID,
                                          String locationTwoGUID,
                                          NullRequestBody requestBody)

Create a peer-to-peer relationship between two locations.

Parameters:

serverName - name of calling server

userId - calling user

locationOneGUID - unique identifier of the first location

locationTwoGUID - unique identifier of the second location

requestBody - null request body

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

clearAdjacentLocation

public VoidResponse clearAdjacentLocation(String serverName,
                                          String userId,
                                          String locationOneGUID,
                                          String locationTwoGUID,
                                          NullRequestBody requestBody)

Remove a peer-to-peer relationship between two locations.

Parameters:

serverName - name of calling server

userId - calling user

locationOneGUID - unique identifier of the first location

locationTwoGUID - unique identifier of the second location

requestBody - null request body

Returns:

void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

findLocations

public LocationsResponse findLocations(String serverName,
                                       String userId,
                                       SearchStringRequestBody requestBody,
                                       int startFrom,
                                       int pageSize)

Retrieve the list of location metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

serverName - name of calling server

userId - calling user

requestBody - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

getLocationsByName

public LocationsResponse getLocationsByName(String serverName,
                                            String userId,
                                            NameRequestBody requestBody,
                                            int startFrom,
                                            int pageSize)

Retrieve the list of location metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

serverName - name of calling server

userId - calling user

requestBody - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.

getLocationByGUID

public LocationResponse getLocationByGUID(String serverName,
                                          String userId,
                                          String locationGUID)

Retrieve the location metadata element with the supplied unique identifier.

Parameters:

serverName - name of calling server

userId - calling user

locationGUID - unique identifier of the requested metadata element

Returns:

matching metadata element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.