org.jclouds.joyent.sdc.v6_5.compute.options

Class SDCTemplateOptions

java.lang.Object

org.jclouds.compute.options.RunScriptOptions

org.jclouds.compute.options.TemplateOptions

org.jclouds.joyent.sdc.v6_5.compute.options.SDCTemplateOptions

All Implemented Interfaces:

Cloneable

public class SDCTemplateOptions
extends TemplateOptions
implements Cloneable

Contains options supported in the ComputeService#runNode operation on the "joyent-sdc" provider.

Usage

The recommended way to instantiate a SDCTemplateOptions object is to statically import SDCTemplateOptions.* and invoke a static creation method followed by an instance mutator (if needed):

import static org.jclouds.aws.ec2.compute.options.SDCTemplateOptions.Builder.*;

ComputeService client = // get connection templateBuilder.options(inboundPorts(22, 80, 8080, 443)); Set set = client.createNodesInGroup(tag, 2, templateBuilder.build());

Author:

Adrian Cole

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SDCTemplateOptions.Builder

Nested classes/interfaces inherited from class org.jclouds.compute.options.TemplateOptions

TemplateOptions.ImmutableTemplateOptions

Nested classes/interfaces inherited from class org.jclouds.compute.options.RunScriptOptions

RunScriptOptions.ImmutableRunScriptOptions

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	generateKey

Fields inherited from class org.jclouds.compute.options.TemplateOptions

blockUntilRunning, inboundPorts, NONE, privateKey, publicKey, script, tags, userMetadata

Fields inherited from class org.jclouds.compute.options.RunScriptOptions

authenticateSudo, blockOnComplete, loginPassword, loginPrivateKey, loginUser, port, runAsRoot, seconds, taskName, wrapInInitScript

Constructor Summary

Constructors

Constructor and Description
SDCTemplateOptions()

Method Summary

Methods

Modifier and Type	Method and Description
SDCTemplateOptions	authorizePublicKey(String publicKey) authorize an rsa ssh key.
SDCTemplateOptions	blockOnPort(int port, int seconds) When the node is started, wait until the following port is active
SDCTemplateOptions	blockUntilRunning(boolean blockUntilRunning) Note
SDCTemplateOptions	clone()
void	copyTo(TemplateOptions to)
SDCTemplateOptions	dontAuthorizePublicKey()
boolean	equals(Object o)
SDCTemplateOptions	generateKey(boolean enable)
int	hashCode()
SDCTemplateOptions	inboundPorts(int... ports) Opens the set of ports to public access.
SDCTemplateOptions	installPrivateKey(String privateKey) replaces the rsa ssh key used at login.
SDCTemplateOptions	nameTask(String name)
SDCTemplateOptions	overrideAuthenticateSudo(boolean authenticateSudo)
SDCTemplateOptions	overrideLoginCredentials(LoginCredentials overridingCredentials)
SDCTemplateOptions	overrideLoginPassword(String password)
SDCTemplateOptions	overrideLoginPrivateKey(String privateKey)
SDCTemplateOptions	overrideLoginUser(String loginUser)
SDCTemplateOptions	runAsRoot(boolean runAsRoot)
SDCTemplateOptions	runScript(Statement script) This script will be executed as the root user upon system startup.
boolean	shouldGenerateKey()
com.google.common.base.Objects.ToStringHelper	string()
SDCTemplateOptions	userMetadata(Map<String,String> userMetadata)
SDCTemplateOptions	userMetadata(String key, String value)

Methods inherited from class org.jclouds.compute.options.TemplateOptions

as, blockOnComplete, getInboundPorts, getPrivateKey, getPublicKey, getRunScript, getTags, getUserMetadata, runScript, shouldBlockUntilRunning, tags, wrapInInitScript

Methods inherited from class org.jclouds.compute.options.RunScriptOptions

getLoginPassword, getLoginPrivateKey, getLoginUser, getPort, getSeconds, getTaskName, hasLoginPassword, hasLoginPasswordOption, hasLoginPrivateKey, hasLoginPrivateKeyOption, shouldAuthenticateSudo, shouldBlockOnComplete, shouldRunAsRoot, shouldWrapInInitScript, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

