org.odpi.openmetadata.viewservices.rex.handlers

Class RexViewHandler

java.lang.Object

org.odpi.openmetadata.viewservices.rex.handlers.RexViewHandler

public class RexViewHandler
extends Object

The RexViewHandler is initialised with the server the call should be sent to. The handler exposes methods for functionality for the repository explorer view

Constructor Summary

Constructors

Constructor and Description
RexViewHandler() Constructor for the RexViewHandler

Method Summary

Modifier and Type	Method and Description
Map<String,RexEntityDigest>	findEntities(String userId, String repositoryServerName, String repositoryServerURLRoot, boolean enterpriseOption, String searchText, String entityTypeName, List<String> classificationNames, String methodName) Retrieve entities (by text search) from the repository server
Map<String,RexRelationshipDigest>	findRelationships(String userId, String repositoryServerName, String repositoryServerURLRoot, boolean enterpriseOption, String searchText, String relationshipTypeName, String methodName) Retrieve relationships (by text search) from the repository server
RexExpandedEntityDetail	getEntity(String userId, String repositoryServerName, String repositoryServerURLRoot, boolean enterpriseOption, String entityGUID, String methodName) Retrieve entity (by GUID) from the repository server
RexExpandedRelationship	getRelationship(String userId, String repositoryServerName, String repositoryServerURLRoot, boolean enterpriseOption, String relationshipGUID, String methodName) Retrieve relationship (by GUID) from the repository server
TypeExplorer	getTypeExplorer(String userId, String repositoryServerName, String repositoryServerURLRoot, boolean enterpriseOption, String methodName) Retrieve type information from the repository server
RexPreTraversal	preTraversal(String userId, String repositoryServerName, String repositoryServerURLRoot, boolean enterpriseOption, String entityGUID, int depth, String methodName) Retrieve the neighborhood surrounding an entity for pre-traversal.
RexTraversal	traversal(String userId, String repositoryServerName, String repositoryServerURLRoot, boolean enterpriseOption, String entityGUID, int depth, List<String> entityTypeGUIDs, List<String> relationshipTypeGUIDs, List<String> classificationNames, String methodName) Retrieve the neighborhood surrounding an entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

RexViewHandler

public RexViewHandler()

Constructor for the RexViewHandler

Method Detail

getTypeExplorer

public TypeExplorer getTypeExplorer(String userId,
                                    String repositoryServerName,
                                    String repositoryServerURLRoot,
                                    boolean enterpriseOption,
                                    String methodName)
                             throws RepositoryErrorException,
                                    InvalidParameterException,
                                    UserNotAuthorizedException

Retrieve type information from the repository server

Parameters:

userId - userId under which the request is performed

repositoryServerName - The name of the repository server to interrogate

repositoryServerURLRoot - The URL root of the repository server to interrogate

enterpriseOption - Whether the query is at cohort level or server specific

methodName - The name of the method being invoked

Returns:

response containing the TypeExplorer object. Exceptions returned by the server

Throws:

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

InvalidParameterException - one of the parameters is null or invalid. Client library Exceptions

RepositoryErrorException - Repository could not satisfy the request

getEntity

public RexExpandedEntityDetail getEntity(String userId,
                                         String repositoryServerName,
                                         String repositoryServerURLRoot,
                                         boolean enterpriseOption,
                                         String entityGUID,
                                         String methodName)
                                  throws RepositoryErrorException,
                                         InvalidParameterException,
                                         UserNotAuthorizedException,
                                         EntityNotKnownException,
                                         EntityProxyOnlyException

Retrieve entity (by GUID) from the repository server

Parameters:

userId - userId under which the request is performed

repositoryServerName - The name of the repository server to interrogate

repositoryServerURLRoot - The URL root of the repository server to interrogate

enterpriseOption - Whether the query is at cohort level or server specific

entityGUID - the GUID of the entity to retrieve

methodName - The name of the method being invoked

Returns:

response containing the RexExpandedEntityDetail object. Exceptions returned by the server

