rjack-qpid-client 0.8.0-java

data/History.rdoc

@@ -0,0 +1,2 @@
+=== 0.8.0 (2011-2-5)
+* Initial release based on Qpid java client 0.8

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.rdoc
+Manifest.txt
+NOTICE.txt
+README.rdoc
+Rakefile
+assembly.xml
+pom.xml
+lib/rjack-qpid-client/base.rb
+lib/rjack-qpid-client.rb
+lib/rjack-qpid-client/qpid_jms_context.rb
+test/test_qpid_client.rb
+lib/rjack-qpid-client/qpid-client-0.8.jar
+lib/rjack-qpid-client/qpid-common-0.8.jar

data/NOTICE.txt

@@ -0,0 +1,7 @@
+rjack-qpid-client gem
+Copyright (c) 2011 David Kellum
+
+This product includes software developed by:
+
+Apache Qpid
+Copyright (c) 2006-2008 Apache Software Foundation

data/README.rdoc

@@ -0,0 +1,42 @@
+= rjack-qpid-client
+
+* http://rjack.rubyforge.org
+* http://rubyforge.org/projects/rjack
+
+== Description
+
+A gem packaging of the {Qpid}[http://qpid.apache.org/] AMQP Java Client.
+
+== License
+
+=== rjack-qpid-client gem
+
+Copyright (c) 2011 David Kellum
+
+Licensed under the Apache License, Version 2.0 (the "License"); you
+may not use this file except in compliance with the License.  You
+may obtain a copy of the License at:
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied.  See the License for the specific language governing
+permissions and limitations under the License.
+
+=== Qpid (java)
+
+Copyright (c) 2006-2008 Apache Software Foundation
+
+Licensed under the Apache License, Version 2.0 (the "License"); you
+may not use this file except in compliance with the License.  You
+may obtain a copy of the License at:
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied.  See the License for the specific language governing
+permissions and limitations under the License.

data/Rakefile

@@ -0,0 +1,51 @@
+# -*- ruby -*-
+
+$LOAD_PATH << './lib'
+require 'rjack-qpid-client/base'
+
+require 'rubygems'
+gem     'rjack-tarpit', '~> 1.3.0'
+require 'rjack-tarpit'
+
+include RJack
+
+t = TarPit.new( 'rjack-qpid-client', QpidClient::VERSION, :java_platform )
+
+t.specify do |h|
+  h.developer( "David Kellum", "dek-oss@gravitext.com" )
+
+  h.extra_deps   += [ [ 'rjack-jms',           '~> 1.0.0'           ],
+                      [ 'rjack-mina',          '~> 1.0.10'          ],
+                      [ 'rjack-slf4j',         '>= 1.5.8',  '< 1.7' ] ]
+
+  h.extra_dev_deps << [ 'rjack-logback',       '>= 0.9.18', '< 2.0' ]
+
+  h.rubyforge_name  = "rjack"
+  h.remote_rdoc_dir = "qpid-client"
+end
+
+t.jars = %w[ common client ].map do |mod|
+  "qpid-#{mod}-#{ QpidClient::QPID_VERSION }.jar"
+end
+
+t.assembly_version = 1.0
+
+file 'Manifest.txt' => [ "lib/#{t.name}/base.rb" ]
+
+task :check_pom_deps do
+  t.test_line_match( 'pom.xml',
+                     %r[<version>#{ QpidClient::QPID_VERSION }</version>] )
+end
+
+task :check_history_version do
+  t.test_line_match( 'History.rdoc', /^==/, / #{t.version} / )
+end
+task :check_history_date do
+  t.test_line_match( 'History.rdoc', /^==/, /\([0-9\-]+\)$/ )
+end
+
+task :gem  => [ :check_pom_deps, :check_history_version                      ]
+task :tag  => [ :check_pom_deps, :check_history_version, :check_history_date ]
+task :push => [                                          :check_history_date ]
+
+t.define_tasks

data/assembly.xml

@@ -0,0 +1,15 @@
+<assembly>
+  <id>bin</id>
+  <formats>
+    <format>dir</format>
+  </formats>
+  <includeBaseDirectory>false</includeBaseDirectory>
+  <dependencySets>
+    <dependencySet>
+      <includes>
+        <include>org.apache.qpid:qpid-common</include>
+        <include>org.apache.qpid:qpid-client</include>
+      </includes>
+    </dependencySet>
+  </dependencySets>
+</assembly>

data/lib/rjack-qpid-client.rb

@@ -0,0 +1,35 @@
+#--
+# Copyright (c) 2011 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You
+# may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+require 'rjack-qpid-client/base'
+
+require 'rjack-jms'
+require 'rjack-mina'
+
+require 'rjack-slf4j'
+require 'rjack-slf4j/jcl-over-slf4j'
+
+require 'rjack-qpid-client/qpid_jms_context'
+
+# QpidClient module
+#
+module RJack
+  module QpidClient
+    %w[ common client ].each do |mod|
+      require "#{LIB_DIR}/qpid-#{mod}-#{QPID_VERSION}.jar"
+    end
+  end
+end

data/lib/rjack-qpid-client/base.rb

@@ -0,0 +1,28 @@
+#--
+# Copyright (c) 2011 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You
+# may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+module RJack
+  module QpidClient
+
+    # QpidClient (java) version
+    QPID_VERSION = '0.8'
+
+    # rjack gem version
+    VERSION = QPID_VERSION + '.0'
+
+    LIB_DIR = File.dirname( __FILE__ ) # :nodoc:
+  end
+end

data/lib/rjack-qpid-client/qpid_jms_context.rb

@@ -0,0 +1,241 @@
+#--
+# Copyright (c) 2011 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+require 'rjack-qpid-client'
+require 'socket'
+require 'rjack-slf4j'
+require 'rjack-jms'
+
+module RJack::QpidClient
+
+  # Implementation of RJack::JMS::JMSContext for Qpid, using the
+  # {Qpid JNDI Properties}[http://qpid.apache.org/books/0.8/Programming-In-Apache-Qpid/html/ch03s02.html]
+  # syntax. Provides scripted setup and a factory for JMS Connection,
+  # Session, and Destinations (including full AMQP queue and exchange
+  # creation) via Qpid
+  # {Addresses}[http://qpid.apache.org/books/0.8/Programming-In-Apache-Qpid/html/ch02s04.html]
+  # created from ruby.
+  class QpidJMSContext
+    include RJack::JMS::JMSContext
+
+    import 'javax.naming.Context'
+    import 'javax.naming.InitialContext'
+    import 'javax.jms.Session'
+
+    # User to connect with (required, often unused by broker,
+    # default: 'qpid')
+    attr_accessor :username
+
+    # Password to connect with (required, often unused by broker.)
+    attr_accessor :password
+
+    # Array of [ host[,port] ] arrays to brokers (default: [['localhost']] )
+    # Default port is 5672.
+    attr_accessor :brokers
+
+    # Connection 'virtualhost' (default: 'default-vhost')
+    # See JNDI Properties, 3.2.2 Connection URLs
+    attr_accessor :virtual_host
+
+    # Connection 'clientid' (default: 'default-client')
+    # See JNDI Properties, 3.2.2 Connection URLs
+    attr_accessor :client_id
+
+    # Connection factory, JNDI name (default: 'local')
+    attr_accessor :factory_jndi_name
+
+    # Acknowledge Mode specified on create_session
+    # (default: javax.jms.Session::AUTO_ACKNOWLEDGE).
+    attr_accessor :session_acknowledge_mode
+
+    # Hash of destination JNDI name to an 'address; options' Hash.
+    # The option hash may use ruby Symbol or String keys, and
+    # true, false, Symbol, String, Hash, or Array values. This will be
+    # serialized into the Qpid
+    # {Addresses}[http://qpid.apache.org/books/0.8/Programming-In-Apache-Qpid/html/ch02s04.html]
+    # Syntax. The special keys :address (default: same as JNDI name)
+    # and :subject (optional address/subject) are also supported when
+    # serializing. (Default: empty)
+    attr_accessor :destinations
+
+    def initialize
+      @username = 'qpid'
+      @password = 'pswd'
+      @brokers = [ [ 'localhost' ] ]
+
+      @virtual_host = 'default-vhost'
+      @client_id    = 'default-client'
+
+      @factory_jndi_name = 'local'
+
+      @session_acknowledge_mode = Session::AUTO_ACKNOWLEDGE
+      @destinations = {}
+      @log = RJack::SLF4J[ self.class ]
+    end
+
+    # The JNDI InitialContext, created on first call, from properties.
+    def context
+      @context ||= InitialContext.new( properties )
+    end
+
+    # The javax.jms.ConnectionFactory, created on first call, by lookup
+    # of factory_jndi_name from context.
+    #
+    # Throws javax.naming.NamingException
+    def connection_factory
+      @con_factory ||= context.lookup( factory_jndi_name )
+    end
+
+    # Creates a new
+    # {javax.jms.Connection}[http://download.oracle.com/javaee/5/api/javax/jms/Connection.html]
+    # from the connection_factory. Caller should close this connection when done with it.
+    #
+    # Throws javax.jms.JMSException, javax.naming.NamingException
+    def create_connection
+      connection_factory.create_connection
+    end
+
+    # Create a
+    # {javax.jms.Session}[http://download.oracle.com/javaee/5/api/javax/jms/Session.html]
+    # from the connection previously obtained via create_connection.
+    #
+    # Throws javax.jms.JMSException
+    def create_session( connection )
+      connection.create_session( false, session_acknowledge_mode )
+    end
+
+    # Lookup (and thus create) a
+    # {javax.jms.Destination}[http://download.oracle.com/javaee/5/api/javax/jms/Destination.html]
+    # by JNDI name as key into destination.  The name and full address
+    # specification is logged at this point.
+    #
+    # Throws javax.naming.NamingException
+    def lookup_destination( name )
+      @log.info( "Lookup of destinations[ '%s' ] =\n    %s" %
+                 [ name,
+                   address_serialize( name, @destinations[ name ] ) ] )
+      context.lookup( name )
+    end
+
+    # Close the JNDI context (no more lookups may be made.)
+    def close
+      @con_factory = nil
+
+      @context.close if @context
+      @context = nil
+    end
+
+    # Qpid JNDI Properties including connection_url and destinations.
+    def properties
+      props = Java::java.util.Hashtable.new
+
+      props[ Context::INITIAL_CONTEXT_FACTORY ] =
+        "org.apache.qpid.jndi.PropertiesFileInitialContextFactory"
+
+      props[ [ "connectionfactory", factory_jndi_name ].join( '.' ) ] =
+        connection_url
+
+      destinations.each_pair do |name,opts|
+        props[ [ "destination", name ].join( '.' ) ] =
+          address_serialize( name, opts )
+      end
+
+      props
+    end
+
+    # Serialize destination
+    # {Addresses}[http://qpid.apache.org/books/0.8/Programming-In-Apache-Qpid/html/ch02s04.html]
+    # (new format). Reference: section 2.4.3.5
+    def address_serialize( name, opts = nil )
+      opts = opts.dup
+      out = ( opts.delete( :address ) || name ).to_s
+      subject = opts.delete( :subject )
+      out += '/' + subject.to_s if subject
+      out += '; ' + option_serialize( opts ) if opts
+    end
+
+    # Serialize addresses options Hash
+    def option_serialize( val )
+      case( val )
+      when TrueClass, FalseClass, Symbol, Integer
+        val.to_s
+      when String
+        val.to_s.inspect #quote/escape
+      when Hash
+        pairs = val.map do | key, value |
+          [ wrap_key( key ), option_serialize( value ) ].join( ": " )
+        end
+        '{ ' + pairs.join( ', ' ) + ' }'
+      when Array
+        values = val.map do | value |
+          option_serialize( value )
+        end
+        '[ ' + values.join( ', ' ) + ' ]'
+      else
+        raise "Unknown option value class: " + val.class.to_s
+      end
+    end
+
+    # Quote keys that require it based on Qpid address scheme (most
+    # commonly, those with '.' in them).
+    def wrap_key( key )
+      k = key.to_s
+      if ( k =~ /^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$/ )
+        k
+      else
+        "'" + k + "'"
+      end
+    end
+
+    # The AMQP specific Connection URL as defined in Qpid JNDI
+    # Properities.
+    def connection_url
+      url = "amqp://"
+
+      if username
+        url += username
+        url += ':' + password if password
+        url += '@'
+      end
+
+      url += [ client_id, virtual_host ].join( '/' )
+
+      url += '?'
+
+      url += "brokerlist='#{ broker_list }'"
+
+      url
+    end
+
+    # Broker list Connection URL parameter value from input brokers.
+    def broker_list
+      l = brokers.map do | host, port |
+        'tcp://%s:%s' % [ host, port || 5672 ]
+      end
+
+      l.join( ';' )
+    end
+
+    # Appends Socket.gethostname and the current Process.pid to the
+    # specified prefix to create a (transient) unique address name
+    def address_per_process( prefix )
+      [ prefix,
+        Socket.gethostname.to_s.split( '.' ).first,
+        Process.pid.to_s ].compact.join( '-' )
+    end
+
+  end
+end

data/pom.xml

@@ -0,0 +1,47 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>rjack</groupId>
+  <artifactId>rjack-qpid-client</artifactId>
+  <packaging>pom</packaging>
+  <version>1.0</version>
+  <name>QPid java client for Gem</name>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.apache.qpid</groupId>
+      <artifactId>qpid-client</artifactId>
+      <version>0.8</version>
+    </dependency>
+
+    <dependency>
+      <groupId>org.apache.qpid</groupId>
+      <artifactId>qpid-common</artifactId>
+      <version>0.8</version>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <artifactId>maven-assembly-plugin</artifactId>
+        <configuration>
+          <descriptors>
+            <descriptor>assembly.xml</descriptor>
+          </descriptors>
+          <tarLongFileMode>gnu</tarLongFileMode>
+        </configuration>
+        <executions>
+          <execution>
+            <id>assembly</id>
+            <phase>package</phase>
+            <goals>
+              <goal>attached</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+
+</project>

data/test/test_qpid_client.rb

@@ -0,0 +1,122 @@
+#!/usr/bin/env jruby
+#.hashdot.profile += jruby-shortlived
+#--
+# Copyright (c) 2011 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You
+# may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+$LOAD_PATH.unshift File.join( File.dirname(__FILE__), "..", "lib" )
+
+require 'java'
+require 'rubygems'
+
+require 'rjack-qpid-client'
+require 'rjack-logback'
+
+RJack::Logback.config_console( :stderr => true )
+
+require 'test/unit'
+
+class TestQpidClient < Test::Unit::TestCase
+  include RJack::QpidClient
+
+  import 'org.apache.qpid.jms.Session'
+
+  def test_qpid_loaded
+    assert( Session )
+  end
+
+  def test_default_connection
+    with_context do |ctx|
+      assert( con = ctx.create_connection )
+      con.close
+    end
+  end
+
+  def test_dest_queue
+    con = nil
+    with_context do |ctx|
+      ctx.destinations[ 'rjack-qpid-test-q' ] = {
+        :assert => :always,
+        :create => :always,
+        :node   => {
+          :type       => :queue,
+          'x-declare' => {
+            'auto-delete' => true,
+            :exclusive    => true,
+            :arguments => {
+              'qpid.max_size'    => 200,
+              'qpid.policy_type' => :ring,
+            }
+          }
+        }
+      }
+      assert( con = ctx.create_connection )
+      assert( session = ctx.create_session( con ) )
+      assert( ctx.lookup_destination( 'rjack-qpid-test-q' ) )
+    end
+  ensure
+    con.close if con
+  end
+
+  def test_dest_exchange
+    con = nil
+    with_context do |ctx|
+
+      ctx.destinations[ 'rjack-qpid-test-x' ] = {
+        :assert => :always,
+        :create => :always,
+        :node   => {
+          :type       => :topic,
+          'x-declare' => {
+            :type     => :fanout,
+            :exchange => 'rjack-qpid-test-x'
+          }
+        }
+      }
+
+      ctx.destinations[ 'rjack-qpid-test-x-q' ] = {
+        :assert  => :always,
+        :create  => :always,
+        :delete  => :always,
+        :node    => {
+          :type        => :queue,
+          'x-bindings' => [ { :exchange => 'rjack-qpid-test-x' } ],
+          'x-declare'  => {
+            'auto-delete' => true,
+            :exclusive    => true,
+            :arguments    => {
+              'qpid.max_size'    => 200_000,
+              'qpid.policy_type' => :ring,
+            }
+          }
+        }
+      }
+      assert( con = ctx.create_connection )
+      assert( session = ctx.create_session( con ) )
+      assert( ctx.lookup_destination( 'rjack-qpid-test-x' ) )
+      assert( ctx.lookup_destination( 'rjack-qpid-test-x-q' ) )
+    end
+  ensure
+    con.close if con
+  end
+
+  def with_context
+    ctx = QpidJMSContext.new
+    yield ctx
+  ensure
+    ctx.close if ctx
+  end
+
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification 
+name: rjack-qpid-client
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+    - 0
+    - 8
+    - 0
+  version: 0.8.0
+platform: java
+authors: 
+  - David Kellum
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-05 00:00:00 -08:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rjack-jms
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 0
+              - 0
+            version: 1.0.0
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rjack-mina
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 0
+              - 10
+            version: 1.0.10
+    type: :runtime
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: rjack-slf4j
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 5
+              - 8
+            version: 1.5.8
+        - - <
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 7
+            version: "1.7"
+    type: :runtime
+    version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: rjack-logback
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+              - 9
+              - 18
+            version: 0.9.18
+        - - <
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 2
+              - 0
+            version: "2.0"
+    type: :development
+    version_requirements: *id004
+  - !ruby/object:Gem::Dependency 
+    name: rjack-tarpit
+    prerelease: false
+    requirement: &id005 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 3
+              - 0
+            version: 1.3.0
+    type: :development
+    version_requirements: *id005
+description: A gem packaging of the {Qpid}[http://qpid.apache.org/] AMQP Java Client.
+email: 
+  - dek-oss@gravitext.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - Manifest.txt
+  - NOTICE.txt
+  - History.rdoc
+  - README.rdoc
+files: 
+  - History.rdoc
+  - Manifest.txt
+  - NOTICE.txt
+  - README.rdoc
+  - Rakefile
+  - assembly.xml
+  - pom.xml
+  - lib/rjack-qpid-client/base.rb
+  - lib/rjack-qpid-client.rb
+  - lib/rjack-qpid-client/qpid_jms_context.rb
+  - test/test_qpid_client.rb
+  - lib/rjack-qpid-client/qpid-client-0.8.jar
+  - lib/rjack-qpid-client/qpid-common-0.8.jar
+has_rdoc: true
+homepage: http://rjack.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+  - --main
+  - README.rdoc
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+requirements: []
+
+rubyforge_project: rjack
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A gem packaging of the {Qpid}[http://qpid.apache.org/] AMQP Java Client.
+test_files: 
+  - test/test_qpid_client.rb