Class EngineClientFactory


  • public class EngineClientFactory
    extends java.lang.Object
    EngineClientFactory is a factory for classes that implement Apama messaging or correlator management interfaces.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static EngineClientInterface createEngineClient()
      Create a new EngineClientInterface instance that enables a client process to connect to an engine to send/receive events or perform management operations such as inject and delete.
      static EngineClientInterface createEngineClient​(java.lang.String host, int port, java.lang.String processName)
      Create a new EngineClientInterface instance that enables a client process to connect to an engine to send/receive events or perform management operations such as inject and delete.
      static EngineClientInterface createEngineClient​(java.lang.String host, int port, java.lang.String processName, boolean disconnectSlowReceiver)
      Create a new EngineClientInterface instance that enables a client process to connect to an engine to send/receive events or perform management operations such as inject and delete.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • createEngineClient

        public static EngineClientInterface createEngineClient()
                                                        throws EngineException
        Create a new EngineClientInterface instance that enables a client process to connect to an engine to send/receive events or perform management operations such as inject and delete. The engine client will initially use the local host and default port, unless these are changed before connection.
        Returns:
        A new EngineClientInterface instance
        Throws:
        EngineException
      • createEngineClient

        public static EngineClientInterface createEngineClient​(java.lang.String host,
                                                               int port,
                                                               java.lang.String processName)
                                                        throws EngineException
        Create a new EngineClientInterface instance that enables a client process to connect to an engine to send/receive events or perform management operations such as inject and delete. The engine client will initially use the specified host, port and process name.
        Parameters:
        host - The host name connect to
        port - The port to connect to
        processName - An optional string identifying this process to the engine
        Returns:
        A new EngineClientInterface instance
        Throws:
        EngineException
      • createEngineClient

        public static EngineClientInterface createEngineClient​(java.lang.String host,
                                                               int port,
                                                               java.lang.String processName,
                                                               boolean disconnectSlowReceiver)
                                                        throws EngineException
        Create a new EngineClientInterface instance that enables a client process to connect to an engine to send/receive events or perform management operations such as inject and delete. The engine client will initially use the specified host, port and process name.
        Parameters:
        host - The host name connect to
        port - The port to connect to
        processName - An optional string identifying this process to the engine
        disconnectSlowReceiver - Disconnect any receiver if it is slow
        Returns:
        A new EngineClientInterface instance
        Throws:
        CompoundException
        EngineException