Class: RBoss::Profile

Inherits:

ComponentProcessor

• Object
• ComponentProcessor
• RBoss::Profile

Includes:

Platform

Defined in:

lib/rboss/jboss_profile.rb

Overview

A Class to configure a JBoss Profile

Basically, this class is a Component Processor with some components added to configure a JBoss profile, the built-in components are:

:deploy_folder => binded to a RBoss::DeployFolder

:cluster => a shortcut component for :run_conf, sends these attributes to it:

:multicast_ip   => default "239.255.0.1"
:partition_name => default "${profile name}-partition

:jms => a shortcut component for :run_conf, sends these attributes to it:

:peer_id

:bind => a shortcut component, sends these attributes:

To :run_conf
  :ports        => sends as :service_binding
To :init_script
  :address      => default "localhost", sends as :bind_address

:resource => binded to a RBoss::Resource

:jmx => binded to a RBoss::JMX, enabled by default and sends user and password

values to :init_script

:datasource => binded to a RBoss::Datasource

:xa_datasource => binded to a RBoss::XADatasource

:default_ds => binded to a RBoss::HypersonicReplacer

:mod_cluster => binded to a RBoss::ModCluster

Defaults:
  :path => "resources/mod_cluster.sar"
Move to :run_conf (for externalizing mod_cluster configuration)
  :advertise
  :advertise_group_address
  :advertise_port
  :proxy_list
  :excluded_contexts
  :auto_enable_contexts

:run_conf => binded to a RBoss::RunConf

Defaults:
  :path => 'resources/run.conf.erb'
  :stack_size => '128k'
  :heap_size => '2048m'
  :perm_size => '256m'

:slimming => binded to a RBoss::Slimming

:init_script => binded to a RBoss::ServiceScritp

Defaults:
  :path => 'resources/jboss_init_redhat.sh'
  :jmx_user => "admin"
  :jmx_password => "admin"
  :bind_address => "0.0.0.0"
  :java_path => "/usr/java/default"
  :jnp_port => 1099
  :jboss_user => "RUNASIS"

author Marcelo Guimarães <ataxexe@gmail.com>

Constant Summary

@@pre_install =

Priorities for components

0

@@install =

@@pre_install + 10

@@post_install =

@@install + 10

@@pre_setup =

@@post_install + 10

@@setup =

@@pre_setup + 10

@@post_setup =

@@setup + 10

@@final =

@@post_setup + 10

Instance Attribute Summary

• #jboss ⇒ Object readonly

  Returns the value of attribute jboss.

Instance Method Summary

• #create ⇒ Object
• #initialize(opts = {}) ⇒ Profile constructor

  A new instance of Profile.

• #initialize_components ⇒ Object
• #load_extensions ⇒ Object

  loads extensions to components based on the type of jboss (eap, soa-p, org, epp…).

• #load_scripts ⇒ Object

  Loads manually every script related to jboss.

• #load_scripts_in(dir) ⇒ Object
• #slim(*args) ⇒ Object

  For making code more readable.

Methods included from Platform

#clear, #jboss_cli, #run_conf, #run_conf_template, #twiddle

Methods inherited from ComponentProcessor

#add, #defaults, #process_components, #register

Constructor Details

#initialize(opts = {}) ⇒ Profile

Returns a new instance of Profile.

# File 'lib/rboss/jboss_profile.rb', line 113

def initialize opts = {}
  block = lambda { |type, config| type.new(@jboss, @logger, config).process }
  super &block
  @base_dir = File.dirname(__FILE__)
  @opts = {
    :jboss_home => ENV['JBOSS_HOME'],
    :base_profile => :production,
    :profile => :custom,
    :type => :undefined,
    :version => :undefined
  }.merge! opts
  @jboss_home = File.expand_path @opts[:jboss_home]
  @logger = @opts[:logger]
  unless @logger
    @logger = Logger::new STDOUT
    @logger.level = opts[:log_level] || Logger::INFO
    formatter = Yummi::Formatter::LogFormatter.new do |severity, message|
      "#{severity} : #{message}"
    end

    @logger.formatter = formatter
  end
  @profile = @opts[:profile].to_s
  @base_profile = @opts[:base_profile].to_s
  @jboss = RBoss::Path::new @jboss_home,
                            :profile => @profile,
                            :type => @opts[:type],
                            :version => @opts[:version],
                            :logger => @logger
  initialize_components
end

Instance Attribute Details

#jboss ⇒ Object (readonly)

Returns the value of attribute jboss.

# File 'lib/rboss/jboss_profile.rb', line 111

def jboss
  @jboss
end

Instance Method Details

#create ⇒ Object

# File 'lib/rboss/jboss_profile.rb', line 145

def create
  add :profile_folder, @base_profile
  process_components
