CorbaSender.java

  1. package gov.usgs.earthquake.eidsutil;

  3. import com.isti.quakewatch.server.qw_feeder.QWFeeder;
  4. import com.isti.quakewatch.server.qw_feeder.QWFeederHelper;

  6. import org.omg.CORBA.ORB;
  7. //import org.omg.CORBA.Object;
  8. import org.omg.CORBA.ORBPackage.InvalidName;
  9. import org.omg.PortableServer.POA;
  10. import org.omg.PortableServer.POAHelper;
  11. import org.omg.PortableServer.POAManager;
  12. import org.omg.PortableServer.POAManagerPackage.AdapterInactive;

  14. /**
  15.  * A <code>CorbaSender</code> is essentially a client-side wrapper for the
  16.  * <code>QWFeeder</code> IDL file specified by ISTI. This class is designed to
  17.  * provide simplified CORBA interaction with a QWServer (EIDS) machine. All the
  18.  * varied methods of sending messages are provided, however they are wrapped
  19.  * into a single method, namely, <code>sendMessage</code>. See the method
  20.  * documentation for details.
  21.  *
  22.  * @since 0.0.1
  23.  * @author <a href="mailto:emartinez@usgs.gov">Eric Martinez</a>
  24.  */
  25. public class CorbaSender {

  27.     //---------------------------------------------------------------------------
  28.     // Member Variables
  29.     //---------------------------------------------------------------------------

  31.     /** This is the URL used to obtain the underlying QWFeeder object. */
  32.     private String url = null;

  34.     /**
  35.      * This is the underlying <code>QWFeeder</code> used to send the messages to
  36.      * the server. The interface specification can be found in the
  37.      * <code>QWFeeder.idl</code> file from ISTI.
  38.      */
  39.     private QWFeeder feeder = null;

  41.     private ORB orb = null;
  42.     private POA poa = null;
  43.     private POAManager poaManager = null;
  44.     private org.omg.CORBA.Object object = null;

  46.     //---------------------------------------------------------------------------
  47.     // Constructors
  48.     //---------------------------------------------------------------------------

  50.     /**
  51.      * Initializes the <code>CorbaSender</code> such that it is ready to send a
  52.      * message to the specified <code>host</code> over the specified
  53.      * <code>port</code>. This uses the <code>QWFeeder</code> idl specified by
  54.      * ISTI as the underlying feeder. After instantiating a
  55.      * <code>CorbaSender</code> through this constructor, the instance is 100%
  56.      * ready to use. One downside is one cannot reuse that instance to send
  57.      * messages to another host; for such a feature one must instantiate a new
  58.      * object.
  59.      *
  60.      * @param host The host machine (ip or cname) to which you want to send the
  61.      * messages using this <code>CorbaSender</code>.
  62.      * @param port The port number to send messages to on the host.
  63.      *
  64.      * @throws InvalidName If the RootPOA is not aware of the type of object we
  65.      * request from it.
  66.      * @throws AdapterInactive If the poaManager is not active.
  67.      */
  68.     public CorbaSender(String host, String port)
  69.             throws InvalidName, AdapterInactive {

  71.         // Create the corbaloc url
  72.         url = "corbaloc:iiop:1.2@" + host + ":" + port + "/QWFeeder";

  74.         // Initialize the ORB
  75.         orb = ORB.init((new String[0]), null);

  77.         // Get the Root POA
  78.         poa = POAHelper.narrow(orb.resolve_initial_references("RootPOA"));

  80.         // Activate the POAManager
  81.         poaManager = poa.the_POAManager();
  82.         poaManager.activate();

  84.         // Get the generic object reference from the orb
  85.         object = orb.string_to_object(url);

  87.         // Narrow the generic object down to our a QWFeeder
  88.         feeder = QWFeederHelper.narrow(object);

  90.     } // END: constructor CorbaSender

  92.     /** Cleanup */
  93.     public void destroy() {
  94.         try { feeder._release(); } catch (Exception ex) { /* ignore */ }
  95.         try { object._release(); } catch (Exception ex) { /* ignore */ }
  96.         try { orb.shutdown(true); } catch (Exception ex) { /* ignore */ }
  97.         try { orb.destroy(); } catch (Exception ex) { /* ignore */ }

  99.         feeder = null;
  100.         object = null;
  101.         poaManager = null;
  102.         poa = null;
  103.         orb = null;
  104.     }

  106.     /**
  107.      * Retrieve a QWFeeder object associated with this CorbaSender.
  108.      *
  109.      * First checks if the object is "non_existent", and if so re-narrows the object.
  110.      * @return QWFeeder object, or null if unable to narrow.
  111.      */
  112.     protected QWFeeder getFeeder() {
  113.         if (feeder != null) {
  114.             try {
  115.                 if (feeder._non_existent()) {
  116.                     feeder = null;
  117.                     object = null;
  118.                 }
  119.             } catch (org.omg.CORBA.OBJECT_NOT_EXIST e) {
  120.                 // feeder._non_existent throws the OBJECT_NOT_EXIST exception
  121.                 // instead of returning true...
  122.                 feeder = null;
  123.                 object = null;
  124.             }
  125.         }

  127.         if (feeder == null) {
  128.             //recreate the object, must string_to_object AND narrow
  129.             object = orb.string_to_object(url);
  130.             feeder = QWFeederHelper.narrow(object);
  131.         }

  133.         return feeder;
  134.     }

  136.     //---------------------------------------------------------------------------
  137.     // Static Methods
  138.     //---------------------------------------------------------------------------

  140.     /* None at this time. */

  142.     //---------------------------------------------------------------------------
  143.     // Public Methods
  144.     //---------------------------------------------------------------------------

  146.     /**
  147.      * Sends a data event message. If the event data does not begin with a
  148.      * &ldquo;DataMessage&rdquo; XML element then the data will be surrounded
  149.      * with one. The &ldquo;sendSourced...&rdquo; methods are preferred because
  150.      * the feeder-source host name and message number are used for improved
  151.      * message tracking.
  152.      *
  153.      * @param message The data event message string.
  154.      * @return <code>true</code> after the message has been successfully stored
  155.      * and processed; <code>false</code> if an error occurred.
  156.      */
  157.     public boolean sendMessage(String message) {
  158.         return getFeeder().sendMessage(message);
  159.     }

  161.     /**
  162.      * Sends a data event message. If the event data does not begin with a
  163.      * &ldquo;DataMessage&rdquo; XML element then the data will be surrounded
  164.      * with one. The &ldquo;sendSourced...&rdquo; methods are preferred because
  165.      * the feeder-source host name and message number are used for improved
  166.      * message tracking.
  167.      *
  168.      * @param domain The domain name to use.
  169.      * @param type The type name to use.
  170.      * @param message The data event message string.
  171.      *
  172.      * @return <code>true</code> after the message has been successfully stored
  173.      * and processed; <code>false</code> if an error occurred.
  174.      */
  175.     public boolean sendMessage(String domain, String type, String message) {
  176.         return getFeeder().sendDomainTypeMessage(domain, type, message);
  177.     }


  180.     /**
  181.      * Sends a data event message. If the event data does not begin with a
  182.      * &ldquo;DataMessage&rdquo; XML element then the data will be surrounded
  183.      * with one. The &ldquo;sendSourced...&rdquo; methods are preferred because
  184.      * the feeder-source host name and message number are used for improved
  185.      * message tracking.
  186.      *
  187.      * @param domain The domain name to use.
  188.      * @param type The type name to use.
  189.      * @param name The event name to use.
  190.      * @param message The data event message string.
  191.      *
  192.      * @return <code>true</code> after the message has been successfully stored
  193.      * and processed; <code>false</code> if an error occurred.
  194.      */
  195.     public boolean sendMessage(String domain, String type, String name,
  196.             String message) {
  197.         return getFeeder().sendDomainTypeNameMessage(domain, type, name, message);
  198.     }

  200.     /**
  201.      * Sends a data event message. If the event data does not begin with a
  202.      * &ldquo;DataMessage&rdquo; XML element then the data will be surrounded
  203.      * with one. The &ldquo;sendSourced...&rdquo; methods are preferred because
  204.      * the feeder-source host name and message number are used for improved
  205.      * message tracking.
  206.      *
  207.      * @param message The data event message string.
  208.      * @param feederSourceHost The data-source host string for the message.
  209.      * @param feederSrcHostMsgId the message-ID number from the data source
  210.      * (positive value incremented after each message).
  211.      *
  212.      * @return <code>true</code> after the message has been successfully stored
  213.      * and processed; <code>false</code> if an error occurred.
  214.      */
  215.     public boolean sendMessage(String message, String feederSourceHost,
  216.             long feederSrcHostMsgId) {
  217.         return getFeeder().sendSourcedMsg(message, feederSourceHost,
  218.                 feederSrcHostMsgId);
  219.     }

  221.     /**
  222.      * Sends a data event message. If the event data does not begin with a
  223.      * &ldquo;DataMessage&rdquo; XML element then the data will be surrounded
  224.      * with one. The &ldquo;sendSourced...&rdquo; methods are preferred because
  225.      * the feeder-source host name and message number are used for improved
  226.      * message tracking.
  227.      *
  228.      * @param domain The domain name to use.
  229.      * @param type The type name to use.
  230.      * @param message The data event message string.
  231.      * @param feederSourceHost The data-source host string for the message.
  232.      * @param feederSrcHostMsgId The message-ID number from the data source
  233.      * (positive value incremented after each message).
  234.      *
  235.      * @return <code>true</code> after the message has been successfully stored
  236.      * and processed; <code>false</code> if an error occurred.
  237.      */
  238.     public boolean sendMessage(String domain, String type, String message,
  239.             String feederSourceHost, long feederSrcHostMsgId) {
  240.         return getFeeder().sendSourcedDomainTypeMsg(domain, type, message,
  241.                 feederSourceHost, feederSrcHostMsgId);
  242.     }

  244.     /**
  245.      * Sends a data event message. If the event data does not begin with a
  246.      * &ldquo;DataMessage&rdquo; XML element then the data will be surrounded
  247.      * with one. The &ldquo;sendSourced...&rdquo; methods are preferred because
  248.      * the feeder-source host name and message number are used for improved
  249.      * message tracking.
  250.      *
  251.      * @param domain The domain name to use.
  252.      * @param type The type name to use.
  253.      * @param name The event name to use.
  254.      * @param message The data event message string.
  255.      * @param feederSourceHost The data-source host string for the message.
  256.      * @param feederSrcHostMsgId The message-ID number from the data source
  257.      * (positive value incremented after each message).
  258.      *
  259.      * @return <code>true</code> after the message has been successfully stored
  260.      * and processed; <code>false</code> if an error occurred.
  261.      */
  262.     public boolean sendMessage(String domain, String type, String name,
  263.             String message, String feederSourceHost, long feederSrcHostMsgId) {
  264.         return getFeeder().sendSourcedDomainTypeNameMsg(domain, type, name, message,
  265.                 feederSourceHost, feederSrcHostMsgId);
  266.     }

  268.     //---------------------------------------------------------------------------
  269.     // Private Methods
  270.     //---------------------------------------------------------------------------

  272.     /* None at this time. */

  274. } // END: class CorbaSender
Created with JaCoCo 0.8.8.202204050719