org.jclouds.compute.options
Class TemplateOptions.ImmutableTemplateOptions

java.lang.Object
  org.jclouds.compute.options.RunScriptOptions
      org.jclouds.compute.options.TemplateOptions
          org.jclouds.compute.options.TemplateOptions.ImmutableTemplateOptions

All Implemented Interfaces:

Cloneable

Enclosing class:

TemplateOptions

public static class TemplateOptions.ImmutableTemplateOptions
extends TemplateOptions

Nested Class Summary

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

TemplateOptions.Builder, TemplateOptions.ImmutableTemplateOptions

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

RunScriptOptions.ImmutableRunScriptOptions

Field Summary

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

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

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

blockOnComplete, overridingCredentials, port, runAsRoot, seconds, taskName, wrapInInitScript

Constructor Summary

TemplateOptions.ImmutableTemplateOptions(TemplateOptions delegate)

Method Summary

<T extends TemplateOptions> T	as(Class<T> clazz)
TemplateOptions	authorizePublicKey(Payload publicKey) Deprecated.
TemplateOptions	authorizePublicKey(String publicKey) authorize an rsa ssh key.
TemplateOptions	blockOnComplete(boolean blockOnComplete)
TemplateOptions	blockOnPort(int port, int seconds) When the node is started, wait until the following port is active
TemplateOptions	blockUntilRunning(boolean blockUntilRunning)
TemplateOptions	clone()
void	copyTo(TemplateOptions to)
TemplateOptions	dontAuthorizePublicKey()
int[]	getInboundPorts()
Credentials	getOverridingCredentials() Whether to override the credentials with ones supplied in call to org.jclouds.compute.ComputeService#runScriptOnNodesWithTag.
int	getPort()
String	getPrivateKey()
String	getPublicKey()
Statement	getRunScript()
int	getSeconds()
String	getTaskName()
TemplateOptions	inboundPorts(int... ports) Opens the set of ports to public access.
TemplateOptions	installPrivateKey(Payload privateKey) replaces the rsa ssh key used at login.
TemplateOptions	installPrivateKey(String privateKey) replaces the rsa ssh key used at login.
boolean	isIncludeMetadata()
TemplateOptions	nameTask(String name)
TemplateOptions	overrideCredentialsWith(Credentials overridingCredentials)
TemplateOptions	overrideLoginCredentialWith(String loginCredential)
TemplateOptions	overrideLoginUserWith(String loginUser)
TemplateOptions	runAsRoot(boolean runAsRoot)
TemplateOptions	runScript(byte[] script) This script will be executed as the root user upon system startup.
TemplateOptions	runScript(Payload script) This script will be executed as the root user upon system startup.
TemplateOptions	runScript(Statement script)
boolean	shouldBlockOnComplete() Whether to wait until the script has completed.
boolean	shouldBlockUntilRunning()
boolean	shouldRunAsRoot() Whether to run the script as root (or run with current privileges).
boolean	shouldWrapInInitScript() Whether to wait until the script has completed.
String	toString()
TemplateOptions	withMetadata()
TemplateOptions	wrapInInitScript(boolean wrapInInitScript) default true

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

equals, getTags, hashCode, tags

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateOptions.ImmutableTemplateOptions

public TemplateOptions.ImmutableTemplateOptions(TemplateOptions delegate)

Method Detail

clone

public TemplateOptions clone()

Overrides:

clone in class TemplateOptions

getTaskName

public String getTaskName()

Overrides:

getTaskName in class RunScriptOptions

getPort

public int getPort()

Overrides:

getPort in class RunScriptOptions

getSeconds

public int getSeconds()

Overrides:

getSeconds in class RunScriptOptions

getOverridingCredentials

public Credentials getOverridingCredentials()

Description copied from class: RunScriptOptions

Whether to override the credentials with ones supplied in call to org.jclouds.compute.ComputeService#runScriptOnNodesWithTag. By default, true.

Overrides:

getOverridingCredentials in class RunScriptOptions

Returns:

value

shouldRunAsRoot

public boolean shouldRunAsRoot()

Description copied from class: RunScriptOptions

Whether to run the script as root (or run with current privileges). By default, true.

Overrides:

shouldRunAsRoot in class RunScriptOptions

Returns:

value

shouldBlockOnComplete

public boolean shouldBlockOnComplete()

Description copied from class: RunScriptOptions

Whether to wait until the script has completed. By default, true.

Overrides:

shouldBlockOnComplete in class RunScriptOptions

Returns:

value

shouldWrapInInitScript

public boolean shouldWrapInInitScript()

