org.jenkinsci.plugins.builduser.varsetter.impl

Class SCMTriggerCauseDeterminant

java.lang.Object

org.jenkinsci.plugins.builduser.varsetter.impl.SCMTriggerCauseDeterminant

All Implemented Interfaces:

IUsernameSettable<hudson.triggers.SCMTrigger.SCMTriggerCause>

public class SCMTriggerCauseDeterminant
extends Object
implements IUsernameSettable<hudson.triggers.SCMTrigger.SCMTriggerCause>

Field Summary

Fields inherited from interface org.jenkinsci.plugins.builduser.varsetter.IUsernameSettable

BUILD_USER_FIRST_NAME_VAR_NAME, BUILD_USER_ID, BUILD_USER_LAST_NAME_VAR_NAME, BUILD_USER_VAR_NAME, UNDEFINED

Constructor Summary

Constructors

Constructor and Description
SCMTriggerCauseDeterminant()

Method Summary

Methods

Modifier and Type	Method and Description
Class<hudson.triggers.SCMTrigger.SCMTriggerCause>	getUsedCauseClass() Returns Cause subclass used to determine user name.
boolean	setJenkinsUserBuildVars(hudson.triggers.SCMTrigger.SCMTriggerCause cause, Map<String,String> variables) Adds username build variables extracted from build cause to map of build variables.

Methods inherited from class java.lang.Object

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

Constructor Detail

SCMTriggerCauseDeterminant

public SCMTriggerCauseDeterminant()

Method Detail

setJenkinsUserBuildVars

public boolean setJenkinsUserBuildVars(hudson.triggers.SCMTrigger.SCMTriggerCause cause,
                              Map<String,String> variables)

Description copied from interface: IUsernameSettable

Adds username build variables extracted from build cause to map of build variables.

Specified by:

setJenkinsUserBuildVars in interface IUsernameSettable<hudson.triggers.SCMTrigger.SCMTriggerCause>

Parameters:

cause - cause where to get username from.

variables - map of build variables, where to add username variables.

Returns:

true if username was determined and added to the passed map, false otherwise.

getUsedCauseClass

public Class<hudson.triggers.SCMTrigger.SCMTriggerCause> getUsedCauseClass()

Description copied from interface: IUsernameSettable

Returns Cause subclass used to determine user name.

Specified by:

getUsedCauseClass in interface IUsernameSettable<hudson.triggers.SCMTrigger.SCMTriggerCause>

Returns:

class used to determine user name.