mirror of https://github.com/apache/jclouds.git
cleared up javadoc on blockUntilRunning and blockOnComplete
This commit is contained in:
parent
46a42c22d8
commit
69e7b101bb
|
@ -185,6 +185,15 @@ public class RunScriptOptions {
|
|||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* As of version 1.1.0, we cannot kick off a script unless a node is in
|
||||
* RUNNING state.
|
||||
*
|
||||
* @param blockOnComplete (default true)
|
||||
* false means kick off the script in the background, but don't
|
||||
* wait for it to finish. (as of version 1.1.0, implemented as
|
||||
* nohup)
|
||||
*/
|
||||
public RunScriptOptions blockOnComplete(boolean blockOnComplete) {
|
||||
this.blockOnComplete = blockOnComplete;
|
||||
return this;
|
||||
|
@ -233,9 +242,7 @@ public class RunScriptOptions {
|
|||
}
|
||||
|
||||
/**
|
||||
* Whether to wait until the script has completed. By default, true.
|
||||
*
|
||||
* @return value
|
||||
* @see #blockOnComplete(boolean)
|
||||
*/
|
||||
public boolean shouldBlockOnComplete() {
|
||||
return blockOnComplete;
|
||||
|
@ -276,7 +283,10 @@ public class RunScriptOptions {
|
|||
RunScriptOptions options = new RunScriptOptions();
|
||||
return options.runAsRoot(value);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @see RunScriptOptions#blockOnComplete(boolean)
|
||||
*/
|
||||
public static RunScriptOptions blockOnComplete(boolean value) {
|
||||
RunScriptOptions options = new RunScriptOptions();
|
||||
return options.blockOnComplete(value);
|
||||
|
|
|
@ -25,6 +25,7 @@ import java.io.IOException;
|
|||
import java.util.Arrays;
|
||||
import java.util.Set;
|
||||
|
||||
import org.jclouds.compute.domain.NodeState;
|
||||
import org.jclouds.domain.Credentials;
|
||||
import org.jclouds.io.Payload;
|
||||
import org.jclouds.scriptbuilder.domain.Statement;
|
||||
|
@ -148,6 +149,9 @@ public class TemplateOptions extends RunScriptOptions implements Cloneable {
|
|||
throw new IllegalArgumentException("script is immutable");
|
||||
}
|
||||
|
||||
/**
|
||||
* unsupported as objects of this class are immutable
|
||||
*/
|
||||
@Override
|
||||
public TemplateOptions runScript(Statement script) {
|
||||
throw new IllegalArgumentException("script is immutable");
|
||||
|
@ -219,6 +223,9 @@ public class TemplateOptions extends RunScriptOptions implements Cloneable {
|
|||
throw new IllegalArgumentException("publicKey is immutable");
|
||||
}
|
||||
|
||||
/**
|
||||
* unsupported as objects of this class are immutable
|
||||
*/
|
||||
@Override
|
||||
public TemplateOptions blockUntilRunning(boolean blockUntilRunning) {
|
||||
throw new IllegalArgumentException("blockUntilRunning is immutable");
|
||||
|
@ -313,7 +320,10 @@ public class TemplateOptions extends RunScriptOptions implements Cloneable {
|
|||
public boolean isIncludeMetadata() {
|
||||
return includeMetadata;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @see TemplateOptions#blockUntilRunning(boolean)
|
||||
*/
|
||||
public boolean shouldBlockUntilRunning() {
|
||||
return blockUntilRunning;
|
||||
}
|
||||
|
@ -323,11 +333,9 @@ public class TemplateOptions extends RunScriptOptions implements Cloneable {
|
|||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
* <p/>
|
||||
* please use alternative that uses the {@link org.jclouds.scriptbuilder.domain.Statement} object
|
||||
*
|
||||
* @see TemplateOptions#runScript(Statement)
|
||||
* @see org.jclouds.io.Payloads
|
||||
*/
|
||||
@Deprecated
|
||||
|
@ -336,9 +344,7 @@ public class TemplateOptions extends RunScriptOptions implements Cloneable {
|
|||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
* @see TemplateOptions#runScript(Statement)
|
||||
* @see org.jclouds.io.Payloads
|
||||
*/
|
||||
public TemplateOptions runScript(Payload script) {
|
||||
|
@ -349,7 +355,12 @@ public class TemplateOptions extends RunScriptOptions implements Cloneable {
|
|||
return this;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
*/
|
||||
public TemplateOptions runScript(Statement script) {
|
||||
this.script = checkNotNull(script, "script");
|
||||
return this;
|
||||
|
@ -488,7 +499,7 @@ public class TemplateOptions extends RunScriptOptions implements Cloneable {
|
|||
}
|
||||
|
||||
/**
|
||||
* @see TemplateOptions#blockUntilRunning
|
||||
* @see TemplateOptions#blockUntilRunning(boolean)
|
||||
*/
|
||||
public static TemplateOptions blockUntilRunning(boolean blockUntilRunning) {
|
||||
TemplateOptions options = new TemplateOptions();
|
||||
|
@ -496,10 +507,9 @@ public class TemplateOptions extends RunScriptOptions implements Cloneable {
|
|||
}
|
||||
|
||||
/**
|
||||
* please use alternative that uses the {@link org.jclouds.io.Payload} object
|
||||
* please use alternative that uses the {@link Statement) object
|
||||
*
|
||||
* @see org.jclouds.io.Payloads
|
||||
* @see #runScript(Payload)
|
||||
* @see TemplateOptions#runScript(Statement)
|
||||
*/
|
||||
@Deprecated
|
||||
public static TemplateOptions runScript(byte[] script) {
|
||||
|
@ -508,7 +518,7 @@ public class TemplateOptions extends RunScriptOptions implements Cloneable {
|
|||
}
|
||||
|
||||
/**
|
||||
* @see TemplateOptions#runScript
|
||||
* @see TemplateOptions#runScript(Statement)
|
||||
* @see org.jclouds.io.Payloads
|
||||
*/
|
||||
public static TemplateOptions runScript(Payload script) {
|
||||
|
@ -517,8 +527,7 @@ public class TemplateOptions extends RunScriptOptions implements Cloneable {
|
|||
}
|
||||
|
||||
/**
|
||||
* @see TemplateOptions#runScript
|
||||
* @see org.jclouds.io.Payloads
|
||||
* @see TemplateOptions#runScript(Statement)
|
||||
*/
|
||||
public static TemplateOptions runScript(Statement script) {
|
||||
TemplateOptions options = new TemplateOptions();
|
||||
|
@ -587,6 +596,16 @@ public class TemplateOptions extends RunScriptOptions implements Cloneable {
|
|||
+ ", metadata/details: " + includeMetadata + "]";
|
||||
}
|
||||
|
||||
/**
|
||||
* <h4>Note</h4> As of version 1.1.0, this option is incompatible with
|
||||
* {@link TemplateOptions#runScript(Statement)} and
|
||||
* {@link RunScriptOptions#blockOnComplete(boolean)}, as all current
|
||||
* implementations utilize ssh in order to execute scripts.
|
||||
*
|
||||
* @param blockUntilRunning
|
||||
* (default true) whether to block until the nodes in this template
|
||||
* are in {@link NodeState#RUNNING} state
|
||||
*/
|
||||
public TemplateOptions blockUntilRunning(boolean blockUntilRunning) {
|
||||
this.blockUntilRunning = blockUntilRunning;
|
||||
if (!blockUntilRunning)
|
||||
|
|
|
@ -44,7 +44,7 @@ import org.jclouds.predicates.RetryablePredicate;
|
|||
import org.jclouds.rest.RestContext;
|
||||
import org.jclouds.rest.RestContextFactory;
|
||||
import org.jclouds.ssh.SshClient;
|
||||
import org.jclouds.ssh.jsch.config.JschSshClientModule;
|
||||
import org.jclouds.sshj.config.SshjSshClientModule;
|
||||
import org.testng.annotations.AfterGroups;
|
||||
import org.testng.annotations.BeforeGroups;
|
||||
|
||||
|
@ -133,7 +133,7 @@ public class BaseCloudStackClientLiveTest {
|
|||
"invalid account type: %s, please specify an apiKey of a USER, for example: %s", currentUser
|
||||
.getAccountType(), Iterables.filter(users, UserPredicates.isUserAccount())));
|
||||
|
||||
injector = Guice.createInjector(new JschSshClientModule(), new Log4JLoggingModule());
|
||||
injector = Guice.createInjector(new SshjSshClientModule(), new Log4JLoggingModule());
|
||||
sshFactory = injector.getInstance(SshClient.Factory.class);
|
||||
socketTester = new RetryablePredicate<IPSocket>(new InetSocketAddressConnect(), 180, 1, 1, TimeUnit.SECONDS);
|
||||
injector.injectMembers(socketTester);
|
||||
|
|
Loading…
Reference in New Issue