torquebox-backstage 0.1.0

data/config.ru

@@ -0,0 +1,3 @@
+require 'backstage'
+
+run Backstage::Application

data/config/torquebox.yml

@@ -0,0 +1,14 @@
+web:
+  context: /backstage
+
+tasks:
+  Backgroundable:
+    concurrency: 0
+
+ruby:
+  version: 1.9
+
+environment:
+# Add users to $JBOSS_HOME/server/default/conf/props/torquebox-users.properties
+# or just call rake torquebox:auth:adduser CREDENTIALS=user:pass from the command line
+#  REQUIRE_AUTHENTICATION: true

data/lib/apps.rb

@@ -0,0 +1,18 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# 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 'apps/models/app'
+require 'apps/routes'

data/lib/apps/models/app.rb

@@ -0,0 +1,33 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# 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 Backstage
+  class App
+    include HasMBean
+    include TorqueBoxManaged
+    include Resource
+    
+    def self.filter
+      "torquebox.apps:*"
+    end
+
+    def self.to_hash_attributes
+      super + [:name, :environment_name, :root_path, :deployed_at]
+    end
+    
+  end
+end
+

data/lib/apps/routes.rb

@@ -0,0 +1,18 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# 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.
+#
+
+Backstage::Application.resource :app
+

data/lib/authentication.rb

@@ -0,0 +1,64 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# 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 'torquebox'
+require 'org/torquebox/auth/authentication'
+
+module Backstage
+  module Authentication
+
+    def auth
+      @auth ||= Rack::Auth::Basic::Request.new(request.env)
+    end
+
+    def unauthorized!(realm=request.host)
+      headers 'WWW-Authenticate' => %(Basic realm="#{realm}")
+      throw :halt, [ 401, 'Authentication Required' ]
+    end
+
+    def bad_request!
+      throw :halt, [ 400, 'Bad Request' ]
+    end
+    
+    def login_path
+      "#{request.script_name}/login"
+    end
+
+    def authenticated?
+      !request.env['REMOTE_USER'].nil?
+    end
+   
+    def authenticate(username, password)
+      return false if username.nil? || password.nil?
+      authenticator = TorqueBox::Authentication.default
+      authenticator.authenticate(username, password)
+    end
+
+    def skip_authentication
+      request.env['SKIP_AUTH'] = true
+    end
+   
+    def require_authentication
+      return if request.env['SKIP_AUTH']
+      return if authenticated?
+      unauthorized! unless auth.provided?
+      bad_request! unless auth.basic?
+      unauthorized! unless authenticate(*auth.credentials)
+      request.env['REMOTE_USER'] = auth.username
+    end
+
+  end
+end

data/lib/destinations.rb

@@ -0,0 +1,21 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# 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 'destinations/models/destination'
+require 'destinations/models/queue'
+require 'destinations/models/topic'
+require 'destinations/models/message'
+require 'destinations/routes'

data/lib/destinations/models/destination.rb

@@ -0,0 +1,80 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# 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 'json'
+
+module Backstage
+  class Destination
+    include Enumerable
+    include HasMBean
+    include Resource
+    
+    attr_accessor :enumerable_options
+    
+    def self.filter
+      "org.hornetq:address=\"#{jms_prefix}\",*,type=Queue"
+    end
+
+    def self.to_hash_attributes
+      super + [:display_name, :app, :app_name, :status, :message_count, :delivering_count, :scheduled_count, :messages_added, :consumer_count]
+    end
+
+    def jms_destination
+      TorqueBox::Messaging::Queue.new( jndi_name, nil, enumerable_options )
+    end
+    
+    def each
+      jms_destination.each do |message|
+        message = Message.new( message )
+        message.parent = self
+        yield message
+      end
+    end
+    
+    def display_name
+      self.class.display_name( name )
+    end
+
+    def jndi_name
+      jndi_name = name.gsub( self.class.jms_prefix, '' )
+      jndi_name = "/queue/#{jndi_name}" if %w{ DLQ ExpiryQueue }.include?( jndi_name )
+      jndi_name
+    end
+
+    def self.display_name(name)
+      display_name = name.gsub( /jms\..*?\./, '' )
+      display_name = 'Backgroundable' if display_name =~ %r{/queues/torquebox/.*/backgroundable}
+      display_name = "#{$1.classify}Task" if display_name =~ %r{/queues/torquebox/.*/tasks/(.*)$}
+      display_name
+    end
+
+    def app
+      name =~ %r{/queues/torquebox/(.*?)/} ? App.find( "torquebox.apps:app=#{$1}" ) : nil
+    end
+    
+    def app_name
+      name =~ %r{/queues/torquebox/(.*)} ? $1 : 'n/a'
+    end
+
+    def status
+      mbean.paused ? 'Paused' : 'Running'
+    end
+
+    def available_actions
+      status == 'Running' ? %w{ pause } : %w{ resume }
+    end
+  end
+end

