org.apache.brooklyn.entity.software.base

Class AbstractSoftwareProcessWinRmDriver

java.lang.Object

org.apache.brooklyn.entity.software.base.AbstractSoftwareProcessDriver

org.apache.brooklyn.entity.software.base.AbstractSoftwareProcessWinRmDriver

All Implemented Interfaces:

EntityDriver, NativeWindowsScriptRunner, SoftwareProcessDriver

Direct Known Subclasses:

EmptyWindowsProcessWinRmDriver, VanillaWindowsProcessWinRmDriver

public abstract class AbstractSoftwareProcessWinRmDriver
extends AbstractSoftwareProcessDriver
implements NativeWindowsScriptRunner

Constructor Summary

Constructors

Constructor and Description
AbstractSoftwareProcessWinRmDriver(EntityLocal entity, WinRmMachineLocation location)

Method Summary

Modifier and Type	Method and Description
void	copyCustomizeResources() Files and templates to be copied to the server before customize.
void	copyInstallResources() Files and templates to be copied to the server before installation.
void	copyPreInstallResources() Files and templates to be copied to the server before pre-install.
int	copyResource(java.util.Map<java.lang.Object,java.lang.Object> sshFlags, java.io.InputStream source, java.lang.String target, boolean createParentDir)
int	copyResource(java.util.Map<java.lang.Object,java.lang.Object> sshFlags, java.lang.String sourceUrl, java.lang.String target, boolean createParentDir)
int	copyTo(java.io.File source, java.lang.String destination)
int	copyTo(java.io.InputStream source, java.lang.String destination)
int	execute(java.util.List<java.lang.String> script)
int	executeNativeCommand(java.util.Map flags, java.lang.String command, java.lang.String phase) Runs a command and returns the result code
java.lang.Integer	executeNativeOrPsCommand(java.util.Map flags, java.lang.String regularCommand, java.lang.String powerShellCommand, java.lang.String summary, java.lang.Boolean allowNoOp)
int	executePsCommand(java.util.Map flags, java.lang.String command, java.lang.String phase)
int	executePsScript(java.util.List<java.lang.String> psScript)
int	executePsScriptNoRetry(java.util.List<java.lang.String> psScript)
WinRmMachineLocation	getLocation() The location the entity is running in.
WinRmMachineLocation	getMachine()
void	rebootAndWait()
void	rebootAndWait(java.lang.String hostname)
void	runPostCustomizeCommand() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
void	runPostInstallCommand() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
void	runPostLaunchCommand() Only run if launch is run (if start is not skipped).
void	runPreCustomizeCommand() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
void	runPreInstallCommand() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
void	runPreLaunchCommand() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
void	setup() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.

Methods inherited from class org.apache.brooklyn.entity.software.base.AbstractSoftwareProcessDriver

copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyRuntimeResources, copyTemplate, copyTemplate, copyTemplate, customize, getArchiveNameFormat, getEntity, getExpandedInstallDir, getInstallDir, getResource, getResourceAsString, getRunDir, getShellEnvironment, getVersion, install, kill, launch, postLaunch, preInstall, prepare, processTemplate, processTemplate, processTemplate, processTemplate, processTemplateContents, processTemplateContents, rebind, restart, setExpandedInstallDir, start, stop

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcessDriver

isRunning

Constructor Detail

AbstractSoftwareProcessWinRmDriver

public AbstractSoftwareProcessWinRmDriver(EntityLocal entity,
                                          WinRmMachineLocation location)

Method Detail

runPreInstallCommand

public void runPreInstallCommand()

Description copied from class: AbstractSoftwareProcessDriver

Implementations should fail if the return code is non-zero, by throwing some appropriate exception.

Specified by:

runPreInstallCommand in class AbstractSoftwareProcessDriver

setup

public void setup()

Description copied from class: AbstractSoftwareProcessDriver

Implementations should fail if the return code is non-zero, by throwing some appropriate exception.

Specified by:

setup in class AbstractSoftwareProcessDriver

runPostInstallCommand

public void runPostInstallCommand()

Description copied from class: AbstractSoftwareProcessDriver

Implementations should fail if the return code is non-zero, by throwing some appropriate exception.

Specified by:

runPostInstallCommand in class AbstractSoftwareProcessDriver

runPreCustomizeCommand

public void runPreCustomizeCommand()

Description copied from class: AbstractSoftwareProcessDriver

Implementations should fail if the return code is non-zero, by throwing some appropriate exception.

Specified by:

runPreCustomizeCommand in class AbstractSoftwareProcessDriver

runPostCustomizeCommand

public void runPostCustomizeCommand()

Description copied from class: AbstractSoftwareProcessDriver

