IUsernameSettable (Jenkins build user vars plugin 1.6 API)

All Known Implementing Classes:

RemoteCauseDeterminant, SCMTriggerCauseDeterminant, TimerTriggerCauseDeterminant, UserCauseDeterminant, UserIdCauseDeterminant
```
public interface IUsernameSettable<T extends hudson.model.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

Fields
Modifier and Type	Field and Description
`static String`	`BUILD_USER_EMAIL` Email of user started build
`static String`	`BUILD_USER_FIRST_NAME_VAR_NAME` First name of user started build
`static String`	`BUILD_USER_ID` Id of user started build
`static String`	`BUILD_USER_LAST_NAME_VAR_NAME` Last name of user started build
`static String`	`BUILD_USER_VAR_NAME` Full name of user started build
`static String`	`UNDEFINED` Optional value for variable which value couldn't be defined.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Class<T>`	`getUsedCauseClass()` Returns `Cause` subclass used to determine user name.
`boolean`	`setJenkinsUserBuildVars(T cause, Map<String,String> variables)` Adds username build variables extracted from build cause to map of build variables.

- Field Detail
  - BUILD_USER_VAR_NAME
```
static final String BUILD_USER_VAR_NAME
```
    Full name of user started build
    
    See Also:
    
    Constant Field Values
  - BUILD_USER_FIRST_NAME_VAR_NAME
```
static final String BUILD_USER_FIRST_NAME_VAR_NAME
```
    First name of user started build
    
    See Also:
    
    Constant Field Values
  - BUILD_USER_LAST_NAME_VAR_NAME
```
static final String BUILD_USER_LAST_NAME_VAR_NAME
```
    Last name of user started build
    
    See Also:
    
    Constant Field Values
  - BUILD_USER_EMAIL
```
static final String BUILD_USER_EMAIL
```
    Email of user started build
    
    See Also:
    
    Constant Field Values
  - BUILD_USER_ID
```
static final String BUILD_USER_ID
```
    Id of user started build
    
    See Also:
    
    Constant Field Values
  - UNDEFINED
```
static final String UNDEFINED
```
    Optional value for variable which value couldn't be defined.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setJenkinsUserBuildVars
```
boolean setJenkinsUserBuildVars(T cause,
                                Map<String,String> variables)
```
    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
```
Class<T> getUsedCauseClass()
```
    Returns Cause subclass used to determine user name.
    
    Returns:
    
    class used to determine user name.

Interface IUsernameSettable<T extends hudson.model.Cause>

Field Summary

Method Summary

Field Detail

BUILD_USER_VAR_NAME

BUILD_USER_FIRST_NAME_VAR_NAME

BUILD_USER_LAST_NAME_VAR_NAME

BUILD_USER_EMAIL

BUILD_USER_ID

UNDEFINED

Method Detail

setJenkinsUserBuildVars

getUsedCauseClass