CouchDBNodeSshDriver (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.basic.AbstractSoftwareProcessDriver
- - brooklyn.entity.basic.AbstractSoftwareProcessSshDriver
  - - brooklyn.entity.nosql.couchdb.CouchDBNodeSshDriver

All Implemented Interfaces:

NaiveScriptRunner, SoftwareProcessDriver, EntityDriver, CouchDBNodeDriver
```
public class CouchDBNodeSshDriver
extends AbstractSoftwareProcessSshDriver
implements CouchDBNodeDriver
```
Start a CouchDBNode in a Location accessible over ssh.

Field Summary
- Fields inherited from class brooklyn.entity.basic.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

CouchDBNodeSshDriver(CouchDBNodeImpl entity, SshMachineLocation machine)

Constructors
Constructor and Description
`CouchDBNodeSshDriver(CouchDBNodeImpl entity, SshMachineLocation machine)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`customize()`
`java.lang.String`	`getClusterName()`
`java.lang.String`	`getCouchDBConfigFileName()`
`java.lang.String`	`getCouchDBConfigTemplateUrl()`
`java.lang.String`	`getCouchDBUriTemplateUrl()`
`java.lang.String`	`getErlangVersion()`
`java.lang.Integer`	`getHttpPort()`
`java.lang.Integer`	`getHttpsPort()`
`java.lang.String`	`getLogFileLocation()`
`java.lang.String`	`getPidFile()`
`java.util.Set<java.lang.Integer>`	`getPortsUsed()`
`void`	`install()`
`boolean`	`isRunning()` Whether the entity components have started.
`void`	`launch()`
`void`	`stop()` Performs software stop (or queues tasks to do this)

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessSshDriver
checkNoHostnameBug, copyInstallResources, copyResource, copyResource, execute, execute, execute, getAddress, getExpandedInstallDir, getHostname, getInstallDir, getLocation, getMachine, getRunDir, getShellEnvironment, getSubnetAddress, getSubnetHostname, runPostInstallCommand, runPostLaunchCommand, runPreInstallCommand, runPreLaunchCommand, setExpandedInstallDir, setup

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessDriver
copyPreInstallResources, copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyResource, copyRuntimeResources, copyTemplate, copyTemplate, copyTemplate, getEntity, getResource, getResourceAsString, getVersion, kill, postLaunch, preInstall, 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 brooklyn.entity.basic.SoftwareProcessDriver
getEntity, kill, rebind, restart, start

Methods inherited from interface brooklyn.entity.drivers.EntityDriver
getLocation

- Constructor Detail
  - CouchDBNodeSshDriver
```
public CouchDBNodeSshDriver(CouchDBNodeImpl entity,
                    SshMachineLocation machine)
```
- Method Detail
  - getLogFileLocation
```
public java.lang.String getLogFileLocation()
```
  - getHttpPort
```
public java.lang.Integer getHttpPort()
```
    Specified by:
    
    getHttpPort in interface CouchDBNodeDriver
  - getHttpsPort
```
public java.lang.Integer getHttpsPort()
```
    Specified by:
    
    getHttpsPort in interface CouchDBNodeDriver
  - getClusterName
```
public java.lang.String getClusterName()
```
    Specified by:
    
    getClusterName in interface CouchDBNodeDriver
  - getCouchDBConfigTemplateUrl
```
public java.lang.String getCouchDBConfigTemplateUrl()
```
    Specified by:
    
    getCouchDBConfigTemplateUrl in interface CouchDBNodeDriver
  - getCouchDBUriTemplateUrl
```
public java.lang.String getCouchDBUriTemplateUrl()
```
    Specified by:
    
    getCouchDBUriTemplateUrl in interface CouchDBNodeDriver
  - getCouchDBConfigFileName
```
public java.lang.String getCouchDBConfigFileName()
```
    Specified by:
    
    getCouchDBConfigFileName in interface CouchDBNodeDriver
  - getErlangVersion
```
public java.lang.String getErlangVersion()
```
  - install
```
public void install()
```
    Specified by:
    
    install in class AbstractSoftwareProcessDriver
  - getPortsUsed
```
public java.util.Set<java.lang.Integer> getPortsUsed()
```
    Overrides:
    
    getPortsUsed in class AbstractSoftwareProcessSshDriver
  - customize
```
public void customize()
```
    Specified by:
    
    customize in class AbstractSoftwareProcessDriver
  - launch
```
public void launch()
```
    Specified by:
    
    launch in class AbstractSoftwareProcessDriver
  - getPidFile
```
public java.lang.String getPidFile()
```
  - isRunning
```
public boolean isRunning()
```
    Description copied from interface: SoftwareProcessDriver
    
    Whether the entity components have started.
    
    Specified by:
    
    isRunning in interface SoftwareProcessDriver
  - 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()

Class CouchDBNodeSshDriver

Field Summary

Fields inherited from class brooklyn.entity.basic.AbstractSoftwareProcessSshDriver

Constructor Summary

Method Summary

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessSshDriver

Methods inherited from class brooklyn.entity.basic.AbstractSoftwareProcessDriver

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.entity.basic.SoftwareProcessDriver

Methods inherited from interface brooklyn.entity.drivers.EntityDriver

Constructor Detail

CouchDBNodeSshDriver

Method Detail

getLogFileLocation

getHttpPort

getHttpsPort

getClusterName

getCouchDBConfigTemplateUrl

getCouchDBUriTemplateUrl

getCouchDBConfigFileName

getErlangVersion

install

getPortsUsed

customize

launch

getPidFile

isRunning

stop