com.openshift.jenkins.plugins.pipeline.model

Interface IOpenShiftPlugin

All Superinterfaces:

IOpenShiftParameterOverrides

All Known Subinterfaces:

IOpenShiftApiObjHandler, IOpenShiftBuilder, IOpenShiftBuildVerifier, IOpenShiftCreator, IOpenShiftDeleterJsonYaml, IOpenShiftDeleterLabels, IOpenShiftDeleterList, IOpenShiftDeployer, IOpenShiftDeploymentVerification, IOpenShiftExec, IOpenShiftImageTagger, IOpenShiftScaler, IOpenShiftServiceVerifier, ITimedOpenShiftPlugin

All Known Implementing Classes:

OpenShiftBasePostAction, OpenShiftBaseStep, OpenShiftBaseStep, OpenShiftBuildCanceller, OpenShiftBuilder, OpenShiftBuilder, OpenShiftBuildVerifier, OpenShiftBuildVerifier, OpenShiftCreator, OpenShiftCreator, OpenShiftDeleterJsonYaml, OpenShiftDeleterJsonYaml, OpenShiftDeleterLabels, OpenShiftDeleterLabels, OpenShiftDeleterList, OpenShiftDeleterList, OpenShiftDeployCanceller, OpenShiftDeployer, OpenShiftDeployer, OpenShiftDeploymentVerifier, OpenShiftDeploymentVerifier, OpenShiftExec, OpenShiftExec, OpenShiftImageStreams, OpenShiftImageTagger, OpenShiftImageTagger, OpenShiftScaler, OpenShiftScaler, OpenShiftScalerPostAction, OpenShiftServiceVerifier, OpenShiftServiceVerifier, TimedOpenShiftBasePostAction, TimedOpenShiftBaseStep, TimedOpenShiftBaseStep

public interface IOpenShiftPlugin
extends IOpenShiftParameterOverrides

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANNOTATION_FAILURE
static String	BUILD_NUMBER
static String	BUILD_URL_ANNOTATION
static String	BUILD_URL_ENV_KEY
static String	JOB_NAME
static String	KUBERNETES_MASTER_ENV_KEY
static String	KUBERNETES_SERVICE_HOST_ENV_KEY
static String	KUBERNETES_SERVICE_PORT_ENV_KEY
static String	NAMESPACE_ENV_VAR
static String	NAMESPACE_FILE
static String	NAMESPACE_SYNC_BUILD_CAUSE
static String	STATE_CANCELLED
static String	STATE_COMPLETE
static String	STATE_ERROR
static String	STATE_FAILED
static String	STATE_RUNNING

Method Summary

