Package org.odpi.openmetadata.engineservices.archivemanager.client

Class ArchiveManagerClient

java.lang.Object

org.odpi.openmetadata.engineservices.archivemanager.client.ArchiveManagerClient

All Implemented Interfaces:

ArchiveManagerAPI

public class ArchiveManagerClient
extends Object
implements ArchiveManagerAPI

ArchiveManagerClient is a client-side library for calling a specific archive engine with an engine host server.

Constructor Summary

Constructors

Constructor	Description
ArchiveManagerClient(String serverPlatformRootURL, String serverName, String archiveEngineName)	Create a client-side object for calling a archive engine.
ArchiveManagerClient(String serverPlatformRootURL, String serverName, String archiveEngineName, String userId, String password)	Create a client-side object for calling a archive engine.

Method Summary

Modifier and Type	Method	Description
ConnectorType	validateConnector(String userId, String connectorProviderClassName)	Validate the connector and return its connector type.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveManagerClient

public ArchiveManagerClient(String serverPlatformRootURL,
                            String serverName,
                            String archiveEngineName)
                     throws InvalidParameterException

Create a client-side object for calling a archive engine.

Parameters:

serverPlatformRootURL - the root url of the platform where the archive engine is running.

serverName - the name of the engine host server where the archive engine is running

archiveEngineName - the unique name of the archive engine.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

ArchiveManagerClient

public ArchiveManagerClient(String serverPlatformRootURL,
                            String serverName,
                            String archiveEngineName,
                            String userId,
                            String password)
                     throws InvalidParameterException

Create a client-side object for calling a archive engine.

Parameters:

serverPlatformRootURL - the root url of the platform where the archive engine is running.

serverName - the name of the engine host server where the archive engine is running

archiveEngineName - the unique name of the archive engine.

userId - user id for the HTTP request

password - password for the HTTP request

Throws:

InvalidParameterException - one of the parameters is null or invalid.

Method Detail

validateConnector

public ConnectorType validateConnector(String userId,
                                       String connectorProviderClassName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Validate the connector and return its connector type.

Specified by:

validateConnector in interface ArchiveManagerAPI

Parameters:

userId - calling user

connectorProviderClassName - name of a specific connector or null for all connectors

Returns:

connector type for this connector

Throws:

InvalidParameterException - the connector provider class name is not a valid connector fo this service

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - there was a problem detected by the integration service