Package org.odpi.openmetadata.engineservices.watchdogaction.client

Class WatchdogActionClient

java.lang.Object

org.odpi.openmetadata.engineservices.watchdogaction.client.WatchdogActionClient

All Implemented Interfaces:

WatchdogActionAPI

public class WatchdogActionClient
extends Object
implements WatchdogActionAPI

WatchdogActionClient is a client-side library for calling a specific watchdog action engine with an engine host server.

Constructor Summary

Constructors

Constructor	Description
WatchdogActionClient(String serverPlatformRootURL, String serverName, String watchdogActionEngineName)	Create a client-side object for calling a watchdog action engine.
WatchdogActionClient(String serverPlatformRootURL, String serverName, String watchdogActionEngineName, String userId, String password)	Create a client-side object for calling a watchdog action engine.

Method Summary

Modifier and Type	Method	Description
ConnectorReport	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 Details

WatchdogActionClient

public WatchdogActionClient(String serverPlatformRootURL,
 String serverName,
 String watchdogActionEngineName)
                     throws InvalidParameterException

Create a client-side object for calling a watchdog action engine.

Parameters:

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

serverName - the name of the engine host server where the watchdog action engine is running

watchdogActionEngineName - the unique name of the watchdog action engine.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

WatchdogActionClient

public WatchdogActionClient(String serverPlatformRootURL,
 String serverName,
 String watchdogActionEngineName,
 String userId,
 String password)
                     throws InvalidParameterException

Create a client-side object for calling a watchdog action engine.

Parameters:

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

serverName - the name of the engine host server where the watchdog action engine is running

watchdogActionEngineName - the unique name of the watchdog action 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 Details

validateConnector

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

Validate the connector and return its connector type.

Specified by:

validateConnector in interface WatchdogActionAPI

Parameters:

userId - calling user

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

Returns:

connector report 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