Implementations should fail if the return code is non-zero, by throwing some appropriate exception.

Specified by:

runPostCustomizeCommand in class AbstractSoftwareProcessDriver

runPreLaunchCommand

public void runPreLaunchCommand()

Description copied from class: AbstractSoftwareProcessDriver

Implementations should fail if the return code is non-zero, by throwing some appropriate exception.

Specified by:

runPreLaunchCommand in class AbstractSoftwareProcessDriver

runPostLaunchCommand

public void runPostLaunchCommand()

Description copied from class: AbstractSoftwareProcessDriver

Only run if launch is run (if start is not skipped). Implementations should fail if the return code is non-zero, by throwing some appropriate exception.

Specified by:

runPostLaunchCommand in class AbstractSoftwareProcessDriver

copyPreInstallResources

public void copyPreInstallResources()

Description copied from class: AbstractSoftwareProcessDriver

Files and templates to be copied to the server before pre-install. This allows the AbstractSoftwareProcessDriver.preInstall() process to have access to all required resources.

Will be prefixed with the entity's install directory if relative.

Overrides:

copyPreInstallResources in class AbstractSoftwareProcessDriver

See Also:

SoftwareProcess.PRE_INSTALL_FILES, SoftwareProcess.PRE_INSTALL_TEMPLATES, AbstractSoftwareProcessDriver.copyRuntimeResources()

copyInstallResources

public void copyInstallResources()

Description copied from class: AbstractSoftwareProcessDriver

Files and templates to be copied to the server before installation. This allows the AbstractSoftwareProcessDriver.install() process to have access to all required resources.

Will be prefixed with the entity's install directory if relative.

Overrides:

copyInstallResources in class AbstractSoftwareProcessDriver

See Also:

SoftwareProcess.INSTALL_FILES, SoftwareProcess.INSTALL_TEMPLATES, AbstractSoftwareProcessDriver.copyRuntimeResources()

copyCustomizeResources

public void copyCustomizeResources()

Description copied from class: AbstractSoftwareProcessDriver

Files and templates to be copied to the server before customize. This allows the AbstractSoftwareProcessDriver.customize() process to have access to all required resources.

Will be prefixed with the entity's install directory if relative.

Overrides:

copyCustomizeResources in class AbstractSoftwareProcessDriver

See Also:

SoftwareProcess.INSTALL_FILES, SoftwareProcess.INSTALL_TEMPLATES, AbstractSoftwareProcessDriver.copyRuntimeResources()

getLocation

public WinRmMachineLocation getLocation()

Description copied from interface: EntityDriver

The location the entity is running in.

Specified by:

getLocation in interface EntityDriver

Overrides:

getLocation in class AbstractSoftwareProcessDriver

getMachine

public WinRmMachineLocation getMachine()

executeNativeCommand

public int executeNativeCommand(java.util.Map flags,
                                java.lang.String command,
                                java.lang.String phase)

Description copied from interface: NativeWindowsScriptRunner

Runs a command and returns the result code

Specified by:

executeNativeCommand in interface NativeWindowsScriptRunner

executePsCommand

public int executePsCommand(java.util.Map flags,
                            java.lang.String command,
                            java.lang.String phase)

Specified by:

executePsCommand in interface NativeWindowsScriptRunner

copyResource

public int copyResource(java.util.Map<java.lang.Object,java.lang.Object> sshFlags,
                        java.lang.String sourceUrl,
                        java.lang.String target,
                        boolean createParentDir)

Specified by:

copyResource in class AbstractSoftwareProcessDriver

copyResource

public int copyResource(java.util.Map<java.lang.Object,java.lang.Object> sshFlags,
                        java.io.InputStream source,
                        java.lang.String target,
                        boolean createParentDir)

Specified by:

copyResource in class AbstractSoftwareProcessDriver

executeNativeOrPsCommand

public java.lang.Integer executeNativeOrPsCommand(java.util.Map flags,
                                                  java.lang.String regularCommand,
                                                  java.lang.String powerShellCommand,
                                                  java.lang.String summary,
                                                  java.lang.Boolean allowNoOp)

Specified by:

executeNativeOrPsCommand in interface NativeWindowsScriptRunner

execute

public int execute(java.util.List<java.lang.String> script)

executePsScriptNoRetry

public int executePsScriptNoRetry(java.util.List<java.lang.String> psScript)

executePsScript

public int executePsScript(java.util.List<java.lang.String> psScript)

copyTo

public int copyTo(java.io.File source,
                  java.lang.String destination)

copyTo

public int copyTo(java.io.InputStream source,
                  java.lang.String destination)

rebootAndWait

public void rebootAndWait()

rebootAndWait

public void rebootAndWait(java.lang.String hostname)