Interface IUsernameSettable<T extends Cause>
- All Known Implementing Classes:
BranchIndexingTriggerDeterminant
,RemoteCauseDeterminant
,SCMTriggerCauseDeterminant
,TimerTriggerCauseDeterminant
,UserCauseDeterminant
,UserIdCauseDeterminant
public interface IUsernameSettable<T extends Cause>
Interface declaring method for setting jenkins user build variables parametrized by
Cause
subclasses.
User based Cause
instance is the source of username data.
- BUILD_USER -- full name of user started build,
- BUILD_USER_FIRST_NAME -- first name of user started build,
- BUILD_USER_LAST_NAME -- last name of user started build,
- BUILD_USER_ID -- id of user started build.
- Author:
- GKonovalenko
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Email of user started buildstatic final String
First name of user started buildstatic final String
Id of user started buildstatic final String
Last name of user started buildstatic final String
Groups username belongs tostatic final String
Full name of user started buildstatic final String
Optional value for variable which value couldn't be defined. -
Method Summary
-
Field Details
-
BUILD_USER_VAR_NAME
Full name of user started build- See Also:
-
BUILD_USER_VAR_GROUPS
Groups username belongs to- See Also:
-
BUILD_USER_FIRST_NAME_VAR_NAME
First name of user started build- See Also:
-
BUILD_USER_LAST_NAME_VAR_NAME
Last name of user started build- See Also:
-
BUILD_USER_EMAIL
Email of user started build- See Also:
-
BUILD_USER_ID
Id of user started build- See Also:
-
UNDEFINED
Optional value for variable which value couldn't be defined.- See Also:
-
-
Method Details
-
setJenkinsUserBuildVars
Adds username build variables extracted from build cause to map of build variables.- 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
ReturnsCause
subclass used to determine user name.- Returns:
- class used to determine user name.
-