Scripting Interfaces: NB Host Objects

NaradaBroker

Setup Instructions

• Use HPSEARCH_HOME/bin/runBrokerInstantiatorService.(bat/sh) to start the service frontend on the machines where the service needs to run.
• This service instance can be used to create multiple brokers on the same host but running on different configurations.

API

• create(String configFile, String serviceConfig)
  Creates a new BrokerNode. Optionally you can specify a different Config file. If blank specified, the default NB_HOME/configBrokerConfiguration.txt file is used. Secvice Confguration file is required for some newer features in NB. If not specified the default NB_HOME/config/ServiceConfiguration.txt is used
  E.g.
  x = new NaradaBroker("http://156.56.104.139:17070/");
brokId = x.create("C:\\Home\\NaradaBrokering-0.99-rc4\\config\\Broker-II-Configuration.txt", "C:\\Home\\NaradaBrokering-0.99-rc4\\config\\ServiceConfiguration.txt");
• connectTo(String brokerId, String host, int port, String protocol, String alternate_ConfigFile)
  Connects to an existing Broker. The various parameters are as follows.
  • brokerId - Identifies the source broker from where the connection is to be initiated
  • host - Host on which the destination broker to connnect to is running
  • port - Port on which the destination broker to connnect to is listening
  • protocol - Protocol to use. NB supports t (TCP), U(udp), ptcp(Parallel TCP), niotcp(Non Blocking IO TCP) etc... Complete list may be found on NB web-site.
  • alternateConfig - Use an alternate configuration file. Ususally pass an empty string
  On successful completion of the call, a linkID of the created link is returned which can be used for subsequent calls such as while removing the link
  E.g.
  link = x.connectTo(brokId, "156.56.104.139", "5045", "t", "");
• requestNodeAddress(String brokerID, String linkID, int linkLevel)
  Requests a node address for the currently created node if this node has no previously defined node address.
  
  • brokerId - Identifies the source broker
  • linkID - specifies the link (E.g. one obtained from connectTo)
  • linkLevel - specifies if this broker is a cluster, super-cluster etc.
  
  Returns true if the operation was successful, false otherwise
  E.g.
  if(x.requestNodeAddress(brokId, link, "0")) {
  Sys.print("OK");
} else {
  Sys.print("OOPS...");
}
• requestGatewayAddress(String brokerID, String linkID, int linkLevel)
  Requests a gateway address for the currently created node.
  
  • brokerId - Identifies the source broker
  • linkID - specifies the link (E.g. one obtained from connectTo)
  • linkLevel - specifies if this broker is a cluster, super-cluster etc.
  
  Returns true if the operation was successful, false otherwise
  E.g.
  if(x.requestGatewayAddress(brokId, link, "0")) {
  Sys.print("OK");
} else {
  Sys.print("OOPS...");
}
• String[] getLinks(String brokerID)
  Returns an array of string representing the links on the specified broker
  
  • brokerId - Identifies a broker
  
  E.g.
  links = x.getLinks(brokId);
  Thus the links will be in links[0], links[1], ... and so on !
• void removeLink(String brokerID, String linkID)
  Removes the specified link from the specified broker
  
  • brokerId - Identifies a broker
  • linkID - specifies the link (E.g. one obtained from connectTo)
  
  E.g.
  x.removeLink(brokId, links[0]);
• String[] getBrokers()
  Returns an array of string representing the brokers managed by the BrokerInstantiator Service
  
  E.g.
  brokers = x.getBrokers();
  Thus the brokerIDs will be in brokers[0], brokers[1], ... and so on !
• killBroker(String brokerID)
  Shuts down the broker specified by the brokerID
  
  E.g.
  x.killBroker("uuid:12345678-1234-1234-1234-123456789012");
  This gracefully shutsdown the broker with the specified ID!

NOTE: The above commands work only for brokers created with HPSearch's BrokerInstantiatorService

• Sample Commands
• Sample NB Config

(back to Notes)