Package org.odpi.openmetadata.repositoryservices.clients

Class EnterpriseRepositoryServicesClient

java.lang.Object

org.odpi.openmetadata.repositoryservices.clients.MetadataCollectionServicesClient

org.odpi.openmetadata.repositoryservices.clients.EnterpriseRepositoryServicesClient

All Implemented Interfaces:

AuditLoggingComponent

public class EnterpriseRepositoryServicesClient
extends MetadataCollectionServicesClient

EnterpriseRepositoryServicesClient provides a client interface for calling the enterprise repository services in a remote server.

Field Summary

Fields inherited from class org.odpi.openmetadata.repositoryservices.clients.MetadataCollectionServicesClient

auditLog, invalidParameterHandler, repositoryName, restClient, restURLRoot

Constructor Summary

Constructors

Constructor	Description
EnterpriseRepositoryServicesClient(String serverName, String restURLRoot)	Create a new client with no authentication embedded in the HTTP request.
EnterpriseRepositoryServicesClient(String repositoryName, String restURLRoot, int maxPageSize, String callerId)	Create a new client with no authentication embedded in the HTTP request.
EnterpriseRepositoryServicesClient(String repositoryName, String restURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
EnterpriseRepositoryServicesClient(String repositoryName, String restURLRoot, String userId, String password, int maxPageSize, String callerId)	Create a new client that passes userId and password in each HTTP request.

Method Summary

Modifier and Type	Method	Description
void	disconnectFromEnterpriseTopic()	Disconnect from the topic connector - events will no longer be passed to the registered listeners.
void	registerListener(String userId, OMRSTopicRepositoryEventListener listener)	Register a listener object that will be passed each of the events published by the Asset Manager OMAS.

Methods inherited from class org.odpi.openmetadata.repositoryservices.clients.MetadataCollectionServicesClient

addAttributeTypeDef, addEntity, addEntityProxy, addExternalEntity, addExternalRelationship, addRelationship, addTypeDef, addTypeDefGallery, classifyEntity, classifyEntity, declassifyEntity, deleteAttributeTypeDef, deleteEntity, deleteEntityReferenceCopy, deleteRelationship, deleteRelationshipReferenceCopy, deleteTypeDef, detectAndThrowInvalidParameterException, detectAndThrowRepositoryErrorException, detectAndThrowUserNotAuthorizedException, findAttributeTypeDefsByCategory, findEntities, findEntitiesByClassification, findEntitiesByProperty, findEntitiesByPropertyValue, findRelationships, findRelationshipsByProperty, findRelationshipsByPropertyValue, findTypeDefsByCategory, findTypeDefsByProperty, findTypesByExternalID, findTypesByName, getAllTypes, getAttributeTypeDefByGUID, getAttributeTypeDefByName, getConnectorComponentDescription, getEntityDetail, getEntityDetail, getEntityDetailHistory, getEntityNeighborhood, getEntitySummary, getHomeClassifications, getHomeClassifications, getLinkingEntities, getMetadataCollectionId, getMetadataCollectionId, getRelatedEntities, getRelationship, getRelationship, getRelationshipHistory, getRelationshipsForEntity, getTypeDefByGUID, getTypeDefByName, isEntityKnown, isRelationshipKnown, purgeClassificationReferenceCopy, purgeEntity, purgeEntityReferenceCopy, purgeEntityReferenceCopy, purgeRelationship, purgeRelationshipReferenceCopy, purgeRelationshipReferenceCopy, refreshEntityReferenceCopy, refreshRelationshipReferenceCopy, reHomeEntity, reHomeRelationship, reIdentifyAttributeTypeDef, reIdentifyEntity, reIdentifyRelationship, reIdentifyTypeDef, restoreEntity, restoreRelationship, reTypeEntity, reTypeRelationship, saveClassificationReferenceCopy, saveClassificationReferenceCopy, saveEntityReferenceCopy, saveInstanceReferenceCopies, saveRelationshipReferenceCopy, searchForTypeDefs, setAuditLog, undoEntityUpdate, undoRelationshipUpdate, updateEntityClassification, updateEntityProperties, updateEntityStatus, updateRelationshipProperties, updateRelationshipStatus, updateTypeDef, verifyAttributeTypeDef, verifyTypeDef

Methods inherited from class java.lang.Object

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

Constructor Detail

EnterpriseRepositoryServicesClient

public EnterpriseRepositoryServicesClient(String serverName,
                                          String restURLRoot)
                                   throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

restURLRoot - the network address of the server running the repository services. This is of the form serverURLroot + "/servers/" + serverName.

Throws:

InvalidParameterException - bad input parameters

EnterpriseRepositoryServicesClient

public EnterpriseRepositoryServicesClient(String repositoryName,
                                          String restURLRoot,
                                          String userId,
                                          String password)
                                   throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

repositoryName - name of the server to connect to

restURLRoot - the network address of the server running the repository services. This is of the form serverURLroot + "/servers/" + serverName.

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - bad input parameters

EnterpriseRepositoryServicesClient

public EnterpriseRepositoryServicesClient(String repositoryName,
                                          String restURLRoot,
                                          int maxPageSize,
                                          String callerId)
                                   throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

repositoryName - name of the server to connect to

restURLRoot - the network address of the server running the repository services. This is of the form serverURLroot + "/servers/" + serverName.

maxPageSize - pre-initialized parameter limit

callerId - unique identifier of the caller

Throws:

InvalidParameterException - bad input parameters

EnterpriseRepositoryServicesClient

public EnterpriseRepositoryServicesClient(String repositoryName,
                                          String restURLRoot,
                                          String userId,
                                          String password,
                                          int maxPageSize,
                                          String callerId)
                                   throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

repositoryName - name of the server to connect to

restURLRoot - the network address of the server running the repository services. This is of the form serverURLroot + "/servers/" + serverName.

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - pre-initialized parameter limit

callerId - unique identifier of the caller

Throws:

InvalidParameterException - bad input parameters

Method Detail

registerListener

public void registerListener(String userId,
                             OMRSTopicRepositoryEventListener listener)
                      throws InvalidParameterException,
                             ConnectionCheckedException,
                             ConnectorCheckedException,
                             RepositoryErrorException,
                             UserNotAuthorizedException

Register a listener object that will be passed each of the events published by the Asset Manager OMAS.

Parameters:

userId - calling user

listener - listener object

Throws:

InvalidParameterException - one of the parameters is null or invalid.

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

RepositoryErrorException - there is a problem retrieving information from the property server(s).

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

disconnectFromEnterpriseTopic

public void disconnectFromEnterpriseTopic()
                                   throws ConnectorCheckedException

Disconnect from the topic connector - events will no longer be passed to the registered listeners.

Throws:

ConnectorCheckedException - problem with the topic connector