Package org.jenkinsci.plugins.builduser.varsetter.impl

Class UserCauseDeterminant

java.lang.Object

org.jenkinsci.plugins.builduser.varsetter.impl.UserCauseDeterminant

All Implemented Interfaces:

IUsernameSettable<Cause.UserCause>

public class UserCauseDeterminant
extends Object
implements IUsernameSettable<Cause.UserCause>

This implementation is used to determine build username variables from Cause.UserCause. This could be used with legacy version of jenkins, where Cause.UserCause is used instead of Cause.UserIdCause (before b1.427). This will let to get following set of variables:

• IUsernameSettable.BUILD_USER_VAR_NAME
• IUsernameSettable.BUILD_USER_FIRST_NAME_VAR_NAME
• IUsernameSettable.BUILD_USER_LAST_NAME_VAR_NAME

Author:

GKonovalenko

Field Summary

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

BUILD_USER_EMAIL, BUILD_USER_FIRST_NAME_VAR_NAME, BUILD_USER_ID, BUILD_USER_LAST_NAME_VAR_NAME, BUILD_USER_VAR_GROUPS, BUILD_USER_VAR_NAME, UNDEFINED

Constructor Summary

Constructors

Constructor	Description
UserCauseDeterminant()

Method Summary

Modifier and Type	Method	Description
Class<Cause.UserCause>	getUsedCauseClass()	Returns Cause subclass used to determine user name.
boolean	setJenkinsUserBuildVars(Cause.UserCause 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

UserCauseDeterminant

public UserCauseDeterminant()

Method Detail

setJenkinsUserBuildVars

public boolean setJenkinsUserBuildVars(Cause.UserCause cause,
                                       Map<String,String> variables)

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

Cause.UserCause based implementation.

Specified by:

setJenkinsUserBuildVars in interface IUsernameSettable<Cause.UserCause>

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<Cause.UserCause> getUsedCauseClass()

Returns Cause subclass used to determine user name.

Specified by:

getUsedCauseClass in interface IUsernameSettable<Cause.UserCause>

Returns:

class used to determine user name.