use of com.oracle.bedrock.options.Timeout in project oracle-bedrock by coherence-community.
the class JSchSessionFactory method createSession.
/**
* Create a JSch {@link Session} connected to the specified remote host.
*
* @param userName the user name to use to connect to the specified host
* @param authentication the {@link Authentication} method to use to authenticate the user
* @param hostName the host name of the remote host to connect to
* @param port the port on the remote host to connect to
* @param socketFactory the {@link JSchSocketFactory} to use
* @param optionsByType the {@link OptionsByType} to use to control the session
*
* @return a {@link Session} connected to the specified remote host
*
* @throws JSchException if an error occurs creating the {@link Session}
*/
public Session createSession(String hostName, int port, String userName, Authentication authentication, JSchSocketFactory socketFactory, OptionsByType optionsByType) throws JSchException {
// allow the authentication to configure the framework
if (authentication instanceof JSchBasedAuthentication) {
((JSchBasedAuthentication) authentication).configureFramework(jsch);
}
// create the remote session
Session session = jsch.getSession(userName, hostName, port);
// establish the specialized socket factory for the session
session.setSocketFactory(socketFactory);
// the session should not cause the JVM not to exit
session.setDaemonThread(true);
// determine the timeout
Timeout timeout = optionsByType.getOrDefault(Timeout.class, Timeout.autoDetect());
int timeoutMS = (int) timeout.getDuration().to(TimeUnit.MILLISECONDS);
// set the default session timeouts (in milliseconds)
session.setTimeout(timeoutMS);
// allow the authentication to configure the session
if (authentication instanceof JSchBasedAuthentication) {
((JSchBasedAuthentication) authentication).configureSession(session);
}
// ----- configure the session channel properties -----
Properties config = new Properties();
// are we to use strict-host-checking? (when it's not defined it's enabled it by default)
StrictHostChecking strictHostChecking = optionsByType.get(StrictHostChecking.class);
config.put("StrictHostKeyChecking", strictHostChecking.isEnabled() ? "yes" : "no");
UserKnownHostsFile userKnownHostsFile = optionsByType.get(UserKnownHostsFile.class);
String file = userKnownHostsFile == null ? null : userKnownHostsFile.getFile();
if (file != null && !file.trim().isEmpty()) {
config.put("UserKnownHostsFile", file.trim());
}
session.setConfig(config);
// connect the session
session.connect();
return session;
}
use of com.oracle.bedrock.options.Timeout in project oracle-bedrock by coherence-community.
the class JschRemoteApplicationProcess method waitFor.
@Override
public int waitFor(Option... options) {
if (exitStatus == null) {
if (channel == null || session == null) {
throw new RuntimeException("The remote application has terminated. No exit status is available");
} else {
int status = channel.getExitStatus();
OptionsByType optionsByType = OptionsByType.of(options);
Timeout timeout = optionsByType.get(Timeout.class);
long timeRemaining = timeout.to(TimeUnit.MILLISECONDS);
while (status == -1 && timeRemaining >= 0) {
try {
// wait a little bit for the channel to exit
long waitTime = 500;
Thread.sleep(waitTime);
timeRemaining = timeRemaining - waitTime;
// for partial wait times, wait one cycle
if (timeRemaining > 0 && timeRemaining < waitTime) {
timeRemaining = waitTime;
}
status = channel.getExitStatus();
} catch (InterruptedException e) {
throw new RuntimeException("Interrupted while waiting for application to terminate", e);
}
}
exitStatus = status;
}
}
return exitStatus;
}
use of com.oracle.bedrock.options.Timeout in project oracle-bedrock by coherence-community.
the class LocalApplicationProcess method waitFor.
@Override
public int waitFor(Option... options) {
OptionsByType optionsByType = OptionsByType.of(options);
Timeout timeout = optionsByType.get(Timeout.class);
DeferredHelper.ensure(eventually(invoking(this).exitValue()), within(timeout));
return exitValue();
}
use of com.oracle.bedrock.options.Timeout in project oracle-bedrock by coherence-community.
the class OutputStreamConnector method waitFor.
/**
* Causes the current thread to wait, if necessary, until the remote
* command has terminated.
*
* @param options the {@link Option}s for waiting, including
* {@link com.oracle.bedrock.options.Timeout}
*
* @return the exit code of the remote command. By convention,
* the value 0 indicates normal termination
*
* @throws RuntimeException if there was a problem waiting for termination
*/
public Integer waitFor(Option... options) {
synchronized (this) {
if (exitCode != null) {
return exitCode;
}
OptionsByType optionsByType = OptionsByType.of(options);
Timeout timeout = optionsByType.get(Timeout.class);
try {
this.wait(timeout.to(TimeUnit.MILLISECONDS));
} catch (InterruptedException e) {
e.printStackTrace();
}
}
return exitCode;
}
use of com.oracle.bedrock.options.Timeout in project oracle-bedrock by coherence-community.
the class LocalJavaApplicationLauncher method launch.
@Override
public A launch(Platform platform, MetaClass<A> metaClass, OptionsByType optionsByType) {
// establish the diagnostics output table
Table diagnosticsTable = new Table();
diagnosticsTable.getOptions().add(Table.orderByColumn(0));
if (platform != null) {
diagnosticsTable.addRow("Target Platform", platform.getName());
}
// ----- establish the launch Options for the Application -----
// add the platform options
OptionsByType launchOptions = OptionsByType.of(platform.getOptions().asArray());
// add the meta-class options
metaClass.onLaunching(platform, launchOptions);
// add the launch specific options
launchOptions.addAll(optionsByType);
// ----- establish an identity for the application -----
// add a unique runtime id for expression support
launchOptions.add(Variable.with("bedrock.runtime.id", UUID.randomUUID()));
// ----- establish default Profiles for this Platform (and Builder) -----
// java applications can automatically detect the following profiles
launchOptions.get(RemoteDebugging.class);
launchOptions.get(CommercialFeatures.class);
// auto-detect and add externally defined profiles
launchOptions.addAll(Profiles.getProfiles());
for (Profile profile : launchOptions.getInstancesOf(Profile.class)) {
profile.onLaunching(platform, metaClass, launchOptions);
}
// ----- give the MetaClass a last chance to manipulate any options -----
metaClass.onLaunch(platform, launchOptions);
// ----- determine the display name for the application -----
DisplayName displayName = getDisplayName(launchOptions);
// ----- establish the underlying ProcessBuilder -----
// determine the Executable, defaulting to "java" if not defined
Executable executable = launchOptions.getOrSetDefault(Executable.class, Executable.named("java"));
// we'll use the native operating system process builder to create
// and manage the local application process
LocalProcessBuilder processBuilder = createProcessBuilder(executable.getName());
// ----- establish the working directory -----
// set the working directory for the Process
WorkingDirectory workingDirectory = launchOptions.getOrSetDefault(WorkingDirectory.class, WorkingDirectory.currentDirectory());
File directory = workingDirectory.resolve(platform, launchOptions);
// set the resolved working directory back into the options
launchOptions.add(WorkingDirectory.at(directory));
if (directory != null) {
processBuilder.directory(directory);
diagnosticsTable.addRow("Working Directory", directory.toString());
}
// ----- establish environment variables -----
EnvironmentVariables environmentVariables = launchOptions.get(EnvironmentVariables.class);
switch(environmentVariables.getSource()) {
case Custom:
processBuilder.environment().clear();
diagnosticsTable.addRow("Environment Variables", "(cleared)");
break;
case ThisApplication:
Map<String, String> map = System.getenv();
processBuilder.environment().clear();
processBuilder.environment().putAll(map);
diagnosticsTable.addRow("Environment Variables", "(based on parent process)");
break;
case TargetPlatform:
diagnosticsTable.addRow("Environment Variables", "(based on platform defaults)");
break;
}
// add the optionally defined environment variables
Properties variables = environmentVariables.realize(platform, launchOptions.asArray());
for (String variableName : variables.stringPropertyNames()) {
processBuilder.environment().put(variableName, variables.getProperty(variableName));
}
if (variables.size() > 0) {
Table table = Tabularize.tabularize(variables);
diagnosticsTable.addRow("", table.toString());
}
// ----- establish java specific environment variables -----
// by default we use the java home defined by the schema. if that's not
// defined we'll attempt to use the java home defined by this builder.
JavaHome javaHome = launchOptions.get(JavaHome.class);
// (using the system property)
if (javaHome == null) {
javaHome = JavaHome.at(System.getProperty("java.home", null));
}
if (javaHome != null) {
processBuilder.environment().put("JAVA_HOME", StringHelper.doubleQuoteIfNecessary(javaHome.get()));
}
// ----- establish the command to start java -----
String javaExecutable;
if (javaHome == null) {
// when we don't have a java home we just use the defined executable
javaExecutable = StringHelper.doubleQuoteIfNecessary(executable.getName());
} else {
// when we have a java home, we prefix the executable name with the java.home/bin/
String javaHomePath = javaHome.get();
javaHomePath = javaHomePath.trim();
diagnosticsTable.addRow("Java Home", javaHomePath);
if (!javaHomePath.endsWith(File.separator)) {
javaHomePath = javaHomePath + File.separator;
}
javaExecutable = StringHelper.doubleQuoteIfNecessary(javaHomePath + "bin" + File.separator + executable.getName());
}
processBuilder.command(javaExecutable);
diagnosticsTable.addRow("Java Executable", javaExecutable);
// ----- establish the class path -----
JavaModules modular = launchOptions.get(JavaModules.class);
boolean useModules = modular.isEnabled();
// determine the predefined class path based on the launch options
ClassPath classPath = launchOptions.get(ClassPath.class);
try {
// include the ClassPath of the Platform
classPath = new ClassPath(classPath, ClassPath.ofClass(platform.getClass()));
// include the ClassPath of each of the Options
for (Option option : launchOptions.getInstancesOf(Option.class)) {
classPath = new ClassPath(classPath, ClassPath.ofClass(option.getClass()));
}
// include the application runner (if defined)
BedrockRunner bedrockRunner = optionsByType.get(BedrockRunner.class);
if (bedrockRunner != null && bedrockRunner.isEnabled()) {
// include the JavaApplicationLauncher
classPath = new ClassPath(classPath, ClassPath.ofClass(bedrockRunner.getClassOfRunner()));
}
// add the updated ClassPath back into the launch options
launchOptions.add(classPath);
} catch (IOException e) {
throw new RuntimeException("Failed to locate required classes for the class path", e);
}
processBuilder.command().add(useModules ? "--module-path" : "-cp");
processBuilder.command().add(classPath.toString(launchOptions.asArray()));
if (useModules) {
Table modulePathTable = classPath.getTable();
modulePathTable.getOptions().add(Cell.Separator.of(""));
diagnosticsTable.addRow("Module Path", modulePathTable.toString());
ClassPath path = modular.getClassPath();
if (path != null && !path.isEmpty()) {
processBuilder.command().add("-cp");
processBuilder.command().add(path.toString(launchOptions.asArray()));
Table classPathTable = path.getTable();
classPathTable.getOptions().add(Cell.Separator.of(""));
diagnosticsTable.addRow("Class Path", classPathTable.toString());
}
} else {
Table classPathTable = classPath.getTable();
classPathTable.getOptions().add(Cell.Separator.of(""));
diagnosticsTable.addRow("Class Path", classPathTable.toString());
}
String applicationName = displayName.resolve(launchOptions);
// ----- establish Bedrock specific system properties -----
// configure a server channel to communicate with the native process
final SocketBasedRemoteChannelServer server = new SocketBasedRemoteChannelServer(applicationName);
// register the defined RemoteEventListeners with the server so that when the application starts
// the listeners can immediately start receiving RemoteEvents
RemoteEvents remoteEvents = launchOptions.get(RemoteEvents.class);
remoteEvents.forEach((remoteEventListener, listenerOptions) -> server.addListener(remoteEventListener, listenerOptions));
try {
// NOTE: this listens on the wildcard address on an ephemeral port
server.open();
} catch (IOException e) {
throw new RuntimeException("Failed to create remote execution server for the application", e);
}
// add Bedrock specific System Properties
// NOTE: the Bedrock parent address for locally created applications is always "loopback" as
// i). they are always running locally,
// ii). they only need to connect locally, and
// iii). the "loopback" interface should work regardless of the network we're on.
InetAddress parentAddress;
IPv4Preferred iPv4Preferred = launchOptions.get(IPv4Preferred.class);
if (iPv4Preferred.isPreferred()) {
// we have to provide the schema with an IPv4 address!
try {
parentAddress = InetAddress.getByName("127.0.0.1");
} catch (UnknownHostException e) {
// TODO: log that we couldn't determine the loopback address!
parentAddress = InetAddress.getLoopbackAddress();
}
} else {
// when the schema doesn't care, we can default to what this platform chooses
parentAddress = InetAddress.getLoopbackAddress();
}
Table systemPropertiesTable = new Table();
systemPropertiesTable.getOptions().add(Table.orderByColumn(0));
systemPropertiesTable.getOptions().add(Cell.Separator.of(""));
// establish the URI for this (parent) process
String parentURI = "//" + parentAddress.getHostAddress() + ":" + server.getPort();
systemPropertiesTable.addRow(Settings.PARENT_URI, parentURI.toString());
processBuilder.command().add("-D" + Settings.PARENT_URI + "=" + parentURI);
// add Orphanable configuration
Orphanable orphanable = launchOptions.get(Orphanable.class);
processBuilder.command().add("-D" + Settings.ORPHANABLE + "=" + orphanable.isOrphanable());
systemPropertiesTable.addRow(Settings.ORPHANABLE, Boolean.toString(orphanable.isOrphanable()));
// ----- establish the system properties for the java application -----
// define the system properties based on those defined by the launch options
Properties systemProperties = launchOptions.get(SystemProperties.class).resolve(platform, launchOptions);
for (String propertyName : systemProperties.stringPropertyNames()) {
String propertyValue = systemProperties.getProperty(propertyName);
// (we don't want to have "parents" applications effect child applications
if (propertyName.startsWith("bedrock.profile.") || !propertyName.startsWith("bedrock")) {
processBuilder.command().add("-D" + propertyName + (propertyValue.isEmpty() ? "" : "=" + propertyValue));
systemPropertiesTable.addRow(propertyName, propertyValue);
}
}
diagnosticsTable.addRow("System Properties", systemPropertiesTable.toString());
// ----- establish Java Virtual Machine options -----
StringBuilder jvmOptions = new StringBuilder();
for (JvmOption jvmOption : launchOptions.getInstancesOf(JvmOption.class)) {
for (String value : jvmOption.resolve(launchOptions)) {
processBuilder.command().add(value);
if (jvmOptions.length() > 0) {
jvmOptions.append(" ");
}
jvmOptions.append(value);
}
}
if (jvmOptions.length() > 0) {
diagnosticsTable.addRow("Java Options", jvmOptions.toString());
}
for (String propertyName : System.getProperties().stringPropertyNames()) {
if (propertyName.startsWith("bedrock.runtime.inherit.")) {
// resolve the property value
String propertyValue = System.getProperty(propertyName);
// evaluate any expressions in the property value
ExpressionEvaluator evaluator = new ExpressionEvaluator(launchOptions.get(Variables.class));
propertyValue = evaluator.evaluate(propertyValue, String.class);
processBuilder.command().add(propertyValue);
}
}
// ----- establish the application command line to execute -----
// use the launcher to launch the application
// (we don't start the application directly itself)
String applicationLauncherClassName = JavaApplicationRunner.class.getName();
if (useModules) {
applicationLauncherClassName = "com.oracle.bedrock.runtime/" + applicationLauncherClassName;
processBuilder.command().add("-m");
}
processBuilder.command().add(applicationLauncherClassName);
// set the Java application class name we need to launch
ClassName className = launchOptions.get(ClassName.class);
if (className == null) {
throw new IllegalArgumentException("Java Application ClassName not specified");
}
String applicationClassName = className.getName();
processBuilder.command().add(applicationClassName);
diagnosticsTable.addRow("Application Launcher", applicationLauncherClassName);
diagnosticsTable.addRow("Application Class", applicationClassName);
diagnosticsTable.addRow("Application", applicationName);
// ----- included the java arguments to the command -----
List<String> argList = launchOptions.get(Arguments.class).resolve(platform, launchOptions);
// Set the actual arguments used back into the options
launchOptions.add(Arguments.of(argList));
String arguments = "";
for (String argument : argList) {
processBuilder.command().add(argument);
arguments += argument + " ";
}
if (arguments.length() > 0) {
diagnosticsTable.addRow("Application Arguments", arguments);
}
// should the standard error be redirected to the standard out?
ErrorStreamRedirection redirection = launchOptions.get(ErrorStreamRedirection.class);
processBuilder.redirectErrorStream(redirection.isEnabled());
diagnosticsTable.addRow("Standard Error Device", redirection.isEnabled() ? "stdout" : "stderr");
diagnosticsTable.addRow("Application Launch Time", new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
// TODO: add all of the Profile options to the table
// ----- start the local process -----
boolean launchLogging = optionsByType.get(LaunchLogging.class).isEnabled();
if (launchLogging && LOGGER.isLoggable(Level.INFO)) {
LOGGER.log(Level.INFO, "Oracle Bedrock " + Bedrock.getVersion() + ": Starting Application...\n" + "------------------------------------------------------------------------\n" + diagnosticsTable.toString() + "\n" + "------------------------------------------------------------------------\n");
}
// create and start the native process
Process process;
try {
process = processBuilder.start(launchOptions);
} catch (IOException e) {
throw new RuntimeException("Failed to build the underlying native process for the application", e);
}
// ----- create the local process and application -----
// establish a LocalJavaProcess to represent the underlying Process
LocalJavaApplicationProcess localJavaProcess = new LocalJavaApplicationProcess(process, server, systemProperties);
// determine the application class that will represent the running application
Class<? extends A> applicationClass = metaClass.getImplementationClass(platform, launchOptions);
A application;
try {
// attempt to find a constructor(Platform, JavaApplicationProcess, Options)
Constructor<? extends A> constructor = ReflectionHelper.getCompatibleConstructor(applicationClass, platform.getClass(), localJavaProcess.getClass(), launchOptions.getClass());
// create the application
application = constructor.newInstance(platform, localJavaProcess, launchOptions);
} catch (Exception e) {
throw new RuntimeException("Failed to instantiate the Application class specified by the MetaClass:" + metaClass, e);
}
if (JmxFeature.isSupportedBy(application)) {
application.add(new JmxFeature());
}
// ----- wait for the application to start -----
// ensure that the launcher process connects back to the server to
// know that the application has started
WaitToStart waitToStart = launchOptions.get(WaitToStart.class);
if (waitToStart.isEnabled()) {
Timeout timeout = launchOptions.get(Timeout.class);
ensure(new AbstractDeferred<Boolean>() {
@Override
public Boolean get() throws TemporarilyUnavailableException, PermanentlyUnavailableException {
if (!server.getRemoteChannels().iterator().hasNext()) {
throw new TemporarilyUnavailableException(this);
} else {
return true;
}
}
}, within(timeout));
}
// ----- notify the MetaClass that the application has been launched -----
metaClass.onLaunched(platform, application, launchOptions);
for (Profile profile : launchOptions.getInstancesOf(Profile.class)) {
profile.onLaunched(platform, application, launchOptions);
}
// notify the ApplicationListener-based Options that the application has been launched
for (ApplicationListener listener : launchOptions.getInstancesOf(ApplicationListener.class)) {
listener.onLaunched(application);
}
return application;
}
Aggregations