com.heroku
Class WorkspaceDeployment

java.lang.Object
  hudson.tasks.BuildStepCompatibilityLayer
      hudson.tasks.Builder
          com.heroku.AbstractArtifactDeployment
              com.heroku.WorkspaceDeployment

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep

public class WorkspaceDeployment
extends AbstractArtifactDeployment

Author:

Ryan Brainard

Nested Class Summary

static class	AbstractHerokuBuildStep.AbstractHerokuBuildStepDescriptor
static class	WorkspaceDeployment.WorkspaceDeploymentDescriptor

Nested classes/interfaces inherited from class com.heroku.AbstractArtifactDeployment

AbstractArtifactDeployment.AbstractArtifactDeploymentDescriptor, AbstractArtifactDeployment.RemoteCallable

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.heroku.AbstractArtifactDeployment

artifactPaths, PROCFILE_PATH, TARGZ_PATH, TARGZ_PIPELINE, WAR_PATH, WAR_PIPELINE

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

WorkspaceDeployment(String apiKey, String appName, String globIncludes, String globExcludes, String procfilePath)

Method Summary

String	getApiKey() Not for use by tasks needing the API key.
String	getAppName()
protected String	getEffectiveApiKey() If an API key is not explicitly defined for this specific build step, the default key from HerokuPlugin is used.
String	getGlobExcludes()
String	getGlobIncludes()
protected com.heroku.api.App	getOrCreateApp(hudson.model.BuildListener listener, com.heroku.api.HerokuAPI api)
String	getProcfilePath()
boolean	perform(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener)
boolean	perform(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener, com.heroku.api.HerokuAPI api, com.heroku.api.App app) Subclasses should override this to get access to the Heroku API with the context of an app

Methods inherited from class com.heroku.AbstractArtifactDeployment

getDescriptor

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, prebuild

Constructor Detail

WorkspaceDeployment

@DataBoundConstructor
public WorkspaceDeployment(String apiKey,
                                                String appName,
                                                String globIncludes,
                                                String globExcludes,
                                                String procfilePath)

Method Detail

getAppName

public String getAppName()

getApiKey

public String getApiKey()

Not for use by tasks needing the API key. You probably want to use getEffectiveApiKey() instead.

Returns:

API key explicitly set for this build step

getGlobIncludes

public String getGlobIncludes()

getGlobExcludes

public String getGlobExcludes()

getProcfilePath

public String getProcfilePath()

perform

public boolean perform(hudson.model.AbstractBuild build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener,
                       com.heroku.api.HerokuAPI api,
                       com.heroku.api.App app)

Subclasses should override this to get access to the Heroku API with the context of an app

Overrides:

perform in class AbstractArtifactDeployment

getEffectiveApiKey

protected String getEffectiveApiKey()

If an API key is not explicitly defined for this specific build step, the default key from HerokuPlugin is used.

Returns:

API key tasks should use

getOrCreateApp

protected com.heroku.api.App getOrCreateApp(hudson.model.BuildListener listener,
                                            com.heroku.api.HerokuAPI api)

perform

public boolean perform(hudson.model.AbstractBuild build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws IOException,
                       InterruptedException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

IOException

InterruptedException