aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-main/src/main/java/org/sonar/application/process/ManagedProcess.java
blob: 3262513a3785fa578488a5556ea53459bedb1ad3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/*
 * SonarQube
 * Copyright (C) 2009-2025 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.application.process;

import java.io.InputStream;
import java.util.concurrent.TimeUnit;

public interface ManagedProcess {

  /**
   * @see Process#getInputStream()
   */
  InputStream getInputStream();

  /**
   * @see Process#getErrorStream()
   */
  InputStream getErrorStream();

  /**
   * Closes the streams {@link Process#getInputStream()}, {@link Process#getOutputStream()}
   * and {@link Process#getErrorStream()}.
   *
   * No exceptions are thrown in case of errors.
   */
  void closeStreams();

  /**
   * @see Process#isAlive()
   */
  boolean isAlive();

  /**
   * @see Process#destroyForcibly()
   */
  void destroyForcibly();

  /**
   * @see Process#waitFor()
   */
  void waitFor() throws InterruptedException;

  /**
   * @see Process#waitFor(long, TimeUnit)
   */
  void waitFor(long timeout, TimeUnit timeoutUnit) throws InterruptedException;

  /**
   * Whether the process has reach operational state after startup.
   */
  boolean isOperational();

  void askForStop();

  /**
   * Send request to quick stop to the process
   */
  void askForHardStop();

  /**
   * Whether the process asked for a full restart
   */
  boolean askedForRestart();

  /**
   * Sends a signal to the process to acknowledge that the parent process received the request to restart from the
   * child process send via {@link #askedForRestart()}.
   * <br/>
   * Child process will typically stop sending the signal requesting restart from now on.
   */
  void acknowledgeAskForRestart();
}