generateKey

protected boolean generateKey

Constructor Detail

SDCTemplateOptions

public SDCTemplateOptions()

Method Detail

clone

public SDCTemplateOptions clone()

Overrides:

clone in class TemplateOptions

copyTo

public void copyTo(TemplateOptions to)

Overrides:

copyTo in class TemplateOptions

equals

public boolean equals(Object o)

Overrides:

equals in class TemplateOptions

hashCode

public int hashCode()

Overrides:

hashCode in class TemplateOptions

string

public com.google.common.base.Objects.ToStringHelper string()

Overrides:

string in class TemplateOptions

generateKey

public SDCTemplateOptions generateKey(boolean enable)

See Also:

shouldGenerateKey()

shouldGenerateKey

public boolean shouldGenerateKey()

Returns:

true if auto generation of keys is enabled

blockOnPort

public SDCTemplateOptions blockOnPort(int port,
                             int seconds)

When the node is started, wait until the following port is active

Overrides:

blockOnPort in class TemplateOptions

inboundPorts

public SDCTemplateOptions inboundPorts(int... ports)

Opens the set of ports to public access.

Overrides:

inboundPorts in class TemplateOptions

authorizePublicKey

public SDCTemplateOptions authorizePublicKey(String publicKey)

authorize an rsa ssh key.

Overrides:

authorizePublicKey in class TemplateOptions

installPrivateKey

public SDCTemplateOptions installPrivateKey(String privateKey)

replaces the rsa ssh key used at login.

Overrides:

installPrivateKey in class TemplateOptions

blockUntilRunning

public SDCTemplateOptions blockUntilRunning(boolean blockUntilRunning)

Note

As of version 1.1.0, this option is incompatible with TemplateOptions.ImmutableTemplateOptions.runScript(Statement) and RunScriptOptions.blockOnComplete(boolean), as all current implementations utilize ssh in order to execute scripts.

Overrides:

blockUntilRunning in class TemplateOptions

Parameters:

blockUntilRunning - (default true) whether to block until the nodes in this template are in NodeMetadata.Status.RUNNING state

dontAuthorizePublicKey

public SDCTemplateOptions dontAuthorizePublicKey()

Overrides:

dontAuthorizePublicKey in class TemplateOptions

nameTask

public SDCTemplateOptions nameTask(String name)

Overrides:

nameTask in class TemplateOptions

Returns:

What to call the task relating to this script; default jclouds-script-timestamp where timestamp is millis since epoch

runAsRoot

public SDCTemplateOptions runAsRoot(boolean runAsRoot)

Overrides:

runAsRoot in class TemplateOptions

runScript

public SDCTemplateOptions runScript(Statement script)

This script will be executed as the root user upon system startup. This script gets a prologue, so no #!/bin/bash required, path set up, etc

Overrides:

runScript in class TemplateOptions

overrideLoginCredentials

public SDCTemplateOptions overrideLoginCredentials(LoginCredentials overridingCredentials)

Overrides:

overrideLoginCredentials in class TemplateOptions

overrideLoginPassword

public SDCTemplateOptions overrideLoginPassword(String password)

Overrides:

overrideLoginPassword in class TemplateOptions

overrideLoginPrivateKey

public SDCTemplateOptions overrideLoginPrivateKey(String privateKey)

Overrides:

overrideLoginPrivateKey in class TemplateOptions

overrideLoginUser

public SDCTemplateOptions overrideLoginUser(String loginUser)

Overrides:

overrideLoginUser in class TemplateOptions

overrideAuthenticateSudo

public SDCTemplateOptions overrideAuthenticateSudo(boolean authenticateSudo)

Overrides:

overrideAuthenticateSudo in class TemplateOptions

userMetadata

public SDCTemplateOptions userMetadata(Map<String,String> userMetadata)

Overrides:

userMetadata in class TemplateOptions

Parameters:

userMetadata - user-defined metadata to assign to this server

userMetadata

public SDCTemplateOptions userMetadata(String key,
                              String value)

Overrides:

userMetadata in class TemplateOptions

Parameters:

key - key to place into the metadata map

value - value to associate with that key