org.odpi.openmetadata.accessservices.assetconsumer.handlers

Class GlossaryHandler

java.lang.Object

org.odpi.openmetadata.accessservices.assetconsumer.handlers.GlossaryHandler

All Implemented Interfaces:

AssetConsumerGlossaryInterface

public class GlossaryHandler
extends Object
implements AssetConsumerGlossaryInterface

GlossaryHandler retrieves Glossary Term objects from the property server. It runs server-side in the AssetConsumer OMAS and retrieves Glossary Term entities through the OMRSRepositoryConnector.

Constructor Summary

Constructors

Constructor and Description
GlossaryHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, OMRSRepositoryHelper repositoryHelper, RepositoryHandler repositoryHandler) Construct the discovery engine configuration handler caching the objects needed to operate within a single server instance.

Method Summary

Modifier and Type	Method and Description
GlossaryTerm	getMeaning(String userId, String guid) Returns the glossary term object corresponding to the supplied glossary term GUID.
List<GlossaryTerm>	getMeaningByName(String userId, String name, int startFrom, int pageSize) Returns the glossary term object corresponding to the supplied term name.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlossaryHandler

public GlossaryHandler(String serviceName,
                       String serverName,
                       InvalidParameterHandler invalidParameterHandler,
                       OMRSRepositoryHelper repositoryHelper,
                       RepositoryHandler repositoryHandler)

Construct the discovery engine configuration handler caching the objects needed to operate within a single server instance.

Parameters:

serviceName - name of the consuming service

serverName - name of this server instance

invalidParameterHandler - handler for invalid parameters

repositoryHelper - helper used by the converters

repositoryHandler - handler for calling the repository services

Method Detail

getMeaningByName

public List<GlossaryTerm> getMeaningByName(String userId,
                                           String name,
                                           int startFrom,
                                           int pageSize)
                                    throws InvalidParameterException,
                                           PropertyServerException,
                                           UserNotAuthorizedException

Returns the glossary term object corresponding to the supplied term name.

Specified by:

getMeaningByName in interface AssetConsumerGlossaryInterface

Parameters:

userId - String - userId of user making request.

name - this may be the qualifiedName or displayName of the term.

startFrom - index of the list ot start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

List of glossary terms retrieved from property server

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property (metadata) server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getMeaning

public GlossaryTerm getMeaning(String userId,
                               String guid)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Returns the glossary term object corresponding to the supplied glossary term GUID.

Specified by:

getMeaning in interface AssetConsumerGlossaryInterface

Parameters:

userId - String - userId of user making request.

guid - the unique id for the glossary term within the property server.

Returns:

Glossary Term retrieved from the property server

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property (metadata) server.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.