com.heroku
Class AbstractArtifactDeployment

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

All Implemented Interfaces:

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

Direct Known Subclasses:

TarGzDeployment, WarDeployment

public abstract class AbstractArtifactDeployment
extends hudson.tasks.Builder

Author:

Ryan Brainard

Nested Class Summary

static class	AbstractArtifactDeployment.AbstractArtifactDeploymentDescriptor
static class	AbstractHerokuBuildStep.AbstractHerokuBuildStepDescriptor

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

protected Map<String,String>

artifactPaths

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

protected

AbstractArtifactDeployment(String apiKey, String appName, Map<String,String> artifactPaths)

Method Summary

String	getApiKey() Not for use by tasks needing the API key.
String	getAppName()
AbstractArtifactDeployment.AbstractArtifactDeploymentDescriptor	getDescriptor()
protected String	getEffectiveApiKey() If an API key is not explicitly defined for this specific build step, the default key from HerokuPlugin is used.
protected com.heroku.api.App	getOrCreateApp(hudson.model.BuildListener listener, com.heroku.api.HerokuAPI api)
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 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

Field Detail

artifactPaths

protected final Map<String,String> artifactPaths

Constructor Detail

AbstractArtifactDeployment

protected AbstractArtifactDeployment(String apiKey,
                                     String appName,
                                     Map<String,String> artifactPaths)

Method Detail

perform

public final 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

getDescriptor

public AbstractArtifactDeployment.AbstractArtifactDeploymentDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

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

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