Class NSLookup

java.lang.Object
com.tangosol.discovery.NSLookup
public class NSLookup extends Object
NSLookup is a helper class for performing lookup from the Coherence NameService.

This helper class has no dependency on any other Coherence class and can be used to perform NameService lookup without requiring coherence jar.

List of Service Endpoints registered in NameService

Here is an example using the NSLookup class for JMX query, assuming cluster running on local host with cluster port of 7574. 

   JMXServiceURL         jmxServiceURL = NSLookup.lookupJMXServiceURL(new InetSocketAddress("127.0.0.1", 7574));
   JMXConnector          jmxConnector  = JMXConnectorFactory.connect(jmxServiceURL, null);
   MBeanServerConnection conn          = jmxConnector.getMBeanServerConnection();
   System.out.println(conn.queryNames(new javax.management.ObjectName("Coherence:type=Cluster,*"), null));

Since:
12.2.1
Author:
bb 2014.04.24

  • Field Details

  • Constructor Details

    • NSLookup

      public NSLookup()

  • Method Details

    • lookupJMXServiceURL

      public static JMXServiceURL lookupJMXServiceURL(SocketAddress socketAddr) throws IOException
      Lookup the current management node mbean connector url.
      Parameters:
      socketAddr - unicast socket address of a coherence cluster node and cluster port
      Returns:
      JMXServiceURL for the management node
      Throws:
      IOException - if an I/O error occurs while doing the JMXServiceURL lookup

    • lookupJMXServiceURL

      public static JMXServiceURL lookupJMXServiceURL(String sCluster, SocketAddress socketAddr) throws IOException
      Lookup the current management node mbean connector url.
      Parameters:
      sCluster - the target cluster
      socketAddr - unicast socket address of a coherence cluster node and cluster port
      Returns:
      JMXServiceURL for the management node
      Throws:
      IOException - if an I/O error occurs while doing the JMXServiceURL lookup

    • lookupHTTPManagementURL

      public static Collection<URL> lookupHTTPManagementURL(SocketAddress socketAddr) throws IOException
      Lookup the current management HTTP connector URL.
      Parameters:
      socketAddr - unicast socket address of a coherence cluster node and cluster port
      Returns:
      a collection of URLs which can be used to access an HTTP management service
      Throws:
      IOException - if an I/O error occurs while doing the URL lookup
      Since:
      12.2.1.4.0

    • lookupHTTPManagementURL

      public static Collection<URL> lookupHTTPManagementURL(String sCluster, SocketAddress socketAddr) throws IOException
      Lookup the current management HTTP connector URL.
      Parameters:
      sCluster - the target cluster
      socketAddr - unicast socket address of a coherence cluster node and cluster port
      Returns:
      a collection of URLs which can be used to access an HTTP management service
      Throws:
      IOException - if an I/O error occurs while doing the URL lookup
      Since:
      12.2.1.4.0

    • lookupHTTPMetricsURL

      public static Collection<URL> lookupHTTPMetricsURL(SocketAddress socketAddr) throws IOException
      Lookup the current metrics HTTP connector URLs for current cluster.
      Parameters:
      socketAddr - unicast socket address of a coherence cluster node and cluster port
      Returns:
      a collection of URLs which can be used to access a HTTP metrics endpoints
      Throws:
      IOException - if an I/O error occurs while doing the URL lookup
      Since:
      12.2.1.4.0

    • lookupHTTPMetricsURL

      public static Collection<URL> lookupHTTPMetricsURL(String sCluster, SocketAddress socketAddr) throws IOException
      Lookup the current metrics HTTP connector URLs for a specified cluster.
      Parameters:
      sCluster - the target cluster
      socketAddr - unicast socket address of a coherence cluster node and cluster port
      Returns:
      a collection of URLs which can be used to access a HTTP metrics endpoint
      Throws:
      IOException - if an I/O error occurs while doing the URL lookup
      Since:
      12.2.1.4.0

    • lookupHTTPHealthURL

      public static Collection<URL> lookupHTTPHealthURL(SocketAddress socketAddr) throws IOException
      Lookup the current health check HTTP connector URLs for current cluster.
      Parameters:
      socketAddr - unicast socket address of a coherence cluster node and cluster port
      Returns:
      a collection of URLs which can be used to access a HTTP health check endpoints
      Throws:
      IOException - if an I/O error occurs while doing the URL lookup
      Since:
      22.06

    • lookupHTTPHealthURL

      public static Collection<URL> lookupHTTPHealthURL(String sCluster, SocketAddress socketAddr) throws IOException
      Lookup the current health check HTTP connector URLs for a specified cluster.
      Parameters:
      sCluster - the target cluster
      socketAddr - unicast socket address of a coherence cluster node and cluster port
      Returns:
      a collection of URLs which can be used to access a HTTP health check endpoint
      Throws:
      IOException - if an I/O error occurs while doing the URL lookup
      Since:
      22.06

    • lookupGrpcProxy

      public static Collection<SocketAddress> lookupGrpcProxy(SocketAddress socketAddr) throws IOException
      Lookup the Grpc Proxy service socket address(es)
      Parameters:
      socketAddr - unicast socket address of a coherence cluster node and cluster port
      Returns:
      a collection of SocketAddress which can be used to access a proxy endpoints in the target cluster
      Throws:
      IOException - if an I/O error occurs while doing the URL lookup
      Since:
      22.06.2

    • lookupGrpcProxy

      public static Collection<SocketAddress> lookupGrpcProxy(String sCluster, SocketAddress socketAddr) throws IOException
      Lookup the Grpc Proxy socket address(es) for a specified cluster.
      Parameters:
      sCluster - the target cluster name
      socketAddr - unicast socket address of a coherence cluster node and cluster port
      Returns:
      a collection of SocketAddress which can be used to access grpc proxy endpoints in the target cluster
      Throws:
      IOException - if an I/O error occurs while doing the URL lookup
      Since:
      22.06.2

    • lookupExtendProxy

      public static Collection<SocketAddress> lookupExtendProxy(SocketAddress socketAddr, String sName) throws IOException
      Lookup the extend proxy service SocketAddress(es) for current cluster.
      Parameters:
      socketAddr - unicast socket address of a coherence cluster node and cluster port
      sName - proxy service name, must be fully scoped service name when application scoping is enabled
      Returns:
      a collection of socket address(es) which can be used to access extend client proxy's endpoint(s)
      Throws:
      IOException - if an I/O error occurs while doing the extend client proxy service lookup
      Since:
      24.09

    • lookupExtendProxy

      public static Collection<SocketAddress> lookupExtendProxy(String sCluster, SocketAddress socketAddr, String sName) throws IOException
      Lookup the extend proxy service SocketAddress(es) for specified cluster.
      Parameters:
      sCluster - the target cluster name
      socketAddr - unicast socket address of a coherence cluster node and cluster port
      sName - proxy service name, must be fully scoped service name when application scoping is enabled
      Returns:
      a collection of socket addresses which can be used to access extend proxy endpoints in the target cluster
      Throws:
      IOException - if an I/O error occurs while doing the extend client proxy service lookup
      Since:
      24.09

    • lookup

      public static String lookup(String sName, SocketAddress socketAddr, int cTimeOutMillis) throws IOException
      Lookup the given name from the NameService. The object bound to the NameService should be a String.

      The sName parameter string consists of "NameService/string/" followed by one of the following:

      • service name when application scoping is not enabled
      • a fully scoped service name, i.e application-scope-name:proxy-service-name

      Parameters:
      sName - name service name, syntax provided above
      socketAddr - unicast socket address of a coherence cluster node and the cluster port
      cTimeOutMillis - timeout in millis
      Returns:
      String bound to the NameService with the given name
      Throws:
      IOException - if an I/O error occurs while doing the lookup

    • lookup

      public static String lookup(String sCluster, String sName, SocketAddress socketAddr, int cTimeOutMillis) throws IOException
      Lookup the given name from the NameService. The object bound to the NameService should be a String.

      The sName parameter string consists of "NameService/string/" followed by one of the following:

      • service name when application scoping is not enabled
      • a fully scoped service name, i.e application-scope-name:proxy-service-name

      Parameters:
      sCluster - target cluster name
      sName - name service name, syntax provided above
      socketAddr - unicast socket address of a coherence cluster node and cluster port
      cTimeOutMillis - timeout in millis
      Returns:
      String bound to the NameService with the given name
      Throws:
      IOException - if an I/O error occurs while doing the lookup

    • write

      protected static void write(DataOutputStream outStream, byte[] ab) throws IOException
      Write length encoded message.
      Parameters:
      outStream - socket output stream
      ab - message byte[] to write
      Throws:
      IOException - if an I/O error occurs while writing to the socket stream

    • read

      protected static byte[] read(DataInputStream inStream) throws IOException
      Read length encoded message.
      Parameters:
      inStream - socket input stream
      Returns:
      message byte[]
      Throws:
      IOException - if an I/O error occurs while reading from the socket stream

    • writePackedInt

      protected static void writePackedInt(DataOutputStream outStream, int n) throws IOException
      Write packed int.
      Parameters:
      outStream - socket output stream
      n - int to write
      Throws:
      IOException - if an I/O error occurs while writing to the socket stream

    • readPackedInt

      protected static int readPackedInt(DataInputStream inStream) throws IOException
      Read packed int.
      Parameters:
      inStream - socket input stream
      Returns:
      int read
      Throws:
      IOException - if an I/O error occurs while reading from the socket stream

    • validateCommand

      protected static String validateCommand(String sCommand, String[] asCommand, boolean fCaseSens)
      Validate a command parameter.
      Parameters:
      sCommand - the parameter to be validated
      asCommand - valid command parameter array
      fCaseSens - a flag to indicate if the parameter is case sensitive

    • parseArguments

      public static LinkedHashMap parseArguments(String[] asArg, String[] asCommand, boolean fCaseSens)
      Parses the array of arguments into a map. Assume that a java tool starts by command line having the following syntax: cmd-line ::== (command space)* (argument space)* command ::== "-" cmd-name ("=" | ":" | space) (cmd-value)? cmd-name ::== word cmd-value ::== word ("," word)* argument ::== word ("," word)* space ::== (" ")+ When java starts an application the arguments in the command line are placed into a string array by breaking at spaces. The purpose of this method is to place the command line into a LinkedHashMap where each <command> would represent an entry in this map with values equal to <cmd-value> (null if not present) and each <argument> represented with an entry that has the key equal to an Integer object holding on the 0-based argument number and the value equal to the argument itself.
      Parameters:
      asArg - an array of arguments from "public static main(String[])"
      asCommand - an array of valid commands (if null, anything is allowed)
      fCaseSens - if true, uses the commands the way they are typed in; if false, converts all the commands to lowercase.
      Returns:
      a map of arguments with their corresponding values
      Throws:
      IllegalArgumentException - if the syntax is unexpected or an invalid command has been encountered; a caller is supposed to output the "Usage: ... " message if this exception is thrown.

    • datagramLookupRaw

      public static void datagramLookupRaw(String sCluster, String sName, InetSocketAddress addrGroup, InetAddress addrLocal, int cTimeoutMillis, int nTTL, byte[] abMemberClient, NSLookup.BiConsumer<String, DataInputStream> consumerResult) throws IOException
      Lookup a name via UDP (generally multicast).
      Parameters:
      sCluster - the cluster of address
      sName - the name to lookup
      addrGroup - the cluster address
      addrLocal - the NIC to use
      cTimeoutMillis - the discovery timeout
      nTTL - the multicast TTL
      abMemberClient - optional serialized Member object representing the client
      consumerResult - the consumer for results
      Throws:
      IOException

    • datagramLookupRaw

      public static DataInputStream datagramLookupRaw(String sCluster, String sName, InetSocketAddress addrGroup, InetAddress addrLocal, int cTimeoutMillis, int nTTL, byte[] abMemberClient) throws IOException
      Lookup a name via UDP (generally multicast).
      Parameters:
      sCluster - the cluster of address
      sName - the name to lookup
      addrGroup - the cluster address
      addrLocal - the NIC to use
      cTimeoutMillis - the discovery timeout
      nTTL - the multicast TTL
      abMemberClient - optional serialized Member object representing the client
      Throws:
      IOException

    • datagramLookup

      public static void datagramLookup(String sCluster, String sName, InetSocketAddress addrGroup, InetAddress addrLocal, int cTimeoutMillis, int nTTL, byte[] abMemberClient, NSLookup.BiConsumer<String,String> consumerResult) throws IOException
      Lookup a name via UDP (generally multicast) and consume the result as a string.
      Parameters:
      sCluster - the cluster of address
      sName - the name to lookup
      addrGroup - the cluster address
      addrLocal - the NIC to use
      cTimeoutMillis - the discovery timeout
      nTTL - the multicast TTL
      abMemberClient - optional serialized Member object representing the client
      consumerResult - the consumer for results
      Throws:
      IOException

    • readString

      public static String readString(DataInputStream in)
      Read a String from a stream
      Parameters:
      in - a DataInputStream containing the result
      Returns:
      the String

    • main

      public static void main(String[] asArg) throws IOException
      Parse and validate the command-line parameters and do the lookup.
      Parameters:
      asArg - an array of command line parameters
      Throws:
      IOException - if an I/O error occurs while doing the lookup

    • showInstructions

      protected static void showInstructions()
      Display the command-line instructions.

    • validateName

      protected static String validateName(String sName)
      Descriptive error feedback for a failed lookup of provided -name parameter.
      Parameters:
      sName - value passed to -name argument
      Returns:
      null if no feedback or descriptive feedback

    • reportNameWarning

      protected static void reportNameWarning(String sName)
      Reports -name parameter warning when appropriate to standard error.
      Parameters:
      sName - Name Service looked up