Description copied from class: RunScriptOptions

Whether to wait until the script has completed. By default, true.

Overrides:

shouldWrapInInitScript in class RunScriptOptions

Returns:

value

copyTo

public void copyTo(TemplateOptions to)

Overrides:

copyTo in class TemplateOptions

toString

public String toString()

Overrides:

toString in class TemplateOptions

runScript

public TemplateOptions runScript(Payload script)

Description copied from class: TemplateOptions

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

See Also:

Payloads

runScript

public TemplateOptions runScript(Statement script)

Overrides:

runScript in class TemplateOptions

installPrivateKey

public TemplateOptions installPrivateKey(Payload privateKey)

Description copied from class: TemplateOptions

replaces the rsa ssh key used at login.

please use alternative that uses String

Overrides:

installPrivateKey in class TemplateOptions

See Also:

Payloads

dontAuthorizePublicKey

public TemplateOptions dontAuthorizePublicKey()

Overrides:

dontAuthorizePublicKey in class TemplateOptions

authorizePublicKey

@Deprecated
public TemplateOptions authorizePublicKey(Payload publicKey)

Deprecated.

Description copied from class: TemplateOptions

authorize an rsa ssh key.

please use alternative that uses String

Overrides:

authorizePublicKey in class TemplateOptions

See Also:

Payloads

blockOnPort

public TemplateOptions blockOnPort(int port,
                                   int seconds)

Description copied from class: RunScriptOptions

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

Overrides:

blockOnPort in class TemplateOptions

nameTask

public TemplateOptions 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 TemplateOptions runAsRoot(boolean runAsRoot)

Overrides:

runAsRoot in class TemplateOptions

overrideCredentialsWith

public TemplateOptions overrideCredentialsWith(Credentials overridingCredentials)

Overrides:

overrideCredentialsWith in class TemplateOptions

overrideLoginUserWith

public TemplateOptions overrideLoginUserWith(String loginUser)

Overrides:

overrideLoginUserWith in class TemplateOptions

overrideLoginCredentialWith

public TemplateOptions overrideLoginCredentialWith(String loginCredential)

Overrides:

overrideLoginCredentialWith in class TemplateOptions

wrapInInitScript

public TemplateOptions wrapInInitScript(boolean wrapInInitScript)

Description copied from class: RunScriptOptions

default true

Overrides:

wrapInInitScript in class TemplateOptions

Parameters:

wrapInInitScript - if the command is long-running, use this option to ensure it is wrapInInitScripted properly. (ex. have jclouds wrap it an init script, nohup, etc)

Returns:

blockOnComplete

public TemplateOptions blockOnComplete(boolean blockOnComplete)

Overrides:

blockOnComplete in class TemplateOptions

as

public <T extends TemplateOptions> T as(Class<T> clazz)

Overrides:

as in class TemplateOptions

authorizePublicKey

public TemplateOptions authorizePublicKey(String publicKey)

Description copied from class: TemplateOptions

authorize an rsa ssh key.

Overrides:

authorizePublicKey in class TemplateOptions

blockUntilRunning

public TemplateOptions blockUntilRunning(boolean blockUntilRunning)

Overrides:

blockUntilRunning in class TemplateOptions

getInboundPorts

public int[] getInboundPorts()

Overrides:

getInboundPorts in class TemplateOptions

getPrivateKey

public String getPrivateKey()

Overrides:

getPrivateKey in class TemplateOptions

getPublicKey

public String getPublicKey()

Overrides:

getPublicKey in class TemplateOptions

getRunScript

public Statement getRunScript()

Overrides:

getRunScript in class TemplateOptions

shouldBlockUntilRunning

public boolean shouldBlockUntilRunning()

Overrides:

shouldBlockUntilRunning in class TemplateOptions

inboundPorts

public TemplateOptions inboundPorts(int... ports)

Description copied from class: TemplateOptions

Opens the set of ports to public access.

Overrides:

inboundPorts in class TemplateOptions

installPrivateKey

public TemplateOptions installPrivateKey(String privateKey)

Description copied from class: TemplateOptions

replaces the rsa ssh key used at login.

Overrides:

installPrivateKey in class TemplateOptions

isIncludeMetadata

public boolean isIncludeMetadata()

Overrides:

isIncludeMetadata in class TemplateOptions

runScript

public TemplateOptions runScript(byte[] script)

Description copied from class: TemplateOptions

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

please use alternative that uses the Statement object

Overrides:

runScript in class TemplateOptions

See Also:

Payloads

withMetadata

public TemplateOptions withMetadata()

Overrides:

withMetadata in class TemplateOptions