org.apache.brooklyn.entity.software.base

Class EmptyWindowsProcessWinRmDriver

java.lang.Object

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

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

org.apache.brooklyn.entity.software.base.EmptyWindowsProcessWinRmDriver

All Implemented Interfaces:

EntityDriver, NativeWindowsScriptRunner, SoftwareProcessDriver, VanillaWindowsProcessDriver

public class EmptyWindowsProcessWinRmDriver
extends AbstractSoftwareProcessWinRmDriver
implements VanillaWindowsProcessDriver

Constructor Summary

Constructors

Constructor and Description
EmptyWindowsProcessWinRmDriver(EmptyWindowsProcessImpl entity, WinRmMachineLocation machine)

Method Summary

Modifier and Type	Method and Description
void	copyInstallResources() Files and templates to be copied to the server before installation.
void	copyRuntimeResources() Files and templates to be copied to the server after customisation.
void	customize() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
void	install() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
boolean	isRunning() Whether the entity components have started.
void	launch() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
void	rebind() Rebinds the driver to a pre-existing software process.
void	start() Start the entity.
void	stop() Performs software stop (or queues tasks to do this)

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

copyCustomizeResources, copyPreInstallResources, copyResource, copyResource, copyTo, copyTo, execute, executeNativeCommand, executeNativeOrPsCommand, executePsCommand, executePsScript, executePsScriptNoRetry, getLocation, getMachine, rebootAndWait, rebootAndWait, runPostCustomizeCommand, runPostInstallCommand, runPostLaunchCommand, runPreCustomizeCommand, runPreInstallCommand, runPreLaunchCommand, setup

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

copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyTemplate, copyTemplate, copyTemplate, getArchiveNameFormat, getEntity, getExpandedInstallDir, getInstallDir, getResource, getResourceAsString, getRunDir, getShellEnvironment, getVersion, kill, postLaunch, preInstall, prepare, processTemplate, processTemplate, processTemplate, processTemplate, processTemplateContents, processTemplateContents, restart, setExpandedInstallDir

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

getEntity, kill, restart

Methods inherited from interface org.apache.brooklyn.api.entity.drivers.EntityDriver

getLocation

Constructor Detail

EmptyWindowsProcessWinRmDriver

public EmptyWindowsProcessWinRmDriver(EmptyWindowsProcessImpl entity,
                                      WinRmMachineLocation machine)

Method Detail

start

public void start()

Description copied from class: AbstractSoftwareProcessDriver

Start the entity.

This installs, configures and launches the application process. However, users can also call the AbstractSoftwareProcessDriver.install(), AbstractSoftwareProcessDriver.customize() and AbstractSoftwareProcessDriver.launch() steps independently. The AbstractSoftwareProcessDriver.postLaunch() will be called after the AbstractSoftwareProcessDriver.launch() metheod is executed, but the process may not be completely initialised at this stage, so care is required when implementing these stages.

The BrooklynConfigKeys.SKIP_ENTITY_START_IF_RUNNING key can be set on the location or the entity to skip the startup process if the entity is already running, according to the SoftwareProcessDriver.isRunning() method. To force the startup to be skipped, BrooklynConfigKeys.SKIP_ENTITY_START can be set on the entity. The BrooklynConfigKeys.SKIP_ENTITY_INSTALLATION key can also be used to skip the AbstractSoftwareProcessDriver.setup(), AbstractSoftwareProcessDriver.copyInstallResources() and AbstractSoftwareProcessDriver.install() methods if set on the entity or location.

Specified by:

start in interface SoftwareProcessDriver

Overrides:

start in class AbstractSoftwareProcessDriver

See Also:

AbstractSoftwareProcessDriver.stop()

isRunning

public boolean isRunning()

Description copied from interface: SoftwareProcessDriver

Whether the entity components have started.

Specified by:

isRunning in interface SoftwareProcessDriver

install

public void install()

Description copied from class: AbstractSoftwareProcessDriver

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

Specified by:

install in class AbstractSoftwareProcessDriver

customize

public void customize()

Description copied from class: AbstractSoftwareProcessDriver

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

Specified by:

customize in class AbstractSoftwareProcessDriver

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 AbstractSoftwareProcessWinRmDriver

See Also:

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

copyRuntimeResources

public void copyRuntimeResources()

Description copied from class: AbstractSoftwareProcessDriver

Files and templates to be copied to the server after customisation. This allows overwriting of existing files such as entity configuration which may be copied from the installation directory during the AbstractSoftwareProcessDriver.customize() process.

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

Overrides:

copyRuntimeResources in class AbstractSoftwareProcessDriver

See Also:

SoftwareProcess.RUNTIME_FILES, SoftwareProcess.RUNTIME_TEMPLATES, AbstractSoftwareProcessDriver.copyInstallResources()

launch

public void launch()

Description copied from class: AbstractSoftwareProcessDriver

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

Specified by:

launch in class AbstractSoftwareProcessDriver

rebind

public void rebind()

Description copied from interface: SoftwareProcessDriver

Rebinds the driver to a pre-existing software process.

Specified by:

rebind in interface SoftwareProcessDriver

Overrides:

rebind in class AbstractSoftwareProcessDriver

stop

public void stop()

Description copied from interface: SoftwareProcessDriver

Performs software stop (or queues tasks to do this)

Specified by:

stop in interface SoftwareProcessDriver

Specified by:

stop in class AbstractSoftwareProcessDriver

See Also:

Startable.stop()