hudson.plugins.claim

Class AbstractClaimBuildAction<T extends hudson.model.Saveable>

java.lang.Object

hudson.tasks.junit.TestAction

hudson.plugins.claim.DescribableTestAction

hudson.plugins.claim.AbstractClaimBuildAction<T>

All Implemented Interfaces:

hudson.model.Action, hudson.model.BuildBadgeAction, hudson.model.Describable<DescribableTestAction>, hudson.model.ModelObject, hudson.model.ProminentProjectAction

Direct Known Subclasses:

ClaimBuildAction, ClaimTestAction

@ExportedBean(defaultVisibility=2)
public abstract class AbstractClaimBuildAction<T extends hudson.model.Saveable>
extends DescribableTestAction
implements hudson.model.BuildBadgeAction, hudson.model.ProminentProjectAction

Nested Class Summary

Nested classes/interfaces inherited from class hudson.plugins.claim.DescribableTestAction

DescribableTestAction.DescriptorImpl

Field Summary

Fields inherited from class hudson.plugins.claim.DescribableTestAction

DESCRIPTOR

Method Summary

Modifier and Type	Method and Description
protected void	applyClaim(String claimedByUser, String providedReason, String assignedByUser, Date date, boolean isSticky, boolean isPropagated) Applies the claim data to the AbstractClaimBuildAction.
protected void	applyUnclaim() Removes the claim data to the AbstractClaimBuildAction.
boolean	canClaim()
boolean	canReassign()
boolean	canRelease()
void	claim(String claimedByUser, String providedReason, String assignedByUser, boolean isSticky) Deprecated. use claim(String, String, String, Date, boolean, boolean, boolean)
void	claim(String claimedByUser, String providedReason, String assignedByUser, Date date, boolean isSticky, boolean isPropagated, boolean notify) Claims a Saveable, and optionally notifies of the claim.
protected void	copyTo(AbstractClaimBuildAction<T> other) Claim a new Saveable with the same settings as this one.
void	doClaim(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse resp)
void	doUnclaim(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse resp)
protected void	evalGroovyScript()
String	getAssignedBy()
String	getAssignedByName()
ClaimBuildFailureAnalyzer	getBfaClaimer()
Date	getClaimDate()
String	getClaimedBy()
String	getClaimedByName()
String	getError()
String	getIconFileName()
CommonMessagesProvider	getMessageProvider()
protected abstract Optional<AbstractClaimBuildAction>	getNextAction()
abstract String	getNoun()
protected abstract T	getOwner()
String	getReason()
String	getReason(String error)
String	getUrlName()
boolean	hasClaimDate()
boolean	hasReason()
boolean	isBFAEnabled()
boolean	isClaimed()
boolean	isClaimedByMe()
boolean	isPropagateToFollowingBuildsByDefault()
boolean	isReclaim() Deprecated. use isClaimed() instead
boolean	isSelfAssigned() Was the action claimed by someone to themselves?
boolean	isSticky()
boolean	isTransientClaim()
boolean	isUserAnonymous()
void	preventRefresh(org.kohsuke.stapler.StaplerResponse response)
void	setAssignedBy(String assignedBy)
void	setClaimedBy(String claimedBy)
void	setReason(String reason)
void	setSticky(boolean sticky)
void	setTransientClaim(boolean transientClaim)
void	unclaim() Deprecated. use unclaim(boolean)
void	unclaim(boolean notify) Deprecated. use unclaim(boolean)

Methods inherited from class hudson.plugins.claim.DescribableTestAction

getDescriptor

Methods inherited from class hudson.tasks.junit.TestAction

annotate

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Action

getDisplayName

Method Detail

getOwner

protected abstract T getOwner()

getMessageProvider

public final CommonMessagesProvider getMessageProvider()

isReclaim

@Deprecated
public final boolean isReclaim()

Deprecated. use isClaimed() instead

Indicates if the Saveable is claimed.

Returns:

true if the Saveable is claimed, else false

getBfaClaimer

public final ClaimBuildFailureAnalyzer getBfaClaimer()

getIconFileName

public final String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

getUrlName

public final String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action

doClaim

public final void doClaim(org.kohsuke.stapler.StaplerRequest req,
                          org.kohsuke.stapler.StaplerResponse resp)
                   throws Exception