end

#initialize_components ⇒ Object

# File 'lib/rboss/jboss_profile.rb', line 198

def initialize_components
  load_scripts
  load_extensions

  register :cluster,

           :priority => @@pre_install,
           :move_config => {
             :to_run_conf => [:multicast_ip, :partition_name],
             :to_jboss_web => [:jvm_route],
             :to_jms => [:peer_id]
           },
           :defaults => {
             :multicast_ip => "239.255.0.1",
             :partition_name => "#{@profile}-partition",
             :jvm_route => "#{@profile}"
           }

  register :jms,

           :priority => @@pre_install,
           :move_config => {
             :to_run_conf => [:peer_id]
           }

  register :bind,

           :priority => @@pre_install,
           :send_config => {
             :to_init_script => {
               :address => :bind_address
             }
           },
           :move_config => {
             :to_run_conf => {
               :ports => :service_binding
             }
           },
           :defaults => {
             :address => 'localhost'
           }

  register :profile_folder,
           :type => RBoss::ProfileFolder,
           :priority => @@install

  register :deploy_folder,

           :type => RBoss::DeployFolder,
           :priority => @@post_install,
           :multiple_instances => true


  register :resource,

           :type => RBoss::Resource,
           :priority => @@pre_setup,
           :multiple_instances => true

  register :jmx,

           :type => RBoss::JMX,
           :priority => @@setup,
           :send_config => {
             :to_init_script => {
               :password => :jmx_password,
               :user => :jmx_user
             }
           }

  register :datasource,

           :type => RBoss::Datasource,
           :priority => @@setup,
           :multiple_instances => true

  register :xa_datasource,

           :type => RBoss::XADatasource,
           :priority => @@setup,
           :multiple_instances => true

  register :default_ds,

           :type => RBoss::HypersonicReplacer,
           :priority => @@setup

  register :mod_cluster,

           :type => RBoss::ModCluster,
           :priority => @@setup,
           :move_config => {
             :to_run_conf => [
               :advertise,
               :advertise_group_address,
               :advertise_port,
               :proxy_list,
               :excluded_contexts,
               :auto_enable_contexts
             ]
           },
           :defaults => {
             :path => "#{@base_dir}/resources/mod_cluster.sar",
           }

  register :jbossweb,

           :type => RBoss::JBossWeb,
           :priority => @@setup

  register :run_conf,

           :type => RBoss::RunConf,
           :priority => @@post_setup,
           :send_config => {
             :to_init_script => [:service_binding]
           },
           :defaults => {
             :template_path => run_conf_template,

             :stack_size => '128k',
             :heap_size => '2048m',
             :perm_size => '256m'
           }

  register :slimming,

           :type => RBoss::Slimming,
           :priority => @@post_setup

  register :restore,

           :type => RBoss::Restore,
           :priority => @@post_setup + 5

  register :init_script,

           :type => RBoss::ServiceScript,
           :priority => @@final,
           :defaults => {
             :path => "#{@base_dir}/resources/jboss_init_redhat.sh.erb",
             :jmx_user => "admin",
             :jmx_password => "admin",
             :bind_address => "0.0.0.0",
             :java_path => "/usr/java/default",
             :jnp_port => 1099,
             :jboss_user => "RUNASIS"
           }
end

#load_extensions ⇒ Object

loads extensions to components based on the type of jboss (eap, soa-p, org, epp…)

# File 'lib/rboss/jboss_profile.rb', line 170

def load_extensions
  unless @jboss.type == :undefined
    dir = File.join(@base_dir, "components", @jboss.type.to_s.gsub(/_/, '-'))
    load_scripts_in dir
    unless @jboss.version == :undefined
      dir = File.join(dir, @jboss.version.to_s)
      load_scripts_in dir
    end
  end
end

#load_scripts ⇒ Object

Loads manually every script related to jboss. This is necessary to reset the components to its natural state

# File 'lib/rboss/jboss_profile.rb', line 191

def load_scripts
  scripts = Dir.entries("#{@base_dir}/components").find_all { |f| f.end_with?('.rb') }
  scripts.each do |script|
    load File.expand_path(@base_dir) + "/components/" + script
  end
end

#load_scripts_in(dir) ⇒ Object

# File 'lib/rboss/jboss_profile.rb', line 181

def load_scripts_in dir
  if File.exists? dir
    scripts = Dir.entries(dir).find_all { |f| f.end_with? '.rb' }
    scripts.each do |script|
      load File.join(dir, script)
    end
  end
end

#slim(*args) ⇒ Object

For making code more readable

example: profile.slim :jmx_console, :admin_console

# File 'lib/rboss/jboss_profile.rb', line 165

def slim *args
  add :slimming, args
end