Class: Sunspot::Solr::Server

Inherits:
Object
  • Object
show all
Defined in:
lib/sunspot/solr/server.rb

Overview

:nodoc:

Constant Summary collapse

ServerError =

Raised if #stop is called but the server is not running

Class.new(RuntimeError)
AlreadyRunningError = 
Class.new(ServerError)
NotRunningError = 
Class.new(ServerError)
JavaMissing = 
Class.new(ServerError)
SOLR_START_JAR =

Name of the sunspot executable (shell script)

File.expand_path(
  File.join(File.dirname(__FILE__), '..', '..', '..', 'solr', 'start.jar')
)
LOG_LEVELS = 
Set['SEVERE', 'WARNING', 'INFO', 'CONFIG', 'FINE', 'FINER', 'FINEST']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Server

Returns a new instance of Server.



25
26
27
28
 
# File 'lib/sunspot/solr/server.rb', line 25

def initialize(*args)
  ensure_java_installed
  super(*args)
end

Instance Attribute Details

#log_file ⇒ Object

Returns the value of attribute log_file.



22
23
24
 
# File 'lib/sunspot/solr/server.rb', line 22

def log_file
  @log_file
end

#log_level ⇒ Object 



115
116
117
 
# File 'lib/sunspot/solr/server.rb', line 115

def log_level
  @log_level || 'WARNING'
end

#max_memory ⇒ Object

Returns the value of attribute max_memory.



22
23
24
 
# File 'lib/sunspot/solr/server.rb', line 22

def max_memory
  @max_memory
end

#min_memory ⇒ Object

Returns the value of attribute min_memory.



22
23
24
 
# File 'lib/sunspot/solr/server.rb', line 22

def min_memory
  @min_memory
end

#pid_dir ⇒ Object 



127
128
129
 
# File 'lib/sunspot/solr/server.rb', line 127

def pid_dir
  File.expand_path(@pid_dir || FileUtils.pwd)
end

#pid_file ⇒ Object 



123
124
125
 
# File 'lib/sunspot/solr/server.rb', line 123

def pid_file
  @pid_file || 'sunspot-solr.pid'
end

#port ⇒ Object

Returns the value of attribute port.



22
23
24
 
# File 'lib/sunspot/solr/server.rb', line 22

def port
  @port
end

#solr_data_dir ⇒ Object

Returns the value of attribute solr_data_dir.



22
23
24
 
# File 'lib/sunspot/solr/server.rb', line 22

def solr_data_dir
  @solr_data_dir
end

#solr_home ⇒ Object

Returns the value of attribute solr_home.



22
23
24
 
# File 'lib/sunspot/solr/server.rb', line 22

def solr_home
  @solr_home
end

#solr_jar ⇒ Object 



139
140
141
 
# File 'lib/sunspot/solr/server.rb', line 139

def solr_jar
  @solr_jar || SOLR_START_JAR
end

Instance Method Details

#pid_path ⇒ Object 



119
120
121
 
# File 'lib/sunspot/solr/server.rb', line 119

def pid_path
  File.join(pid_dir, pid_file)
end

#run ⇒ Object

Run the sunspot-solr server in the foreground. Boostrap solr_home first, if neccessary.

Returns

Boolean

success



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/sunspot/solr/server.rb', line 72

def run
  command = ['java']
  command << "-Xms#{min_memory}" if min_memory
  command << "-Xmx#{max_memory}" if max_memory
  command << "-Djetty.port=#{port}" if port
  command << "-Dsolr.data.dir=#{solr_data_dir}" if solr_data_dir
  command << "-Dsolr.solr.home=#{solr_home}" if solr_home
  command << "-Djava.util.logging.config.file=#{logging_config_path}" if logging_config_path
  command << '-jar' << File.basename(solr_jar)
  FileUtils.cd(File.dirname(solr_jar)) do
    exec(Escape.shell_command(command))
  end
end

#start ⇒ Object

Start the sunspot-solr server. Bootstrap solr_home first, if neccessary.

Returns

Boolean

success



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/sunspot/solr/server.rb', line 38

def start
  if File.exist?(pid_path)
    existing_pid = IO.read(pid_path).to_i
    begin
      Process.kill(0, existing_pid)
      raise(AlreadyRunningError, "Server is already running with PID #{existing_pid}")
    rescue Errno::ESRCH
      STDERR.puts("Removing stale PID file at #{pid_path}")
      FileUtils.rm(pid_path)
    end
  end
  fork do
    pid = fork do
      Process.setsid
      STDIN.reopen('/dev/null')
      STDOUT.reopen('/dev/null', 'a')
      STDERR.reopen(STDOUT)
      run
    end
    FileUtils.mkdir_p(pid_dir)
    File.open(pid_path, 'w') do |file|
      file << pid
    end
  end
end

#stop ⇒ Object

Stop the sunspot-solr server.

Returns

Boolean

success



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/sunspot/solr/server.rb', line 93

def stop
  if File.exist?(pid_path)
    pid = IO.read(pid_path).to_i
    begin
      Process.kill('TERM', pid)
    rescue Errno::ESRCH
      raise NotRunningError, "Process with PID #{pid} is no longer running"
    ensure
      FileUtils.rm(pid_path)
    end
  else
    raise NotRunningError, "No PID file at #{pid_path}"
  end
end