RiakNodeSshDriver (Apache Brooklyn)

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)

Constructors
Constructor and Description
`RiakNodeSshDriver(RiakNodeImpl entity, SshMachineLocation machine)`

Method Summary

Methods
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()`
`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()`
`boolean`	`isPackageInstall()`
`boolean`	`isRiakOnPath()`
`boolean`	`isRunning()` Whether the entity components have started.
`void`	`joinCluster(java.lang.String nodeName)`
`void`	`launch()`
`void`	`leaveCluster()`
`java.lang.Integer`	`maxOpenFiles()`
`void`	`preInstall()` Implement this method in child classes to add some pre-install behavior
`void`	`recoverFailedNode(java.lang.String nodeName)`
`void`	`removeNode(java.lang.String nodeName)`
`void`	`setup()`
`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, copyInstallResources, copyResource, copyResource, execute, execute, execute, getAddress, getExpandedInstallDir, getHostname, getInstallDir, getLocation, getMachine, getPortsUsed, getRunDir, getSubnetAddress, getSubnetHostname, runPostInstallCommand, runPostLaunchCommand, runPreInstallCommand, runPreLaunchCommand, setExpandedInstallDir

Methods inherited from class org.apache.brooklyn.entity.software.base.AbstractSoftwareProcessDriver
copyPreInstallResources, copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyTemplate, copyTemplate, copyTemplate, getResource, getResourceAsString, getVersion, kill, postLaunch, processTemplate, processTemplate, processTemplate, processTemplate, processTemplateContents, processTemplateContents, rebind, restart, 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
  - preInstall
```
public void preInstall()
```
    Description copied from class: AbstractSoftwareProcessDriver
    
    Implement this method in child classes to add some pre-install behavior
    
    Overrides:
    
    preInstall in class AbstractSoftwareProcessDriver
  - install
```
public void install()
```
    Specified by:
    
    install in class AbstractSoftwareProcessDriver
  - customize
```
public void customize()
```
    Specified by:
    
    customize in class AbstractSoftwareProcessDriver
  - launch
```
public void launch()
```
    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()
```
    Overrides:
    
    setup in class JavaSoftwareProcessSshDriver
  - getOsMajorVersion
```
public java.lang.String getOsMajorVersion()
```
    Specified by:
    
    getOsMajorVersion in interface RiakNodeDriver
  - maxOpenFiles
```
public java.lang.Integer maxOpenFiles()
```

Class RiakNodeSshDriver

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

RiakNodeSshDriver

Method Detail

getEntity

getShellEnvironment

preInstall

install

customize

launch

stop

isRunning

isPackageInstall

isRiakOnPath

getRiakEtcDir

joinCluster

leaveCluster

removeNode

bucketTypeCreate

bucketTypeList

bucketTypeStatus

bucketTypeUpdate

bucketTypeActivate

recoverFailedNode

setup

getOsMajorVersion

maxOpenFiles