Package COM.TIBCO.hawk.console.hawkeye

Class TIBHawkConsoleFactory

java.lang.Object

COM.TIBCO.hawk.console.hawkeye.TIBHawkConsoleFactory

public class TIBHawkConsoleFactory
extends Object

This class provides an instance of HAWK Console application, based on the configured properties.

Constructor Summary

Constructors

Constructor	Description
TIBHawkConsoleFactory()

Method Summary

Modifier and Type	Method	Description
TIBHawkConsole	createHawkConsole(Map props)	Create a new HawkConsole with given properties
static TIBHawkConsoleFactory	getInstance()	To get an instance of TIBHawkConsoleFactory class.

Methods inherited from class java.lang.Object

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

Constructor Details

TIBHawkConsoleFactory

public TIBHawkConsoleFactory()

Method Details

getInstance

public static TIBHawkConsoleFactory getInstance()

To get an instance of TIBHawkConsoleFactory class.

Returns:

An instance of TIBHawkConsoleFactory class

Since:

5.0

createHawkConsole

public TIBHawkConsole createHawkConsole(Map props)
                                 throws ConsoleInitializationException,
UnsupportedEncodingException

Create a new HawkConsole with given properties

Parameters:

props - 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

Returns:

Throws:

ConsoleInitializationException

UnsupportedEncodingException

Since:

5.0