Package org.odpi.openmetadata.accessservices.communityprofile.client

Class CommunityProfileEventClient

java.lang.Object
org.odpi.openmetadata.accessservices.communityprofile.client.CommunityProfileEventClient
All Implemented Interfaces:
org.odpi.openmetadata.accessservices.communityprofile.api.CommunityProfileEventInterface
public class CommunityProfileEventClient extends Object implements org.odpi.openmetadata.accessservices.communityprofile.api.CommunityProfileEventInterface
CommunityProfileEventClient provides the implementation to manage the interaction with the server to set up a listener to support the receipt of inbound events from the Data Manager OMAS Out Topic.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommunityProfileEventClient(String serverName, String serverPlatformURLRoot, String callerId)
    Create a new client with no authentication embedded in the HTTP request.
    CommunityProfileEventClient(String serverName, String serverPlatformURLRoot, String userId, String password, String callerId)
    Create a new client that passes userId and password in each HTTP request.
    CommunityProfileEventClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.OCFRESTClient restClient, int maxPageSize, org.odpi.openmetadata.frameworks.auditlog.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, org.odpi.openmetadata.accessservices.communityprofile.api.CommunityProfileEventListener listener)
    Register a listener object that will be passed each of the events published by the Data Manager OMAS.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CommunityProfileEventClient

      public CommunityProfileEventClient(String serverName, String serverPlatformURLRoot, String callerId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.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
      callerId - unique identifier of the caller
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • CommunityProfileEventClient

      public CommunityProfileEventClient(String serverName, String serverPlatformURLRoot, String userId, String password, String callerId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.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
      callerId - unique identifier of the caller
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • CommunityProfileEventClient

      public CommunityProfileEventClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.OCFRESTClient restClient, int maxPageSize, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog, String callerId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.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
      callerId - unique identifier of the caller
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem with the information about the remote OMAS

  • Method Details

    • 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, org.odpi.openmetadata.accessservices.communityprofile.api.CommunityProfileEventListener listener) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Register a listener object that will be passed each of the events published by the Data Manager OMAS.
      Specified by:
      registerListener in interface org.odpi.openmetadata.accessservices.communityprofile.api.CommunityProfileEventInterface
      Parameters:
      userId - calling user
      listener - listener object
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.