Module com.oracle.bedrock.runtime.windows

Package com.oracle.bedrock.runtime.remote.windows.winrm

Class OutputStreamConnector

java.lang.Object

java.lang.Thread

com.oracle.bedrock.runtime.remote.windows.winrm.OutputStreamConnector

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable

public class OutputStreamConnector
extends Thread
implements Closeable

An implementation of a Thread that polls a remote WinRM shell command for the contents of its output streams and then pipes that data to corresponding OutputStreams.

Copyright (c) 2015. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Jonathan Knight

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OutputStreamConnector(WindowsSession session, OutputStream stdOut, OutputStream stdErr)	Create an OutputStreamConnector to link the output streams of the remote process controlled by the WindowsSession.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this OutputStreamConnector and stops the run loop.
OutputStream	getErrorStream()	Obtain the OutputStream this connector pipes the remote process stderr to.
int	getExitCode()	Obtain the exit value of the remote process or -1 if the process has not yet terminated.
OutputStream	getOutputStream()	Obtain the OutputStream this connector pipes the remote process stdout to.
WindowsSession	getSession()	Obtain the WindowsSession running the remote process.
boolean	pollOutput()	Poll for the current process output from the remote command.
void	run()	The run loop for this Thread.
Integer	waitFor(com.oracle.bedrock.Option... options)	Causes the current thread to wait, if necessary, until the remote command has terminated.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

OutputStreamConnector

protected OutputStreamConnector(WindowsSession session,
 OutputStream stdOut,
 OutputStream stdErr)

Create an OutputStreamConnector to link the output streams of the remote process controlled by the WindowsSession.

Parameters:

session - the WindowsSession running the remote process

stdOut - the OutputStream to write the process stdout stream to

stdErr - the OutputStream to write the process stderr stream to

Method Details

getOutputStream

public OutputStream getOutputStream()

Obtain the OutputStream this connector pipes the remote process stdout to.

Returns:

the OutputStream this connector pipes the remote process stdout to

getErrorStream

public OutputStream getErrorStream()

Obtain the OutputStream this connector pipes the remote process stderr to.

Returns:

the OutputStream this connector pipes the remote process stderr to

getSession

public WindowsSession getSession()

Obtain the WindowsSession running the remote process.

Returns:

the WindowsSession running the remote process

close

public void close()

Closes this OutputStreamConnector and stops the run loop.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

waitFor

public Integer waitFor(com.oracle.bedrock.Option... options)

Causes the current thread to wait, if necessary, until the remote command has terminated.

Parameters:

options - the Options for waiting, including Timeout

Returns:

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

getExitCode

public int getExitCode()

Obtain the exit value of the remote process or -1 if the process has not yet terminated.

Returns:

the exit value of the remote process or -1 if the process has not yet terminated

pollOutput

public boolean pollOutput()
                   throws IOException

Poll for the current process output from the remote command.

Returns:

true if the process is still running otherwise false.

Throws:

IOException - if an error occurs.

run

public void run()

The run loop for this Thread.

Specified by:

run in interface Runnable

Overrides:

run in class Thread