Throws:

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

InvalidParameterException - one of the parameters is null or invalid.

EntityNotKnownException - no entity was found using the supplied GUID.

EntityProxyOnlyException - an entity proxy was found, but it's not the entity you are looking for. Client library Exceptions

RepositoryErrorException - Repository could not satisfy the request

getRelationship

public RexExpandedRelationship getRelationship(String userId,
                                               String repositoryServerName,
                                               String repositoryServerURLRoot,
                                               boolean enterpriseOption,
                                               String relationshipGUID,
                                               String methodName)
                                        throws RepositoryErrorException,
                                               InvalidParameterException,
                                               UserNotAuthorizedException,
                                               RelationshipNotKnownException

Retrieve relationship (by GUID) from the repository server

Parameters:

userId - userId under which the request is performed

repositoryServerName - The name of the repository server to interrogate

repositoryServerURLRoot - The URL root of the repository server to interrogate

enterpriseOption - Whether the query is at cohort level or server specific

relationshipGUID - the GUID of the relationship to retrieve

methodName - The name of the method being invoked

Returns:

response containing the RexExpandedEntityDetail object. Exceptions returned by the server

Throws:

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

InvalidParameterException - one of the parameters is null or invalid.

RelationshipNotKnownException - no relationship was found using the supplied GUID. Client library Exceptions

RepositoryErrorException - Repository could not satisfy the request

findEntities

public Map<String,RexEntityDigest> findEntities(String userId,
                                                String repositoryServerName,
                                                String repositoryServerURLRoot,
                                                boolean enterpriseOption,
                                                String searchText,
                                                String entityTypeName,
                                                List<String> classificationNames,
                                                String methodName)
                                         throws RepositoryErrorException,
                                                InvalidParameterException,
                                                UserNotAuthorizedException,
                                                TypeErrorException,
                                                PropertyErrorException,
                                                PagingErrorException,
                                                FunctionNotSupportedException

Retrieve entities (by text search) from the repository server

Parameters:

userId - userId under which the request is performed

repositoryServerName - The name of the repository server to interrogate

repositoryServerURLRoot - The URL root of the repository server to interrogate

enterpriseOption - Whether the query is at cohort level or server specific

searchText - the search expression that entities must match

entityTypeName - the name of a type used to filter the entity search

classificationNames - classification names to limit find by

methodName - The name of the method being invoked

Returns:

a map of entity digests for the entities that matched the search Exceptions returned by the server

Throws:

InvalidParameterException - a parameter is invalid or null.

TypeErrorException - the type guid passed on the request is not known by the metadata collection.

RepositoryErrorException - there is a problem communicating with the metadata repository where the metadata collection is stored.

PropertyErrorException - the sequencing property specified is not valid for any of the requested types of entity.

PagingErrorException - the paging/sequencing parameters are set up incorrectly.

FunctionNotSupportedException - the repository does not support the operation with the provided parameters.

UserNotAuthorizedException - the userId is not permitted to perform this operation.

findRelationships

public Map<String,RexRelationshipDigest> findRelationships(String userId,
                                                           String repositoryServerName,
                                                           String repositoryServerURLRoot,
                                                           boolean enterpriseOption,
                                                           String searchText,
                                                           String relationshipTypeName,
                                                           String methodName)
                                                    throws RepositoryErrorException,
                                                           InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           TypeErrorException,
                                                           PropertyErrorException,
                                                           PagingErrorException,
                                                           FunctionNotSupportedException

Retrieve relationships (by text search) from the repository server

Parameters:

userId - userId under which the request is performed

repositoryServerName - The name of the repository server to interrogate

repositoryServerURLRoot - The URL root of the repository server to interrogate

enterpriseOption - Whether the query is at cohort level or server specific

searchText - the search expression that relationships must match

relationshipTypeName - the name of a type used to filter the relationship search

methodName - The name of the method being invoked

Returns:

a map of relationship digests for the relationships that matched the search Exceptions returned by the server

Throws:

InvalidParameterException - a parameter is invalid or null.

