Package org.odpi.openmetadata.accessservices.stewardshipaction.client

Class StewardshipActionEventClient

java.lang.Object

org.odpi.openmetadata.accessservices.stewardshipaction.client.StewardshipActionEventClient

All Implemented Interfaces:

StewardshipActionEventInterface

public class StewardshipActionEventClient
extends Object
implements StewardshipActionEventInterface

StewardshipActionEventClient provides the implementation to manage the interaction with the server to set up a listener to support the receipt of inbound events from the Stewardship Action OMAS Out Topic.

Constructor Summary

Constructors

Constructor	Description
StewardshipActionEventClient(String serverName, String serverPlatformURLRoot, String serverUserId, String serverPassword, int maxPageSize, AuditLog auditLog, String callerId)	Create a new client that is to be used within an OMAG Server.

Method Summary

Modifier and Type	Method	Description
String	getConfigurationServerName()	Return the name of the server where configuration is supposed to be stored.
void	registerListener(String userId, StewardshipActionEventListener listener)	Register a listener object that will be passed each of the events published by the Stewardship Action OMAS.

Methods inherited from class java.lang.Object

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

Constructor Detail

StewardshipActionEventClient

public StewardshipActionEventClient(String serverName,
                                    String serverPlatformURLRoot,
                                    String serverUserId,
                                    String serverPassword,
                                    int maxPageSize,
                                    AuditLog auditLog,
                                    String callerId)
                             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 servers

serverUserId - this server's userId

serverPassword - this server's userId

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

callerId - unique identifier of the caller

Throws:

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

Method Detail

getConfigurationServerName

public String getConfigurationServerName()

Return the name of the server where configuration is supposed to be stored.

Returns:

server name

registerListener

public void registerListener(String userId,
                             StewardshipActionEventListener listener)
                      throws InvalidParameterException,
                             ConnectionCheckedException,
                             ConnectorCheckedException,
                             PropertyServerException,
                             UserNotAuthorizedException

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

Specified by:

registerListener in interface StewardshipActionEventInterface

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.

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

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