Modifier and Type	Method and Description
default boolean	annotateJobInfoToResource(com.openshift.restclient.IClient client, hudson.model.TaskListener listener, boolean chatty, Map<String,String> env, com.openshift.restclient.model.IResource resource)
default Map<String,String>	consolidateEnvVars(hudson.model.TaskListener listener, hudson.EnvVars env, hudson.model.Run<?,?> run, hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, boolean chatty)
default Map<String,String>	constructBuildUrl(hudson.model.TaskListener listener, Map<String,String> overrides, boolean chatty)
boolean	coreLogic(hudson.Launcher launcher, hudson.model.TaskListener listener, Map<String,String> overrides)
default boolean	didAllImagesChangeIfNeeded(String buildConfig, hudson.model.TaskListener listener, boolean chatty, com.openshift.restclient.IClient client, String namespace, long wait, boolean annotateRC, Map<String,String> env)
default boolean	didICTCauseDeployment(com.openshift.restclient.IClient client, com.openshift.restclient.model.IDeploymentConfig dc, String imageTag, boolean chatty, hudson.model.TaskListener listener, long wait)
default boolean	didImageChangeFromPreviousVersion(com.openshift.restclient.IClient client, int latestVersion, boolean chatty, hudson.model.TaskListener listener, String depCfg, String namespace, String latestImageHexID, String imageTag)
default boolean	doesDCTriggerOnImageTag(com.openshift.restclient.IClient client, com.openshift.restclient.model.IDeploymentConfig dc, String imageTag, boolean chatty, hudson.model.TaskListener listener)
default boolean	doIt(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
default void	doIt(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
default boolean	doItCore(hudson.model.TaskListener listener, hudson.EnvVars env, hudson.model.Run<?,?> run, hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher)
String	getApiURL()
default String	getApiURL(Map<String,String> overrides)
Auth	getAuth()
String	getAuthToken()
default String	getAuthToken(Map<String,String> overrides)
String	getBaseClassName()
default com.openshift.restclient.IClient	getClient(hudson.model.TaskListener listener, String displayName, Map<String,String> overrides)
default com.openshift.restclient.IClient	getClient(hudson.model.TaskListener listener, String displayName, Map<String,String> overrides, String token)
String	getDisplayName()
default com.openshift.restclient.model.IReplicationController	getLatestReplicationController(com.openshift.restclient.model.IDeploymentConfig dc, String namespace, com.openshift.restclient.IClient client, hudson.model.TaskListener listener)
String	getNamespace()
default String	getNamespace(Map<String,String> overrides)
default String	getReplicationControllerState(com.openshift.restclient.model.IReplicationController rc)
String	getVerbose()
default String	getVerbose(Map<String,String> overrides)
default String	httpGet(boolean chatty, hudson.model.TaskListener listener, Map<String,String> overrides, String urlString)
default boolean	isBuildFinished(String bldState)
default boolean	isBuildRunning(String bldState)
default boolean	isDeployFinished(String deployState)
default boolean	isReplicationControllerScaledAppropriately(com.openshift.restclient.model.IReplicationController rc, boolean checkCount, int count)
void	setAuth(Auth auth)
default boolean	verifyBuild(long startTime, long wait, com.openshift.restclient.IClient client, String bldCfg, String bldId, String namespace, boolean chatty, hudson.model.TaskListener listener, String displayName, boolean checkDeps, boolean annotateRC, Map<String,String> env)

Methods inherited from interface com.openshift.jenkins.plugins.pipeline.model.IOpenShiftParameterOverrides

getOverride, pruneKey

Field Detail

ANNOTATION_FAILURE

static final String ANNOTATION_FAILURE

See Also:

Constant Field Values

BUILD_URL_ENV_KEY

static final String BUILD_URL_ENV_KEY

See Also:

Constant Field Values

JOB_NAME

static final String JOB_NAME

See Also:

Constant Field Values

BUILD_NUMBER

static final String BUILD_NUMBER

See Also:

Constant Field Values

BUILD_URL_ANNOTATION

static final String BUILD_URL_ANNOTATION

See Also:

Constant Field Values

KUBERNETES_SERVICE_HOST_ENV_KEY

static final String KUBERNETES_SERVICE_HOST_ENV_KEY

See Also:

Constant Field Values

KUBERNETES_SERVICE_PORT_ENV_KEY

static final String KUBERNETES_SERVICE_PORT_ENV_KEY

See Also:

Constant Field Values

KUBERNETES_MASTER_ENV_KEY

static final String KUBERNETES_MASTER_ENV_KEY

See Also:

Constant Field Values

NAMESPACE_FILE

static final String NAMESPACE_FILE

See Also:

Constant Field Values

NAMESPACE_ENV_VAR

static final String NAMESPACE_ENV_VAR

See Also:

Constant Field Values

NAMESPACE_SYNC_BUILD_CAUSE

static final String NAMESPACE_SYNC_BUILD_CAUSE

See Also:

Constant Field Values

STATE_RUNNING

static final String STATE_RUNNING

See Also:

Constant Field Values

STATE_COMPLETE

static final String STATE_COMPLETE

See Also:

Constant Field Values

STATE_CANCELLED

static final String STATE_CANCELLED

See Also:

Constant Field Values

STATE_ERROR

static final String STATE_ERROR

See Also:

Constant Field Values

STATE_FAILED

static final String STATE_FAILED

See Also:

Constant Field Values

Method Detail

getBaseClassName

String getBaseClassName()

getAuthToken

String getAuthToken()

getAuthToken

default String getAuthToken(Map<String,String> overrides)

getVerbose

String getVerbose()

getVerbose

default String getVerbose(Map<String,String> overrides)

getAuth

Auth getAuth()

setAuth

void setAuth(Auth auth)

getApiURL

String getApiURL()

getApiURL

default String getApiURL(Map<String,String> overrides)

getNamespace

String getNamespace()

getNamespace

default String getNamespace(Map<String,String> overrides)

coreLogic

boolean coreLogic(hudson.Launcher launcher,
                  hudson.model.TaskListener listener,
                  Map<String,String> overrides)
           throws InterruptedException

Throws:

InterruptedException

getClient

default com.openshift.restclient.IClient getClient(hudson.model.TaskListener listener,
                                                   String displayName,
                                                   Map<String,String> overrides)

getClient

default com.openshift.restclient.IClient getClient(hudson.model.TaskListener listener,
                                                   String displayName,
                                                   Map<String,String> overrides,
                                                   String token)

getReplicationControllerState

default String getReplicationControllerState(com.openshift.restclient.model.IReplicationController rc)

isReplicationControllerScaledAppropriately

default boolean isReplicationControllerScaledAppropriately(com.openshift.restclient.model.IReplicationController rc,
                                                           boolean checkCount,
                                                           int count)

consolidateEnvVars

default Map<String,String> consolidateEnvVars(hudson.model.TaskListener listener,
                                              hudson.EnvVars env,
                                              hudson.model.Run<?,?> run,
                                              hudson.model.AbstractBuild<?,?> build,
                                              hudson.Launcher launcher,
                                              boolean chatty)

constructBuildUrl

default Map<String,String> constructBuildUrl(hudson.model.TaskListener listener,
                                             Map<String,String> overrides,
                                             boolean chatty)

doItCore

default boolean doItCore(hudson.model.TaskListener listener,
                         hudson.EnvVars env,
                         hudson.model.Run<?,?> run,
                         hudson.model.AbstractBuild<?,?> build,
                         hudson.Launcher launcher)
                  throws InterruptedException

Throws:

InterruptedException

getDisplayName

String getDisplayName()

doIt

default void doIt(hudson.model.Run<?,?> run,
                  hudson.FilePath workspace,
                  hudson.Launcher launcher,
                  hudson.model.TaskListener listener)
           throws InterruptedException,
                  IOException

Throws:

InterruptedException

IOException

doIt

default boolean doIt(hudson.model.AbstractBuild<?,?> build,
                     hudson.Launcher launcher,
                     hudson.model.BuildListener listener)
              throws IOException,
                     InterruptedException

Throws:

IOException

InterruptedException

isBuildRunning

default boolean isBuildRunning(String bldState)

isBuildFinished

default boolean isBuildFinished(String bldState)

isDeployFinished

default boolean isDeployFinished(String deployState)

verifyBuild

default boolean verifyBuild(long startTime,
                            long wait,
                            com.openshift.restclient.IClient client,
                            String bldCfg,
                            String bldId,
                            String namespace,
                            boolean chatty,
                            hudson.model.TaskListener listener,
                            String displayName,
                            boolean checkDeps,
                            boolean annotateRC,
                            Map<String,String> env)
                     throws InterruptedException

Throws:

InterruptedException

doesDCTriggerOnImageTag

default boolean doesDCTriggerOnImageTag(com.openshift.restclient.IClient client,
                                        com.openshift.restclient.model.IDeploymentConfig dc,
                                        String imageTag,
                                        boolean chatty,
                                        hudson.model.TaskListener listener)

didICTCauseDeployment

default boolean didICTCauseDeployment(com.openshift.restclient.IClient client,
                                      com.openshift.restclient.model.IDeploymentConfig dc,
                                      String imageTag,
                                      boolean chatty,
                                      hudson.model.TaskListener listener,
                                      long wait)
                               throws InterruptedException

Throws:

InterruptedException

didImageChangeFromPreviousVersion

default boolean didImageChangeFromPreviousVersion(com.openshift.restclient.IClient client,
                                                  int latestVersion,
                                                  boolean chatty,
                                                  hudson.model.TaskListener listener,
                                                  String depCfg,
                                                  String namespace,
                                                  String latestImageHexID,
                                                  String imageTag)

didAllImagesChangeIfNeeded

default boolean didAllImagesChangeIfNeeded(String buildConfig,
                                           hudson.model.TaskListener listener,
                                           boolean chatty,
                                           com.openshift.restclient.IClient client,
                                           String namespace,
                                           long wait,
                                           boolean annotateRC,
                                           Map<String,String> env)
                                    throws InterruptedException

Throws:

InterruptedException

getLatestReplicationController

default com.openshift.restclient.model.IReplicationController getLatestReplicationController(com.openshift.restclient.model.IDeploymentConfig dc,
                                                                                             String namespace,
                                                                                             com.openshift.restclient.IClient client,
                                                                                             hudson.model.TaskListener listener)

annotateJobInfoToResource

default boolean annotateJobInfoToResource(com.openshift.restclient.IClient client,
                                          hudson.model.TaskListener listener,
                                          boolean chatty,
                                          Map<String,String> env,
                                          com.openshift.restclient.model.IResource resource)

httpGet

default String httpGet(boolean chatty,
                       hudson.model.TaskListener listener,
                       Map<String,String> overrides,
                       String urlString)