com.cloudbees.plugins.deployer

Class DeployNowRunAction

java.lang.Object

com.cloudbees.plugins.deployer.DeployNowRunAction

All Implemented Interfaces:

Action, ModelObject, RunAction

@ExportedBean
public class DeployNowRunAction
extends Object
implements RunAction

An action for deploying a build's artifacts now.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeployNowRunAction.Deployer
static class	DeployNowRunAction.RunListenerImpl
static class	DeployNowRunAction.TransientBuildActionFactoryImpl Now that we are past 1.458 we can rely on TransientBuildActionFactory.

Field Summary

Fields

Modifier and Type	Field and Description
static Permission	CONFIGURE
static Permission	DEPLOY
static PermissionGroup	DEPLOY_NOW
static Permission	JOB_AUTH
static Permission	OWN_AUTH

Constructor Summary

Constructors

Constructor and Description
DeployNowRunAction()
DeployNowRunAction(Run<?,?> owner)

Method Summary

Modifier and Type	Method and Description
DeployHostsContext<DeployNowRunAction>	createHostsContext() Called by stapler to create the DeployHostsContext.
org.kohsuke.stapler.HttpResponse	doDeploy(org.kohsuke.stapler.StaplerRequest req)
void	doDeployText(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Sends out the raw console output.
org.kohsuke.stapler.HttpResponse	doIndex(org.kohsuke.stapler.StaplerRequest req)
Charset	getCharset() Gets the charset in which the log file is written.
String	getDisplayName()
String	getIconFileName()
List<String>	getLog(int maxLines)
File	getLogFile() Returns the log file.
InputStream	getLogInputStream() Returns an input stream that reads from the log file.
Reader	getLogReader()
AnnotatedLargeText	getLogText() Used to URL-bind AnnotatedLargeText.
Run	getOwner()
Set<DeploySourceOrigin>	getSources()
String	getUrlName()
boolean	isHasOutput()
boolean	isLogUpdated() Returns true if the log file is still being updated.
boolean	isOneClickDeploy()
boolean	isOneClickDeployPossible()
boolean	isOneClickDeployValid()
boolean	isSaveConfigForced()
void	onAttached(Run r)
void	onBuildComplete()
void	onLoad()
protected void	run(DeployNowRunAction.Deployer deployer)
void	writeLogTo(long offset, org.apache.commons.jelly.XMLOutput out) Used from console.jelly to write annotated log to the given output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEPLOY_NOW

public static final PermissionGroup DEPLOY_NOW

CONFIGURE

public static final Permission CONFIGURE

DEPLOY

public static final Permission DEPLOY

OWN_AUTH

public static final Permission OWN_AUTH

JOB_AUTH

public static final Permission JOB_AUTH

Constructor Detail

DeployNowRunAction

public DeployNowRunAction()

DeployNowRunAction

public DeployNowRunAction(Run<?,?> owner)

Method Detail

createHostsContext

public DeployHostsContext<DeployNowRunAction> createHostsContext()

Called by stapler to create the DeployHostsContext.

Returns:

the context.

isOneClickDeployPossible

@Exported(name="oneClickDeployPossible",
          visibility=2)
public boolean isOneClickDeployPossible()

isOneClickDeploy

@Exported(name="oneClickDeployReady",
          visibility=2)
public boolean isOneClickDeploy()

isOneClickDeployValid

@Exported(name="oneClickDeployValid",
          visibility=2)
public boolean isOneClickDeployValid()

isSaveConfigForced

public boolean isSaveConfigForced()

doIndex

public org.kohsuke.stapler.HttpResponse doIndex(org.kohsuke.stapler.StaplerRequest req)

doDeploy

public org.kohsuke.stapler.HttpResponse doDeploy(org.kohsuke.stapler.StaplerRequest req)
                                          throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getSources

public Set<DeploySourceOrigin> getSources()

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

onLoad

public void onLoad()

Specified by:

onLoad in interface RunAction

onAttached

public void onAttached(Run r)

Specified by:

onAttached in interface RunAction

onBuildComplete

public void onBuildComplete()

Specified by:

onBuildComplete in interface RunAction

getOwner

public Run getOwner()

isHasOutput

public boolean isHasOutput()

getLogFile

public File getLogFile()

Returns the log file.

isLogUpdated

public boolean isLogUpdated()

Returns true if the log file is still being updated.

getCharset

public final Charset getCharset()

Gets the charset in which the log file is written.

Returns:

never null.

doDeployText

public void doDeployText(org.kohsuke.stapler.StaplerRequest req,
                         org.kohsuke.stapler.StaplerResponse rsp)
                  throws IOException

Sends out the raw console output.

Throws:

IOException

getLogInputStream

public InputStream getLogInputStream()
                              throws IOException

Returns an input stream that reads from the log file. It will use a gzip-compressed log file (log.gz) if that exists.

Returns:

an input stream from the log file, or null if none exists

Throws:

IOException

getLogReader

public Reader getLogReader()
                    throws IOException

Throws:

IOException

writeLogTo

public void writeLogTo(long offset,
                       org.apache.commons.jelly.XMLOutput out)
                throws IOException

Used from console.jelly to write annotated log to the given output.

Throws:

IOException

getLogText

public AnnotatedLargeText getLogText()

Used to URL-bind AnnotatedLargeText.

getLog

public List<String> getLog(int maxLines)
                    throws IOException

Throws:

IOException

run

protected final void run(DeployNowRunAction.Deployer deployer)