data/lib/destinations/models/message.rb

@@ -0,0 +1,67 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# 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 'torquebox/messaging/javax_jms_text_message'
+
+module Backstage
+  class Message
+    include Resource
+
+    attr_reader :jms_message
+
+    IGNORED_PROPERTIES = %w{ torquebox_encoding JMSXDeliveryCount }
+    def initialize(message)
+      @jms_message = message
+    end
+
+    def content
+      jms_message.decode.inspect
+    rescue Exception => ex
+      # we may not have access to a serialized class. Just show the
+      # Marshal string in that case
+      jms_message.get_string_property( 'torquebox_encoding' ) ? Base64.decode64( jms_message.text ) : jms_message.text
+    end
+
+    def jms_id
+      jms_message.jms_message_id
+    end
+    alias_method :full_name, :jms_id
+    
+    def properties
+      @properties ||= jms_message.property_names.inject( {} ) do |properties, name|
+        properties[name] = jms_message.get_string_property( name ) unless IGNORED_PROPERTIES.include?( name )
+        properties        
+      end
+    end
+    
+    JMS_PROPERTIES = %w{ JMS_Correlation_ID JMS_Priority JMS_Type  JMS_Reply_To JMS_Redelivered }
+    def jms_properties
+      @jms_properties ||= JMS_PROPERTIES.inject( {} ) do |props,name|
+        value = jms_message.send(name.downcase)
+        props[name.gsub('_',' ')] = value.to_s if value # Ignore empty values
+        props
+      end
+    end
+
+    def delivery_count
+      jms_message.get_string_property( 'JMSXDeliveryCount' )
+    end
+
+    def self.to_hash_attributes
+      super + [:jms_id, :delivery_count, :properties, :content]
+    end
+  end
+end

data/lib/destinations/models/queue.rb

@@ -0,0 +1,33 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# 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 Backstage
+  class Queue < Destination
+
+    def self.jms_prefix
+      'jms.queue.'
+    end
+    
+    def self.filter
+      'org.hornetq:address="jms.queue.*",*,type=Queue'
+    end
+
+    def self.to_hash_attributes
+      super + [:durable]
+    end
+
+  end
+end

data/lib/destinations/models/topic.rb

@@ -0,0 +1,59 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# 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 Backstage
+  class Topic < Destination
+    attr_accessor :consumer_topic
+    
+    def self.jms_prefix
+      'jms.topic.'
+    end
+    
+    def self.filter
+      'org.hornetq:address="jms.topic.*",*,name="jms.topic.*",type=Queue' 
+    end
+
+    def consumer_topics
+      unless @consumer_topics
+        @consumer_topics = self.class.all( %Q{org.hornetq:address="#{name}",*,type=Queue} )
+        @consumer_topics = @consumer_topics.reject { |t| t.full_name == full_name }
+        @consumer_topics.each { |t| t.consumer_topic = true }
+      end
+      @consumer_topics
+    end
+
+    %w{ message_count delivering_count scheduled_count messages_added }.each do |method|
+      define_method method do
+        if consumer_topic
+          super 
+        else
+          consumer_topics.collect(&(method.to_sym)).max || 0
+        end
+      end
+    end
+
+    def consumer_count
+      consumer_topics.size
+    end
+
+    %w{ pause resume }.each do |action|
+      define_method action do
+        super
+        consumer_topics.each { |t| t.__send__( action ) } unless consumer_topic
+      end
+    end
+  end
+end

data/lib/destinations/routes.rb

@@ -0,0 +1,44 @@
+#
+# Copyright 2011 Red Hat, Inc.
+#
+# 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 Backstage
+  class Application < Sinatra::Base
+    resource :queue, :topic, :view_path => :destinations, :actions => [:pause, :resume]
+
+    get "/queue/:name/messages" do
+      @destination = Queue.find( Util.decode_name( params[:name] ) )
+      if html_requested?
+        haml :'messages/index'
+      else
+        content_type :json
+        collection_to_json( @destination.entries )
+      end
+    end
+
+    get "/queue/:name/message/:id" do
+      @destination = Queue.find( Util.decode_name( params[:name] ) )
+      @object = @destination.find { |m| m.jms_id == Util.decode_name( params[:id] ) }
+      if html_requested?
+        haml :'messages/show'
+      else
+        object_to_json( @object )
+      end
+    end
+    
+  end
+end
+