Package org.odpi.openmetadata.accessservices.assetmanager.client.exchange

Class ExternalAssetManagerClient

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.client.AssetManagerBaseClient

org.odpi.openmetadata.accessservices.assetmanager.client.exchange.ExchangeClientBase

org.odpi.openmetadata.accessservices.assetmanager.client.exchange.ExternalAssetManagerClient

All Implemented Interfaces:

ExternalAssetManagerInterface, ExternalIdentifierManagerInterface

public class ExternalAssetManagerClient
extends ExchangeClientBase
implements ExternalAssetManagerInterface

ExternalAssetManagerClient is the client for setting up the SoftwareServerCapabilities that represent asset managers.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.assetmanager.client.AssetManagerBaseClient

assetManagerGUIDParameterName, assetManagerNameParameterName, invalidParameterHandler, nullRequestBody, openMetadataStoreClient, propertyHelper, restClient, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
ExternalAssetManagerClient(String serverName, String serverPlatformURLRoot, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.
ExternalAssetManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
ExternalAssetManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
ExternalAssetManagerClient(String serverName, String serverPlatformURLRoot, AssetManagerRESTClient restClient, int maxPageSize, AuditLog auditLog)	Create a new client that is to be used within an OMAG Server.
ExternalAssetManagerClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
String	createExternalAssetManager(String userId, AssetManagerProperties assetManagerProperties)	Create information about the external asset manager.
String	getExternalAssetManagerGUID(String userId, String qualifiedName)	Retrieve the unique identifier of the external asset manager from its qualified name.

Methods inherited from class org.odpi.openmetadata.accessservices.assetmanager.client.AssetManagerBaseClient

addExternalIdentifier, clearRelationship, clearRelationship, confirmSynchronization, createFeedbackFromTemplateWithParent, createFeedbackWithParent, createReferenceable, createReferenceableFromTemplate, createReferenceableFromTemplate, createReferenceableFromTemplateWithParent, createReferenceableFromTemplateWithParent, createReferenceableWithParent, getAssetManagerIdentifiersRequestBody, getClassifiedElements, getCorrelationProperties, getCorrelationProperties, getCorrelationProperties, getEffectiveTimeQueryRequestBody, getElementsForExternalIdentifier, getGlossaryTermRelationshipRequestBody, getMetadataCorrelationHeaders, getNameRequestBody, getNameRequestBody, getQualifiedNameRequestBody, getRelatedElements, getRelationshipRequestBody, getSearchStringRequestBody, getUpdateRequestBody, handleMissingScope, removeExternalIdentifier, removeReferenceable, removeReferenceableClassification, setReferenceableClassification, setupRelationship, setupRelationship, updateExternalIdentifier, updateFeedback, updateReferenceable, validateExternalIdentifier

Methods inherited from class java.lang.Object

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

Constructor Details

ExternalAssetManagerClient

public ExternalAssetManagerClient(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog,
 int maxPageSize)
                           throws InvalidParameterException

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

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

auditLog - logging destination

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ExternalAssetManagerClient

public ExternalAssetManagerClient(String serverName,
 String serverPlatformURLRoot,
 int maxPageSize)
                           throws InvalidParameterException

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

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ExternalAssetManagerClient

public ExternalAssetManagerClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 int maxPageSize)
                           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:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ExternalAssetManagerClient

public ExternalAssetManagerClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 AuditLog auditLog,
 int maxPageSize)
                           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:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ExternalAssetManagerClient

public ExternalAssetManagerClient(String serverName,
 String serverPlatformURLRoot,
 AssetManagerRESTClient restClient,
 int maxPageSize,
 AuditLog auditLog)
                           throws InvalidParameterException

Create a new client that is to be used within an OMAG Server.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

restClient - pre-initialized REST client

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem with the information about the remote OMAS

Method Details

createExternalAssetManager

public String createExternalAssetManager(String userId,
 AssetManagerProperties assetManagerProperties)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create information about the external asset manager. This is represented as a software server capability and all information that is specific to the external asset manager (such as the identifiers of the metadata elements it stores) will be linked to it.

Specified by:

createExternalAssetManager in interface ExternalAssetManagerInterface

Parameters:

userId - calling user

assetManagerProperties - description of the integration daemon (specify qualified name at a minimum)

Returns:

unique identifier of the asset management's software server capability

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getExternalAssetManagerGUID

public String getExternalAssetManagerGUID(String userId,
 String qualifiedName)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the unique identifier of the external asset manager from its qualified name. Typically, the qualified name comes from the integration connector configuration.

Specified by:

getExternalAssetManagerGUID in interface ExternalAssetManagerInterface

Parameters:

userId - calling user

qualifiedName - unique name to use for the external asset

Returns:

unique identifier of the external asset manager's software server capability

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server