hudson.scm
Class IntegrityItemAction

java.lang.Object
  hudson.tasks.BuildStepCompatibilityLayer
      hudson.tasks.Publisher
          hudson.tasks.Notifier
              hudson.scm.IntegrityItemAction

All Implemented Interfaces:

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

public class IntegrityItemAction
extends hudson.tasks.Notifier

Nested Class Summary

static class

IntegrityItemAction.IntegrityItemDescriptorImpl The relationship of Descriptor and IntegrityItemAction (the describable) is akin to class and object.

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

hudson.tasks.BuildStep.PublisherList

Field Summary

static IntegrityItemAction.IntegrityItemDescriptorImpl

ITEM_DESCRIPTOR

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

IntegrityItemAction()

Method Summary

APISession	createAPISession() Creates an authenticated API Session against the Integrity (Workflow) Server
hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>	getDescriptor() Return the instance of DescriptorImpl object for this class
String	getFailureValue() Returns the failure value that will be set when the build has failed
String	getHostName() Returns the host name of the Integrity (Workflow) Server
String	getLogField() Returns the log field associated with the "build" item
String	getPassword() Returns the clear password of the user connecting to the Integrity (Workflow) Server
int	getPort() Returns the port of the Integrity (Workflow) Server
String	getQueryDefinition() Returns the query definition expression
hudson.tasks.BuildStepMonitor	getRequiredMonitorService() Returns the build step we're monitoring
boolean	getSecure() Returns true/false depending on secure sockets are enabled
String	getStateField() Returns the status/state field for the "build" item
String	getSuccessValue() Returns the success value that will be set when the build is a success
String	getUserName() Returns the User connecting to the Integrity (Workflow) Server
boolean	needsToRunAfterFinalized() Toggles whether or not this needs to run after build is finalized
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Executes the actual Integrity Update Item operation
void	setFailureValue(String failureValue) Sets the failure value that will be set when the build has failed
void	setHostName(String hostName) Sets the host name of the Integrity (Workflow) Server
void	setLogField(String logField) Sets the log field associated with the "build" item
void	setPassword(String password) Sets the encrypted Password of the user connecting to the Integrity (Workflow) Server
void	setPort(int port) Sets the port of the Integrity (Workflow) Server
void	setQueryDefinition(String queryDefinition) Sets the query definition expression to obtain the build item
void	setSecure(boolean secure) Toggles whether or not secure sockets are enabled
void	setStateField(String stateField) Sets the status/state field for the "build" item
void	setSuccessValue(String successValue) Sets the success value that will be used when the build is a success
void	setUserName(String userName) Sets the User connecting to the Integrity (Workflow) Server

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRun, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

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

ITEM_DESCRIPTOR

@Extension
public static final IntegrityItemAction.IntegrityItemDescriptorImpl ITEM_DESCRIPTOR

Constructor Detail

IntegrityItemAction

public IntegrityItemAction()

Method Detail

getHostName

public String getHostName()

Returns the host name of the Integrity (Workflow) Server

Returns:

getPort

public int getPort()

Returns the port of the Integrity (Workflow) Server

Returns:

getSecure

public boolean getSecure()

Returns true/false depending on secure sockets are enabled

Returns:

getUserName

public String getUserName()

Returns the User connecting to the Integrity (Workflow) Server

Returns:

getPassword

public String getPassword()

Returns the clear password of the user connecting to the Integrity (Workflow) Server

Returns:

getQueryDefinition

public String getQueryDefinition()

Returns the query definition expression

Returns:

Query Definition

getStateField

public String getStateField()

Returns the status/state field for the "build" item

Returns:

getSuccessValue

public String getSuccessValue()

Returns the success value that will be set when the build is a success

Returns:

getFailureValue

public String getFailureValue()

Returns the failure value that will be set when the build has failed

Returns:

getLogField

public String getLogField()

Returns the log field associated with the "build" item

Returns:

setHostName

public void setHostName(String hostName)

Sets the host name of the Integrity (Workflow) Server

Parameters:

hostName -

setPort

public void setPort(int port)

Sets the port of the Integrity (Workflow) Server

Parameters:

port -

setSecure

public void setSecure(boolean secure)

Toggles whether or not secure sockets are enabled

Parameters:

secure -

setUserName

public void setUserName(String userName)

Sets the User connecting to the Integrity (Workflow) Server

Parameters:

userName -

setPassword

public void setPassword(String password)

Sets the encrypted Password of the user connecting to the Integrity (Workflow) Server

Parameters:

password -

setQueryDefinition

public void setQueryDefinition(String queryDefinition)

Sets the query definition expression to obtain the build item

Parameters:

queryDefinition - Query Definition Expression

setStateField

public void setStateField(String stateField)

Sets the status/state field for the "build" item

Parameters:

stateField - Status/State field

setSuccessValue

public void setSuccessValue(String successValue)

Sets the success value that will be used when the build is a success

Parameters:

successValue - Value to be set when the build is a success

setFailureValue

public void setFailureValue(String failureValue)

Sets the failure value that will be set when the build has failed

Parameters:

failureValue - Value to be set when the build has failed

setLogField

public void setLogField(String logField)

Sets the log field associated with the "build" item

Parameters:

logField - Log field that is used to store the build log

createAPISession

public APISession createAPISession()

Creates an authenticated API Session against the Integrity (Workflow) Server

Returns:

An authenticated API Session

perform

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

Executes the actual Integrity Update Item operation

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

InterruptedException

IOException

needsToRunAfterFinalized

public boolean needsToRunAfterFinalized()

Toggles whether or not this needs to run after build is finalized

Overrides:

needsToRunAfterFinalized in class hudson.tasks.Publisher

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Returns the build step we're monitoring

getDescriptor

public hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher> getDescriptor()

Return the instance of DescriptorImpl object for this class

Specified by:

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

Overrides:

getDescriptor in class hudson.tasks.Notifier