torquebox-scheduling 4.0.0.alpha1-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 796ce74cdf3f9b5e3eeae0e71c87a0db5189785c
+  data.tar.gz: 90bac3951e73cab6c0a50614d4e08b1818e21b4f
+SHA512:
+  metadata.gz: 512e06854638257d5962ad619432042e89d0332d333e295e4adb2ffb0329bd9adace8e583ed3b5b92bf53e3dc22e369a6824a71b1329caf594b6f8d1d6439319
+  data.tar.gz: 4ceb64201f9ffde95b3e368ef565aa101e4fa7c44c64c8f043c8fdfaa579de8f51e46addd87de62d69881add2bc87510b5388cab11d980088caae1b96ab55318

data/lib/torquebox-scheduling.rb

@@ -0,0 +1,21 @@
+# Copyright 2014 Red Hat, Inc, and individual contributors.
+#
+# 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-core'
+
+Dir.glob("#{File.dirname(__FILE__)}/wunderboss-jars/*.jar") do |jar|
+  TorqueBox::Jars.register_and_require(jar)
+end
+
+require 'torquebox/scheduling'

data/lib/torquebox/scheduling.rb

@@ -0,0 +1,16 @@
+# Copyright 2014 Red Hat, Inc, and individual contributors.
+#
+# 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/scheduling/scheduler'
+require 'torquebox/scheduling/job'

data/lib/torquebox/scheduling/job.rb

@@ -0,0 +1,50 @@
+# Copyright 2014 Red Hat, Inc, and individual contributors.
+#
+# 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 TorqueBox
+  module Scheduling
+    # Represents a scheduled job.
+    #
+    # (see {Scheduler#schedule})
+    class Job
+
+      # The id of this job
+      attr_reader :id
+
+      # Returns true if this job replaced an existing job with the
+      # same id.
+      def replacement?
+        @replacement
+      end
+
+      # Unschedules this job.
+      #
+      # (see {Scheduler#unschedule})
+      # @return true if a job was unscheduled, false otherwise
+      def unschedule
+        @scheduler.unschedule(@id)
+      end
+
+      protected
+
+      def initialize(scheduler, id, replacement)
+        @scheduler = scheduler
+        @id = id
+        @replacement = replacement
+      end
+
+    end
+  end
+end

data/lib/torquebox/scheduling/scheduler.rb