TypeErrorException - the type guid passed on the request is not known by the metadata collection.

RepositoryErrorException - there is a problem communicating with the metadata repository where the metadata collection is stored.

PropertyErrorException - the sequencing property specified is not valid for any of the requested types of entity.

PagingErrorException - the paging/sequencing parameters are set up incorrectly.

FunctionNotSupportedException - the repository does not support the operation with the provided parameters.

UserNotAuthorizedException - the userId is not permitted to perform this operation.

preTraversal

public RexPreTraversal preTraversal(String userId,
                                    String repositoryServerName,
                                    String repositoryServerURLRoot,
                                    boolean enterpriseOption,
                                    String entityGUID,
                                    int depth,
                                    String methodName)
                             throws RepositoryErrorException,
                                    InvalidParameterException,
                                    EntityNotKnownException,
                                    EntityProxyOnlyException,
                                    UserNotAuthorizedException,
                                    TypeErrorException,
                                    PropertyErrorException,
                                    FunctionNotSupportedException

Retrieve the neighborhood surrounding an entity for pre-traversal.

Parameters:

userId - userId under which the request is performed

repositoryServerName - The name of the repository server to interrogate

repositoryServerURLRoot - The URL root of the repository server to interrogate

enterpriseOption - Whether the query is at cohort level or server specific

entityGUID - the identity of the entity from which to traverse

depth - the depth to which the method should traverse

methodName - The name of the method being invoked

Returns:

a RexTraversal object containing the neighborhood information Exceptions returned by the server

Throws:

InvalidParameterException - a parameter is invalid or null.

TypeErrorException - the type guid passed on the request is not known by the metadata collection.

EntityNotKnownException - the specified start entity could not be found

EntityProxyOnlyException - the specified start entity could not be found

RepositoryErrorException - there is a problem communicating with the metadata repository where the metadata collection is stored.

PropertyErrorException - the sequencing property specified is not valid for any of the requested types of entity.

FunctionNotSupportedException - the repository does not support the operation with the provided parameters.

UserNotAuthorizedException - the userId is not permitted to perform this operation.

traversal

public RexTraversal traversal(String userId,
                              String repositoryServerName,
                              String repositoryServerURLRoot,
                              boolean enterpriseOption,
                              String entityGUID,
                              int depth,
                              List<String> entityTypeGUIDs,
                              List<String> relationshipTypeGUIDs,
                              List<String> classificationNames,
                              String methodName)
                       throws RepositoryErrorException,
                              InvalidParameterException,
                              EntityNotKnownException,
                              EntityProxyOnlyException,
                              UserNotAuthorizedException,
                              TypeErrorException,
                              PropertyErrorException,
                              FunctionNotSupportedException

Retrieve the neighborhood surrounding an entity.

Parameters:

userId - userId under which the request is performed

repositoryServerName - The name of the repository server to interrogate

repositoryServerURLRoot - The URL root of the repository server to interrogate

enterpriseOption - Whether the query is at cohort level or server specific

entityGUID - the identity of the entity from which to traverse

depth - the depth to which the method should traverse

entityTypeGUIDs - the GUIDs of entity types to filter the neighborhood

relationshipTypeGUIDs - the GUIDs of relationship types to filter the neighborhood

classificationNames - the names of classification types to filter the neighborhood

methodName - The name of the method being invoked

Returns:

a RexTraversal object containing the neighborhood information Exceptions returned by the server

Throws:

InvalidParameterException - a parameter is invalid or null.

TypeErrorException - the type guid passed on the request is not known by the metadata collection.

EntityNotKnownException - the specified start entity could not be found

EntityProxyOnlyException - the specified start entity could not be found

RepositoryErrorException - there is a problem communicating with the metadata repository where the metadata collection is stored.

PropertyErrorException - the sequencing property specified is not valid for any of the requested types of entity.

FunctionNotSupportedException - the repository does not support the operation with the provided parameters.

UserNotAuthorizedException - the userId is not permitted to perform this operation.