org.jenkinsci.plugins.builduser.varsetter.impl

Class UserIdCauseDeterminant

java.lang.Object

org.jenkinsci.plugins.builduser.varsetter.impl.UserIdCauseDeterminant

All Implemented Interfaces:

IUsernameSettable<hudson.model.Cause.UserIdCause>

public class UserIdCauseDeterminant
extends Object
implements IUsernameSettable<hudson.model.Cause.UserIdCause>

This implementation is used to determine build username variables from Cause.UserIdCause. This will let to get whole set of variables:

• IUsernameSettable.BUILD_USER_ID
• IUsernameSettable.BUILD_USER_VAR_NAME
• IUsernameSettable.BUILD_USER_VAR_GROUPS
• 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 and Description
UserIdCauseDeterminant()

Method Summary

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

UserIdCauseDeterminant

public UserIdCauseDeterminant()

Method Detail

setJenkinsUserBuildVars

public boolean setJenkinsUserBuildVars(hudson.model.Cause.UserIdCause cause,
                                       Map<String,String> variables)

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

Cause.UserIdCause based implementation.

Specified by:

setJenkinsUserBuildVars in interface IUsernameSettable<hudson.model.Cause.UserIdCause>

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

Returns Cause subclass used to determine user name.

Specified by:

getUsedCauseClass in interface IUsernameSettable<hudson.model.Cause.UserIdCause>

Returns:

class used to determine user name.