Package COM.TIBCO.hawk.console.hawkeye

Class TIBHawkConsole

java.lang.Object
COM.TIBCO.hawk.console.hawkeye.TIBHawkConsole
public class TIBHawkConsole extends Object
The TIBHawkConsole provides access to services that can be used for monitoring and management of TIB/Hawk agent events.

  • Field Details

    • licence

      protected String licence

    • domain

      protected String domain

    • service

      protected String service

    • network

      protected String network

    • daemon

      protected String daemon

    • agentMonitor

      protected AgentMonitor agentMonitor

    • agentManager

      protected AgentManager agentManager

    • characterEncoding

      protected String characterEncoding

    • provider

      protected COM.TIBCO.hawk.console.hawkeye.Provider provider

  • Constructor Details

    • TIBHawkConsole

      @Deprecated public TIBHawkConsole(String hawkDomain, String rvService, String rvNetwork, String rvDaemon)
      Deprecated.
      As of Hawk 5.0, instead use TIBHawkConsoleFactory to construct TIBHawkConsole
      Constructs a TIBHawkConsole object.

      The parameters are used to set up the console's communications channels. The hawkDomain and rvService parameters must be the same as the hawk domain and TIB/Rendezvous service configuration parameters used by the agents in order to communicate with them.

      Parameters:
      hawkDomain - The hawk domain on which to communicate
      rvService - The TIB/Rendezvous service parameter to use for console communication. See the TIB/Rendezvous documentation for more information.
      rvNetwork - The TIB/Rendezvous network parameter to use for console communication. See the TIB/Rendezvous documentation for more information.
      rvDaemon - The TIB/Rendezvous daemon parameter to use for console communication. See the TIB/Rendezvous documentation for more information.
      See Also:

    • TIBHawkConsole

      @Deprecated public TIBHawkConsole(String licenseFile, String hawkDomain, String rvService, String rvNetwork, String rvDaemon)
      Deprecated.
      As of TIB/Hawk version 3.1.0, instead use TIBHawkConsoleFactory to construct TIBHawkConsole
      Constructs a TIBHawkConsole object.
      See Also:

    • TIBHawkConsole

      @Deprecated public TIBHawkConsole(String hawkDomain, String serverURL, String userName, String password, Hashtable environment)
      Deprecated.
      As of Hawk version 5.0, instead use TIBHawkConsoleFactory to construct TIBHawkConsole
      Constructs a TIBHawkConsole object. This constructor allows the TIBHawkConsole to connect to a TIBrvJMSTransport. See the TIBCO Enterprise for JMS documentation for more information about TIBrvJMSTransport and the paremeters to this constructor.

      Parameters:
      hawkDomain - The hawk domain on which to communicate
      serverURL -
      userName -
      password -
      environment - The SSL parameters for EMS transport
      See Also:

    • TIBHawkConsole

      @Deprecated public TIBHawkConsole(String hawkDomain, String serverURL, String userName, String password, int mode)
      Deprecated.
      As of TIB/Hawk version 4.6.0, instead use TIBHawkConsoleFactory to construct TIBHawkConsole
      Constructs a TIBHawkConsole object. This constructor allows the TIBHawkConsole to connect to a TIBrvJMSTransport. See the TIBCO Enterprise for JMS documentation for more information about TIBrvJMSTransport and the paremeters to this constructor.

      Parameters:
      hawkDomain - The hawk domain on which to communicate
      serverURL -
      userName -
      password -
      mode - This parameter is not currently used. You may pass in any int value.
      See Also:

    • TIBHawkConsole

      @Deprecated public TIBHawkConsole(String hawkDomain, String serverURL)
      Deprecated.
      As of Hawk 5.0, instead use TIBHawkConsoleFactory to construct TIBHawkConsole
      Constructs a TIBHawkConsole object. This constructor allows the TIBHawkConsole to connect to a TIBrvJMSTransport. See the TIBCO Enterprise for JMS documentation for more information about TIBrvJMSTransport and the paremeters to this constructor.

      Parameters:
      hawkDomain - The hawk domain on which to communicate
      serverURL -
      See Also:

    • TIBHawkConsole

      @Deprecated public TIBHawkConsole(String hawkDomain, String rvaHost, int rvaPort, int rvaTunnelMode)
      Deprecated.
      As of Hawk 5.0, instead use TIBHawkConsoleFactory to construct TIBHawkConsole
      Constructs a TIBHawkConsole object. This constructor allows the TIBHawkConsole to connect to a TIBrvRvaTransport (RVA). See the TIB/Rendezvous documentation for more information about TIBrvRvaTransport.

      Parameters:
      hawkDomain - The hawk domain on which to communicate
      rvaHost - The TIB/Rendezvous host parameter to use for console communication. To connect to rva on the local computer supply null.
      rvaPort - The TIB/Rendezvous port parameter to use for console communication. To use the default rva port, supply 0.
      rvaTunnelMode - The TIB/Rendezvous tunnelmode parameter to use for console communication. The default value is HTTP_TUNNEL_DISABLE.
      See Also:

    • TIBHawkConsole

      protected TIBHawkConsole(Map config)
      Constructs a TIBHawkConsole object with given properties
      Parameters:
      config - Configuration map can have below keys:
      Property Name Mandatory Default Desciption
      HawkConstants.HAWK_DOMAIN No default The hawk domain
      HawkConstants.HAWK_TRANSPORT No HawkConstants.HAWK_TRANSPORT_TIBRV Choice of transport. Can be one of HawkConstants.HAWK_TRANSPORT_TIBGRPC or HawkConstants.HAWK_TRANSPORT_TIBRV or HawkConstants.HAWK_TRANSPORT_TIBEMS
      Properties when hawk transport is tibgrpc:
      HawkConstants.PROPERTY_GRPC_SESSION_PORT No 9687 Port that the Hawk RedTail Console component container uses to listen to incoming transport request from Hawk agents
      HawkConstants.PROPERTY_GRPC_ENABLE_TLS No false Set to true, if communication needs to happen over TLS protocol
      HawkConstants.PROPERTY_GRPC_SERVER_CERT No null Path of the server certificate for the HawkConsole
      HawkConstants.PROPERTY_GRPC_SERVER_KEY No null Path to HawkConsole private key
      HawkConstants.PROPERTY_GRPC_SERVER_KEY_PASSWORD No null HawkConsole private key password
      HawkConstants.PROPERTY_GRPC_CLIENT_CA No null Path to HawkAgent CA for mutual authentication
      Properties when hawk transport is tibrv:
      HawkConstants.RV_SERVICE No 7500 Rendezvous service name
      HawkConstants.RV_NETWORK No ; Rendezvous Network
      HawkConstants.RV_DAEMON No tcp:7500 Rendezvous Deamon
      Properties when hawk transport is tibems:
      HawkConstants.HAWK_EMS_URL No localhost://7222 EMS server URL
      HawkConstants.HAWK_EMS_USERNAME No null EMS username
      HawkConstants.HAWK_EMS_PWD No null EMS password
      HawkConstants.HAWK_SSL_PARAMS No null A Java Hashtable containing key/values as documented in TIBCO JMS document: com.tibco.tibjms.TibjmsSSL.<prop> and its value
      Since:
      5.0

    • TIBHawkConsole

      public TIBHawkConsole(String hawkDomain, Map props)

  • Method Details

    • getAgentMonitor

      public AgentMonitor getAgentMonitor()
      Returns the agent monitor. The agent monitor may be used to listen to TIB/Hawk agent monitoring events.
      Returns:
      The agent monitor.

    • getAgentManager

      public AgentManager getAgentManager()
      Returns the agent manager. The agent manager may be used to interact with TIB/Hawk agents and their microagents.
      Returns:
      The agent manager.

    • setCharacterEncoding

      public void setCharacterEncoding(String encoding) throws UnsupportedEncodingException
      Sets the character encoding used by the TIBCO Rendezvous daemon See TIBCO Rendezvous documentation
      Throws:
      UnsupportedEncodingException

    • main

      public static void main(String[] args)