@@ -0,0 +1,161 @@
+# Copyright 2014 Red Hat, Inc, and individual contributors.
+#
+# 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 TorqueBox
+  module Scheduling
+    # Provides an interface to a job scheduler.
+    #
+    # You can get access to the default or a custom configured
+    # scheduler via {.find_or_create}, and schedule against that
+    # instance, or use {.schedule} and {.unschedule} to interact with
+    # the default scheduler.
+    class Scheduler
+      include TorqueBox::OptionUtils
+
+      # @return The raw java scheduler object.
+      attr_reader :internal_scheduler
+
+      # Schedules a job to fire at some point(s) in the future.
+      #
+      # If called with the id of an already scheduled job, that job
+      # will be replaced.
+      #
+      # Time options (`:at`, `:until`) can be specified as `Time`
+      # objects or millis-since-epoch.
+      #
+      # Period options (`:in`, `:every`) are milliseconds, but can be
+      # generated with ActiveSupport's numeric additions (if your
+      # application uses ActiveSupport):
+      #
+      #     s.schedule(:foo, in: 5.minutes, every: 10.seconds) {
+      #       puts "Called!"
+      #     }
+      #
+      # @param id [String, Symbol] The identifier for the job.
+      # @param spec [Hash] Options specifying the firing schedule for the job.
+      # @option spec :in [Fixnum] a period (in millis) after which the job will fire
+      # @option spec :at [Time, Fixnum] a time after which the job will fire
+      # @option spec :every [Fixnum] the period (in millis) between firings
+      # @option spec :until [Time, Fixnum] a specific time for the job to stop firing
+      # @option spec :limit [Fixnum] limits the firings to a specific count
+      # @option spec :cron [String] fires according to a
+      #   {http://quartz-scheduler.org/documentation/quartz-2.2.x/tutorials/tutorial-lesson-06 Quartz-style}
+      #   cron spec
+      # @option spec :singleton [true, false] (true) denotes the job's behavior in a cluster
+      # @param block [Proc] A zero-arity block or proc that will be
+      #   called on each job execution.
+      # @return [Job] An object that allows you to unschedule the job.
+      def schedule(id, spec, &block)
+        validate_options(spec, opts_to_set(WBScheduling::ScheduleOption))
+        spec = coerce_schedule_options(spec)
+        replacement = internal_scheduler.schedule(id.to_s, block,
+                                                  extract_options(spec, WBScheduling::ScheduleOption))
+        Job.new(self, id, replacement)
+      end
+
+      # Unschedules the job with the given id.
+      #
+      # @param id [String, Symbol] The id of the job to unschedule
+      # @return true if a job was unscheduled, false otherwise
+      def unschedule(id)
+        internal_scheduler.unschedule(id.to_s)
+      end
+
+      # Starts the scheduler.
+      #
+      # The scheduler will automatically be started when a job is
+      # scheduled, so you may never need to call this.
+      def start
+        @internal_scheduler.start
+      end
+
+      # Stops the scheduler after unscheduling all of its jobs.
+      def stop
+        @internal_scheduler.stop
+      end
+
+      # Looks up the scheduler with the given name.
+      #
+      # If a scheduler with that name doesn't exist, it is created
+      # with the given options. The options are ignored when
+      # retrieving an existing scheduler.
+      #
+      # @param name [String, Symbol] The name of the scheduler. The
+      #   default scheduler is named 'default'.
+      # @param options [Hash] Options for scheduler creation.
+      # @option options num_threads [Fixnum] (5) The size of the thread
+      #   pool for firing jobs
+      def self.find_or_create(name, options = {})
+        Scheduler.new(name, options)
+      end
+
+      # (see #schedule)
+      # This method schedules via the default scheduler.
+      def self.schedule(id, spec, &block)
+        default_scheduler.schedule(id, spec, &block)
+      end
+
+      # (see #unschedule)
+      # This method unschedules via the default scheduler.
+      def self.unschedule(id)
+        default_scheduler.unschedule(id)
+      end
+
+      protected
+
+      WB = org.projectodd.wunderboss.WunderBoss
+      WBScheduling = org.projectodd.wunderboss.scheduling.Scheduling
+
+      def self.default_scheduler
+        @scheduler ||= find_or_create("default")
+      end
+
+      def initialize(name, options = {})
+        @logger = WB.logger('TorqueBox::Scheduling::Scheduler')
+        validate_options(options, opts_to_set(WBScheduling::CreateOption))
+        create_options = extract_options(options, WBScheduling::CreateOption)
+        comp = WB.find_or_create_component(WBScheduling.java_class, name,
+                                           create_options)
+        @logger.debug("TorqueBox::Scheduling::Scheduler '{}' has component {}",
+                      name, comp)
+        @internal_scheduler = comp
+        at_exit { stop }
+      end
+
+      def coerce_schedule_options(options)
+        options.clone.merge(options) do |k, v|
+          # ActiveSupport's durations use seconds as the base unit, so
+          # we have to detect that and convert to ms
+          v = v.in_milliseconds if defined?(ActiveSupport::Duration) && v.is_a?(ActiveSupport::Duration)
+
+          v = as_date(v) if [:at, :until].include?(k)
+
+          v = !!v if k == :singleton
+
+          v.to_java
+        end
+      end
+
+      def as_date(val)
+        if val.is_a?(Integer)
+          Time.at(val)
+        else
+          val
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: torquebox-scheduling
+version: !ruby/object:Gem::Version
+  version: 4.0.0.alpha1
+platform: java
+authors:
+- The TorqueBox Team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: torquebox-core
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0.alpha1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.0.alpha1
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: jbundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  prerelease: false
+  type: :development
+description:
+email: torquebox-dev@torquebox.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/torquebox-scheduling.rb
+- lib/wunderboss-jars/wunderboss-scheduling-1.x.incremental.174.jar
+- lib/wunderboss-jars/quartz-2.2.1.jar
+- lib/torquebox/scheduling.rb
+- lib/torquebox/scheduling/scheduler.rb
+- lib/torquebox/scheduling/job.rb
+homepage: http://torquebox.org/torqbox
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements:
+- jar org.projectodd.wunderboss:wunderboss-ruby, 1.x.incremental.174
+- jar org.projectodd.wunderboss:wunderboss-scheduling, 1.x.incremental.174
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: TorqueBox Next Generation
+test_files: []
+has_rdoc: