org.apache.brooklyn.entity.nosql.riak

Class RiakNodeSshDriver

java.lang.Object

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

org.apache.brooklyn.entity.software.base.AbstractSoftwareProcessSshDriver

org.apache.brooklyn.entity.java.JavaSoftwareProcessSshDriver

org.apache.brooklyn.entity.nosql.riak.RiakNodeSshDriver

All Implemented Interfaces:

EntityDriver, JavaSoftwareProcessDriver, RiakNodeDriver, NaiveScriptRunner, SoftwareProcessDriver

public class RiakNodeSshDriver
extends JavaSoftwareProcessSshDriver
implements RiakNodeDriver

Field Summary

Fields inherited from class org.apache.brooklyn.entity.java.JavaSoftwareProcessSshDriver

KEY_VAL_OPT_PREFIXES, log, MUTUALLY_EXCLUSIVE_OPTS

Fields inherited from class org.apache.brooklyn.entity.software.base.AbstractSoftwareProcessSshDriver

CHECK_RUNNING, CUSTOMIZING, DEBUG, IGNORE_ENTITY_SSH_FLAGS, INSTALL_INCOMPLETE, INSTALLING, KILLING, LAUNCHING, logSsh, NON_STANDARD_LAYOUT, PID_FILENAME, PROCESS_OWNER, RESTARTING, STOPPING, USE_PID_FILE, VALID_FLAGS

Constructor Summary

Constructors

Constructor and Description
RiakNodeSshDriver(RiakNodeImpl entity, SshMachineLocation machine)

Method Summary

Modifier and Type	Method and Description
void	bucketTypeActivate(java.lang.String bucketTypeName)
void	bucketTypeCreate(java.lang.String bucketTypeName, java.lang.String bucketTypeProperties)
java.util.List<java.lang.String>	bucketTypeList()
java.util.List<java.lang.String>	bucketTypeStatus(java.lang.String bucketTypeName)
void	bucketTypeUpdate(java.lang.String bucketTypeName, java.lang.String bucketTypeProperties)
void	customize() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
RiakNodeImpl	getEntity() The entity whose components we are controlling.
java.lang.String	getOsMajorVersion()
java.lang.String	getRiakEtcDir()
java.util.Map<java.lang.String,java.lang.String>	getShellEnvironment() Sets all JVM options (-X..
void	install() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
boolean	isPackageInstall()
boolean	isRiakOnPath()
boolean	isRunning() Whether the entity components have started.
void	joinCluster(java.lang.String nodeName)
void	launch() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
void	leaveCluster()
java.lang.Integer	maxOpenFiles()
void	prepare() Prepare the entity instance before running any commands.
void	recoverFailedNode(java.lang.String nodeName)
void	removeNode(java.lang.String nodeName)
void	setup() Implementations should fail if the return code is non-zero, by throwing some appropriate exception.
void	stop() Performs software stop (or queues tasks to do this)

Methods inherited from class org.apache.brooklyn.entity.java.JavaSoftwareProcessSshDriver

checkJavaHostnameBug, copyRuntimeResources, getJavaOpts, getJmxContext, getJmxPort, getRmiRegistryPort, installJava, installJmxSupport, isJmxEnabled, isJmxSslEnabled

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

checkNoHostnameBug, copyCustomizeResources, copyInstallResources, copyPreInstallResources, copyResource, copyResource, execute, execute, execute, getAddress, getHostname, getLocation, getMachine, getPortsUsed, getSubnetAddress, getSubnetHostname, runPostCustomizeCommand, runPostInstallCommand, runPostLaunchCommand, runPreCustomizeCommand, runPreInstallCommand, runPreLaunchCommand

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

copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyTemplate, copyTemplate, copyTemplate, getArchiveNameFormat, getExpandedInstallDir, getInstallDir, getResource, getResourceAsString, getRunDir, getVersion, kill, postLaunch, preInstall, processTemplate, processTemplate, processTemplate, processTemplate, processTemplateContents, processTemplateContents, rebind, restart, setExpandedInstallDir, start

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

kill, rebind, restart, start

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

getLocation

Constructor Detail

RiakNodeSshDriver

public RiakNodeSshDriver(RiakNodeImpl entity,
                         SshMachineLocation machine)

Method Detail

getEntity

public RiakNodeImpl getEntity()

Description copied from interface: SoftwareProcessDriver

The entity whose components we are controlling.

Specified by:

getEntity in interface EntityDriver

Specified by:

getEntity in interface SoftwareProcessDriver

Overrides:

getEntity in class AbstractSoftwareProcessDriver

getShellEnvironment

public java.util.Map<java.lang.String,java.lang.String> getShellEnvironment()

Description copied from class: JavaSoftwareProcessSshDriver

Sets all JVM options (-X.. -D..) in an environment var JAVA_OPTS.

That variable is constructed from JavaSoftwareProcessSshDriver.getJavaOpts(), then wrapped _unescaped_ in double quotes. An error is thrown if there is an unescaped double quote in the string. All other unescaped characters are permitted, but unless $var expansion or `command` execution is desired (although this is not confirmed as supported) the generally caller should escape any such characters, for example using StringEscapes.BashStringEscapes.escapeLiteralForDoubleQuotedBash(String).

Overrides:

getShellEnvironment in class JavaSoftwareProcessSshDriver

See Also:

SoftwareProcess.SHELL_ENVIRONMENT

prepare

public void prepare()

Description copied from class: AbstractSoftwareProcessDriver

Prepare the entity instance before running any commands. Always executed during AbstractSoftwareProcessDriver.start().

Overrides:

prepare in class AbstractSoftwareProcessSshDriver

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

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

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()

isRunning

public boolean isRunning()

Description copied from interface: SoftwareProcessDriver

Whether the entity components have started.

Specified by:

isRunning in interface SoftwareProcessDriver

isPackageInstall

public boolean isPackageInstall()

isRiakOnPath

public boolean isRiakOnPath()

getRiakEtcDir

public java.lang.String getRiakEtcDir()

Specified by:

getRiakEtcDir in interface RiakNodeDriver

joinCluster

public void joinCluster(java.lang.String nodeName)

Specified by:

joinCluster in interface RiakNodeDriver

leaveCluster

public void leaveCluster()

Specified by:

leaveCluster in interface RiakNodeDriver

removeNode

public void removeNode(java.lang.String nodeName)

Specified by:

removeNode in interface RiakNodeDriver

bucketTypeCreate

public void bucketTypeCreate(java.lang.String bucketTypeName,
                             java.lang.String bucketTypeProperties)

Specified by:

bucketTypeCreate in interface RiakNodeDriver

bucketTypeList

public java.util.List<java.lang.String> bucketTypeList()

Specified by:

bucketTypeList in interface RiakNodeDriver

bucketTypeStatus

public java.util.List<java.lang.String> bucketTypeStatus(java.lang.String bucketTypeName)

Specified by:

bucketTypeStatus in interface RiakNodeDriver

bucketTypeUpdate

public void bucketTypeUpdate(java.lang.String bucketTypeName,
                             java.lang.String bucketTypeProperties)

Specified by:

bucketTypeUpdate in interface RiakNodeDriver

bucketTypeActivate

public void bucketTypeActivate(java.lang.String bucketTypeName)

Specified by:

bucketTypeActivate in interface RiakNodeDriver

recoverFailedNode

public void recoverFailedNode(java.lang.String nodeName)

Specified by:

recoverFailedNode in interface RiakNodeDriver

setup

public void setup()

Description copied from class: AbstractSoftwareProcessDriver

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

Overrides:

setup in class JavaSoftwareProcessSshDriver

getOsMajorVersion

public java.lang.String getOsMajorVersion()

Specified by:

getOsMajorVersion in interface RiakNodeDriver

maxOpenFiles

public java.lang.Integer maxOpenFiles()