Throws:

Exception

claim

@Deprecated
public final void claim(String claimedByUser,
                                     String providedReason,
                                     String assignedByUser,
                                     boolean isSticky)

Deprecated. use claim(String, String, String, Date, boolean, boolean, boolean)

Claims a Saveable.

Parameters:

claimedByUser - name of the claiming user

providedReason - reason for the claim

assignedByUser - name of the assigned user

isSticky - true if the claim has to be kept until resolution

claim

public final void claim(String claimedByUser,
                        String providedReason,
                        String assignedByUser,
                        Date date,
                        boolean isSticky,
                        boolean isPropagated,
                        boolean notify)

Claims a Saveable, and optionally notifies of the claim.

Parameters:

claimedByUser - name of the claiming user

providedReason - reason for the claim

assignedByUser - name of the assigner user

date - date of the claim

isSticky - true if the claim has to be kept until resolution

isPropagated - true if the claim has to be propagated to following builds

notify - true if notifications have to be sent

applyClaim

protected void applyClaim(String claimedByUser,
                          String providedReason,
                          String assignedByUser,
                          Date date,
                          boolean isSticky,
                          boolean isPropagated)

Applies the claim data to the AbstractClaimBuildAction.

Parameters:

claimedByUser - name of the claiming user

providedReason - reason for the claim

assignedByUser - name of the assigner user

date - date of the claim

isSticky - true if the claim has to be kept until resolution

isPropagated - true if the claim has to be propagated to following builds

getNextAction

protected abstract Optional<AbstractClaimBuildAction> getNextAction()

doUnclaim

public final void doUnclaim(org.kohsuke.stapler.StaplerRequest req,
                            org.kohsuke.stapler.StaplerResponse resp)
                     throws javax.servlet.ServletException,
                            IOException

Throws:

javax.servlet.ServletException

IOException

unclaim

@Deprecated
public final void unclaim()

Deprecated. use unclaim(boolean)

Unclaims a Saveable.

unclaim

public final void unclaim(boolean notify)

Deprecated. use unclaim(boolean)

Unclaims a Saveable, and optionally notifies of the unclaim.

Parameters:

notify - true if notifications have to be sent

applyUnclaim

protected void applyUnclaim()

Removes the claim data to the AbstractClaimBuildAction.

getClaimedBy

@Exported
public final String getClaimedBy()

getAssignedBy

@Exported
public final String getAssignedBy()

getClaimedByName

public final String getClaimedByName()

getAssignedByName

public final String getAssignedByName()

setClaimedBy

public final void setClaimedBy(String claimedBy)

setAssignedBy

public final void setAssignedBy(String assignedBy)

isClaimed

@Exported
public final boolean isClaimed()

copyTo

protected void copyTo(AbstractClaimBuildAction<T> other)

Claim a new Saveable with the same settings as this one.

Parameters:

other - the source data

isClaimedByMe

public final boolean isClaimedByMe()

canReassign

public final boolean canReassign()

canClaim

public final boolean canClaim()

canRelease

public final boolean canRelease()

isUserAnonymous

public final boolean isUserAnonymous()

getReason

@Exported
public final String getReason()

getReason

@JavaScriptMethod
public final String getReason(String error)
                                          throws Exception

Throws:

Exception

preventRefresh

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
public final void preventRefresh(org.kohsuke.stapler.StaplerResponse response)

setReason

public final void setReason(String reason)

hasReason

public final boolean hasReason()

isTransientClaim

public final boolean isTransientClaim()

setTransientClaim

public final void setTransientClaim(boolean transientClaim)

isSticky

public final boolean isSticky()

setSticky

public final void setSticky(boolean sticky)

isPropagateToFollowingBuildsByDefault

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
public final boolean isPropagateToFollowingBuildsByDefault()

getError

public final String getError()

isBFAEnabled

public final boolean isBFAEnabled()

getClaimDate

@Exported
public final Date getClaimDate()

hasClaimDate

public final boolean hasClaimDate()

isSelfAssigned

public boolean isSelfAssigned()

Was the action claimed by someone to themselves?

Returns:

true if the item was claimed by the user to themselves, false otherwise

getNoun

public abstract String getNoun()

evalGroovyScript

protected final void evalGroovyScript()