com.oracle.bedrock.runtime.remote.winrm.WindowsRemoteTerminal Maven / Gradle / Ivy
Show all versions of bedrock-runtime-windows Show documentation
/*
* File: WindowsRemoteTerminal.java
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* The contents of this file are subject to the terms and conditions of
* the Common Development and Distribution License 1.0 (the "License").
*
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the License by consulting the LICENSE.txt file
* distributed with this file, or by consulting https://oss.oracle.com/licenses/CDDL
*
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file LICENSE.txt.
*
* MODIFICATIONS:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*/
package com.oracle.bedrock.runtime.remote.winrm;
import com.oracle.bedrock.OptionsByType;
import com.oracle.bedrock.Bedrock;
import com.oracle.bedrock.runtime.Application;
import com.oracle.bedrock.runtime.options.WorkingDirectory;
import com.oracle.bedrock.runtime.remote.AbstractRemoteTerminal;
import com.oracle.bedrock.runtime.remote.RemoteApplicationProcess;
import com.oracle.bedrock.runtime.remote.RemotePlatform;
import com.oracle.bedrock.runtime.remote.RemoteTerminal;
import com.oracle.bedrock.table.Table;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* A Windows implementation of a {@link RemoteTerminal}
* that uses the WinRM SOAP service to execute commands.
*
* Copyright (c) 2015. All Rights Reserved. Oracle Corporation.
* Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
*
* @author Jonathan Knight
*/
public class WindowsRemoteTerminal extends AbstractRemoteTerminal
{
/**
* The {@link Logger} for this class.
*/
private static Logger LOGGER = Logger.getLogger(WindowsRemoteTerminal.class.getName());
/**
* Create a Windows remote shell that will connect to the WinRM
* service running on the {@link RemotePlatform}.
*
* @param platform the {@link RemotePlatform}
*/
public WindowsRemoteTerminal(RemotePlatform platform)
{
super(platform);
}
@SuppressWarnings("unchecked")
public RemoteApplicationProcess launch(Launchable launchable,
Class applicationClass,
OptionsByType optionsByType)
{
try
{
// ----- establish the application command line to execute -----
// determine the command to execute remotely
String command = launchable.getCommandToExecute(getRemotePlatform(), optionsByType);
List args = launchable.getCommandLineArguments(getRemotePlatform(), optionsByType);
// ----- establish the remote application process to represent the remote application -----
WindowsSession session = createSession();
WorkingDirectory workingDirectory = optionsByType.get(WorkingDirectory.class);
session.connect(workingDirectory.resolve(getRemotePlatform(), optionsByType).toString(),
launchable.getEnvironmentVariables(getRemotePlatform(), optionsByType));
// establish a RemoteApplicationProcess representing the remote application
WindowsRemoteApplicationProcess process = new WindowsRemoteApplicationProcess(session);
// ----- start the remote application -----
Table diagnosticsTable = optionsByType.get(Table.class);
if (diagnosticsTable != null && LOGGER.isLoggable(Level.INFO))
{
diagnosticsTable.addRow("Application Executable ", command);
LOGGER.log(Level.INFO,
"Oracle Bedrock " + Bedrock.getVersion() + ": Starting Application...\n"
+ "------------------------------------------------------------------------\n"
+ diagnosticsTable.toString() + "\n"
+ "------------------------------------------------------------------------\n");
}
process.execute(command, args);
return process;
}
catch (Exception e)
{
throw new RuntimeException("Failed to create remote application", e);
}
}
@Override
public void makeDirectories(String directoryName,
OptionsByType optionsByType)
{
try (WindowsSession session = createSession())
{
session.connect();
try (WindowsRemoteApplicationProcess process = new WindowsRemoteApplicationProcess(session))
{
process.execute("mkdir", Collections.singletonList(directoryName));
int rc = process.waitFor();
if (rc != 0 && rc != 1)
{
throw new RuntimeException("Error creating directory " + directoryName + " - mkdir returned " + rc);
}
}
}
catch (Exception e)
{
throw new RuntimeException("Error creating directory " + directoryName, e);
}
}
public void moveFile(String source,
String destination,
OptionsByType optionsByType)
{
try (WindowsSession session = createSession())
{
session.connect();
try (WindowsRemoteApplicationProcess process = new WindowsRemoteApplicationProcess(session))
{
process.execute("move", Arrays.asList(source, destination));
int rc = process.waitFor();
if (rc != 0 && rc != 1)
{
throw new RuntimeException("Error moving file from " + source + " to " + destination
+ " - move return code = " + rc);
}
}
}
catch (Exception e)
{
throw new RuntimeException("Error moving file from " + source + " to " + destination, e);
}
}
/**
* Create a {@link WindowsSession} that can be used to communicate
* with the WinRM server on the remote host.
*
* @return a {@link WindowsSession} that can be used to communicate
* with the WinRM server on the remote host
*/
protected WindowsSession createSession()
{
RemotePlatform platform = getRemotePlatform();
return new WindowsSession(platform.getAddress().getHostName(),
platform.getPort(),
platform.getUserName(),
platform.getAuthentication());
}
}