Package org.odpi.openmetadata.commonservices.generichandlers

Class LocationHandler<B>

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.LocationHandler<B>

public class LocationHandler<B>
extends ReferenceableHandler<B>

LocationHandler manages Location objects. It runs server-side in the OMAG Server Platform and retrieves Location entities through the OMRSRepositoryConnector.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones

Constructor Summary

Constructors

Constructor

Description

LocationHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)

Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method	Description
void	addCyberLocationClassification(String userId, String locationGUID, String locationGUIDParameterName, String networkAddress, String methodName)	Mark the location as a Cyber Location.
void	addFixedLocationClassification(String userId, String locationGUID, String locationGUIDParameterName, String coordinates, String mapProjection, String postalAddress, String timeZone, String methodName)	Mark the location as a Fixed Location.
void	addSecureLocationClassification(String userId, String locationGUID, String locationGUIDParameterName, String description, String level, String methodName)	Mark the location as a Secure Location.
void	clearAssetLocation(String userId, String locationGUID, String locationGUIDParameterName, String assetGUID, String assetGUIDParameterName, String methodName)	Remove a relationship between a location and an asset.
void	clearNestedLocation(String userId, String locationParentGUID, String locationParentGUIDParameterName, String locationChildGUID, String locationChildGUIDParameterName, String methodName)	Remove a parent-child relationship between two locations.
void	clearPeerLocations(String userId, String locationOneGUID, String locationOneGUIDParameterName, String locationTwoGUID, String locationTwoGUIDParameterName, String methodName)	Remove a peer relationship between two locations.
int	countKnownLocations(String userId, String elementGUID, String methodName)	Count the number of locations attached to an entity.
String	createLocation(String userId, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, String methodName)	Create the location.
String	createLocationFromTemplate(String userId, String templateGUID, String qualifiedName, String displayName, String description, String methodName)	Create a new metadata element to represent a location using an existing metadata element as a template.
List<B>	getLocations(String userId, String elementGUID, String elementGUIDParameterName, String elementTypeName, int startingFrom, int pageSize, String methodName)	Return the locations attached to an entity.
List<B>	getLocations(String userId, String elementGUID, String elementGUIDParameterName, String elementTypeName, List<String> serviceSupportedZones, int startingFrom, int pageSize, String methodName)	Return the locations attached to an entity.
void	removeCyberLocationClassification(String userId, String locationGUID, String locationGUIDParameterName, String methodName)	Remove the Cyber Location designation from a location.
void	removeFixedLocationClassification(String userId, String locationGUID, String locationGUIDParameterName, String methodName)	Remove the Fixed Location designation from a location.
void	removeLocation(String userId, String locationGUID, String locationGUIDParameterName, String methodName)	Remove the metadata element representing a location.
void	removeSecureLocationClassification(String userId, String locationGUID, String locationGUIDParameterName, String methodName)	Remove the Secure Location designation from a location.
void	setupAssetLocation(String userId, String locationGUID, String locationGUIDParameterName, String assetGUID, String assetGUIDParameterName, String methodName)	Create a relationship between a location and an asset.
void	setupNestedLocation(String userId, String locationParentGUID, String locationParentGUIDParameterName, String locationChildGUID, String locationChildGUIDParameterName, String methodName)	Create a parent-child relationship between two locations.
void	setupPeerLocations(String userId, String locationOneGUID, String locationOneGUIDParameterName, String locationTwoGUID, String locationTwoGUIDParameterName, String methodName)	Create a peer relationship between two locations.
void	updateLocation(String userId, String locationGUID, String locationGUIDParameterName, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, boolean isMergeUpdate, String methodName)	Update the location.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler

addOwner, addSecurityTags, addTemplateClassification, clearBusinessSignificant, findBeanGUIDsByQualifiedName, findBeanGUIDsByQualifiedName, findBeansByQualifiedName, findBeansByQualifiedName, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDsByQualifiedName, getBeanGUIDsByQualifiedName, getBeansByQualifiedName, getBeansByQualifiedName, getCollectionMembers, getEntityByUniqueQualifiedName, getMoreInformation, getMoreInformation, getVendorProperties, linkElementsAsDuplicates, removeOwner, removeResourceListMember, removeSecurityTags, removeSemanticAssignment, removeTemplateClassification, saveResourceListMember, saveSemanticAssignment, saveSemanticAssignment, setBusinessSignificant, setVendorProperties, unlinkElementsAsDuplicates

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

addAnchorsClassification, archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanFromTemplate, createBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findBeans, findEntities, getAllAttachmentLinks, getAnchorsForAttachedElements, getAttachedElement, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByIntValue, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRepositoryHelper, getServiceName, getTypeDefByName, getUniqueAttachmentLink, getUniqueAttachmentLink, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setSecurityVerifier, unlinkAllElements, unlinkAllElements, unlinkConnectedElement, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, validateUniqueProperty, verifyExternalSourceIdentity

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationHandler

public LocationHandler(OpenMetadataAPIGenericConverter<B> converter,
                       Class<B> beanClass,
                       String serviceName,
                       String serverName,
                       InvalidParameterHandler invalidParameterHandler,
                       RepositoryHandler repositoryHandler,
                       OMRSRepositoryHelper repositoryHelper,
                       String localServerUserId,
                       OpenMetadataServerSecurityVerifier securityVerifier,
                       List<String> supportedZones,
                       List<String> defaultZones,
                       List<String> publishZones,
                       AuditLog auditLog)

Construct the handler information needed to interact with the repository services

Parameters:

converter - specific converter for this bean class

beanClass - name of bean class that is represented by the generic class B

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

localServerUserId - userId for this server

securityVerifier - open metadata security services verifier

supportedZones - list of zones that the access service is allowed to serve Asset instances from.

defaultZones - list of zones that the access service should set in all new Asset instances.

publishZones - list of zones that the access service sets up in published Asset instances.

auditLog - destination for audit log events.

Method Detail

createLocation

public String createLocation(String userId,
                             String qualifiedName,
                             String displayName,
                             String description,
                             Map<String,String> additionalProperties,
                             String suppliedTypeName,
                             Map<String,Object> extendedProperties,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Create the location.

Parameters:

userId - calling user

qualifiedName - unique name for the location - used in other configuration

displayName - short display name for the location

description - description of the governance location

additionalProperties - additional properties for a location

suppliedTypeName - type name from the caller (enables creation of subtypes)

extendedProperties - properties for a governance location subtype

methodName - calling method

Returns:

unique identifier of the new location object

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

createLocationFromTemplate

public String createLocationFromTemplate(String userId,
                                         String templateGUID,
                                         String qualifiedName,
                                         String displayName,
                                         String description,
                                         String methodName)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

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. All categories and terms are linked to a single location. They are owned by this location and if the location is deleted, any linked terms and categories are deleted as well.

Parameters:

userId - calling user

templateGUID - unique identifier of the metadata element to copy

qualifiedName - unique name for the location - used in other configuration

displayName - short display name for the location

description - description of the governance location

methodName - calling method

Returns:

unique identifier of the new metadata element

Throws:

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)

updateLocation

public void updateLocation(String userId,
                           String locationGUID,
                           String locationGUIDParameterName,
                           String qualifiedName,
                           String displayName,
                           String description,
                           Map<String,String> additionalProperties,
                           String suppliedTypeName,
                           Map<String,Object> extendedProperties,
                           boolean isMergeUpdate,
                           String methodName)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Update the location.

Parameters:

userId - calling user

locationGUID - unique identifier of the location to update

locationGUIDParameterName - parameter passing the locationGUID

qualifiedName - unique name for the location - used in other configuration

displayName - short display name for the location

description - description of the governance location

additionalProperties - additional properties for a governance location

suppliedTypeName - type of location

extendedProperties - properties for a governance location subtype

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

methodName - calling method

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addFixedLocationClassification

public void addFixedLocationClassification(String userId,
                                           String locationGUID,
                                           String locationGUIDParameterName,
                                           String coordinates,
                                           String mapProjection,
                                           String postalAddress,
                                           String timeZone,
                                           String methodName)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Mark the location as a Fixed Location.

Parameters:

userId - calling user

locationGUID - unique identifier of location

locationGUIDParameterName - parameter name supplying locationGUID

coordinates - coordinate location

mapProjection - scheme used for the coordinates

postalAddress - postal address of the location

timeZone - time zone of the location

methodName - calling method

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeFixedLocationClassification

public void removeFixedLocationClassification(String userId,
                                              String locationGUID,
                                              String locationGUIDParameterName,
                                              String methodName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Remove the Fixed Location designation from a location.

Parameters:

userId - calling user

locationGUID - unique identifier of location

locationGUIDParameterName - parameter name supplying locationGUID

methodName - calling method

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addSecureLocationClassification

public void addSecureLocationClassification(String userId,
                                            String locationGUID,
                                            String locationGUIDParameterName,
                                            String description,
                                            String level,
                                            String methodName)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Mark the location as a Secure Location.

Parameters:

userId - calling user

locationGUID - unique identifier of location

locationGUIDParameterName - parameter name supplying locationGUID

description - description of security

level - level of security

methodName - calling method

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeSecureLocationClassification

public void removeSecureLocationClassification(String userId,
                                               String locationGUID,
                                               String locationGUIDParameterName,
                                               String methodName)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Remove the Secure Location designation from a location.

Parameters:

userId - calling user

locationGUID - unique identifier of location

locationGUIDParameterName - parameter name supplying locationGUID

methodName - calling method

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addCyberLocationClassification

public void addCyberLocationClassification(String userId,
                                           String locationGUID,
                                           String locationGUIDParameterName,
                                           String networkAddress,
                                           String methodName)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Mark the location as a Cyber Location.

Parameters:

userId - calling user

locationGUID - unique identifier of location

locationGUIDParameterName - parameter name supplying locationGUID

networkAddress - network address of the location

methodName - calling method

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeCyberLocationClassification

public void removeCyberLocationClassification(String userId,
                                              String locationGUID,
                                              String locationGUIDParameterName,
                                              String methodName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Remove the Cyber Location designation from a location.

Parameters:

userId - calling user

locationGUID - unique identifier of location

locationGUIDParameterName - parameter name supplying locationGUID

methodName - calling method

Throws:

InvalidParameterException - entity not known, null userId or guid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

setupNestedLocation

public void setupNestedLocation(String userId,
                                String locationParentGUID,
                                String locationParentGUIDParameterName,
                                String locationChildGUID,
                                String locationChildGUIDParameterName,
                                String methodName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Create a parent-child relationship between two locations.

Parameters:

userId - calling user

locationParentGUID - unique identifier of the parent location

locationParentGUIDParameterName - parameter supplying the parent

locationChildGUID - unique identifier of the child location

locationChildGUIDParameterName - parameter supplying the child

methodName - calling method

Throws:

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)

clearNestedLocation

public void clearNestedLocation(String userId,
                                String locationParentGUID,
                                String locationParentGUIDParameterName,
                                String locationChildGUID,
                                String locationChildGUIDParameterName,
                                String methodName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Remove a parent-child relationship between two locations.

Parameters:

userId - calling user

locationParentGUID - unique identifier of the parent location

locationParentGUIDParameterName - parameter supplying the parent

locationChildGUID - unique identifier of the child location

locationChildGUIDParameterName - parameter supplying the child

methodName - calling method

Throws:

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)

setupPeerLocations

public void setupPeerLocations(String userId,
                               String locationOneGUID,
                               String locationOneGUIDParameterName,
                               String locationTwoGUID,
                               String locationTwoGUIDParameterName,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Create a peer relationship between two locations.

Parameters:

userId - calling user

locationOneGUID - unique identifier of the first location

locationOneGUIDParameterName - parameter supplying the first location

locationTwoGUID - unique identifier of the second location

locationTwoGUIDParameterName - parameter supplying the second location

methodName - calling method

Throws:

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)

clearPeerLocations

public void clearPeerLocations(String userId,
                               String locationOneGUID,
                               String locationOneGUIDParameterName,
                               String locationTwoGUID,
                               String locationTwoGUIDParameterName,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Remove a peer relationship between two locations.

Parameters:

userId - calling user

locationOneGUID - unique identifier of the first location

locationOneGUIDParameterName - parameter supplying the first location

locationTwoGUID - unique identifier of the second location

locationTwoGUIDParameterName - parameter supplying the second location

methodName - calling method

Throws:

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)

setupAssetLocation

public void setupAssetLocation(String userId,
                               String locationGUID,
                               String locationGUIDParameterName,
                               String assetGUID,
                               String assetGUIDParameterName,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Create a relationship between a location and an asset.

Parameters:

userId - calling user

locationGUID - unique identifier of the location

locationGUIDParameterName - parameter supplying the location

assetGUID - unique identifier of the asset

assetGUIDParameterName - parameter supplying the asset

methodName - calling method

Throws:

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)

clearAssetLocation

public void clearAssetLocation(String userId,
                               String locationGUID,
                               String locationGUIDParameterName,
                               String assetGUID,
                               String assetGUIDParameterName,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Remove a relationship between a location and an asset.

Parameters:

userId - calling user

locationGUID - unique identifier of the location

locationGUIDParameterName - parameter supplying the location

assetGUID - unique identifier of the asset

assetGUIDParameterName - parameter supplying the asset

methodName - calling method

Throws:

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)

removeLocation

public void removeLocation(String userId,
                           String locationGUID,
                           String locationGUIDParameterName,
                           String methodName)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Remove the metadata element representing a location.

Parameters:

userId - calling user

locationGUID - unique identifier of the metadata element to remove

locationGUIDParameterName - parameter supplying the locationGUID

methodName - calling method

Throws:

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)

countKnownLocations

public int countKnownLocations(String userId,
                               String elementGUID,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Count the number of locations attached to an entity.

Parameters:

userId - calling user

elementGUID - identifier for the entity that the object is attached to

methodName - calling method

Returns:

count of attached objects

Throws:

InvalidParameterException - the parameters are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getLocations

public List<B> getLocations(String userId,
                            String elementGUID,
                            String elementGUIDParameterName,
                            String elementTypeName,
                            int startingFrom,
                            int pageSize,
                            String methodName)
                     throws InvalidParameterException,
                            PropertyServerException,
                            UserNotAuthorizedException

Return the locations attached to an entity.

Parameters:

userId - calling user

elementGUID - identifier for the entity that the feedback is attached to

elementGUIDParameterName - name of parameter supplying the GUID

elementTypeName - name of the type of object being attached to

startingFrom - where to start from in the list

pageSize - maximum number of results that can be returned

methodName - calling method

Returns:

list of retrieved objects or null if none found

Throws:

InvalidParameterException - the input properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getLocations

public List<B> getLocations(String userId,
                            String elementGUID,
                            String elementGUIDParameterName,
                            String elementTypeName,
                            List<String> serviceSupportedZones,
                            int startingFrom,
                            int pageSize,
                            String methodName)
                     throws InvalidParameterException,
                            PropertyServerException,
                            UserNotAuthorizedException

Return the locations attached to an entity.

Parameters:

userId - calling user

elementGUID - identifier for the entity that the feedback is attached to

elementGUIDParameterName - name of parameter supplying the GUID

elementTypeName - name of the type of object being attached to

serviceSupportedZones - supported zones for calling service

startingFrom - where to start from in the list

pageSize - maximum number of results that can be returned

methodName - calling method

Returns:

list of retrieved objects or null if none found

Throws:

InvalidParameterException - the input properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server