Package com.inductiveautomation.ignition.gateway.authentication.resources

Class InternalUserResource.InternalUserBuilder

java.lang.Object

com.inductiveautomation.ignition.gateway.authentication.resources.InternalUserResource.InternalUserBuilder

Enclosing class:

InternalUserResource

public static class InternalUserResource.InternalUserBuilder
extends Object

Builder for the InternalUserResource class.

Constructor Summary

Constructors

Constructor	Description
InternalUserBuilder()

Method Summary

Modifier and Type	Method	Description
InternalUserResource	build()
InternalUserResource.InternalUserBuilder	copy(User user, int maxHistory, InternalUserResource existingUser)	Copy the fields from the given user.
InternalUserResource.InternalUserBuilder	copy(InternalUserResource user)	Copy the fields from the given user.
InternalUserResource.InternalUserBuilder	setBadge(String badge)
InternalUserResource.InternalUserBuilder	setContactInfos(List<InternalContactInfoResource> contactInfos)
InternalUserResource.InternalUserBuilder	setCreatedDate(Date createdDate)
InternalUserResource.InternalUserBuilder	setDescription(String description)
InternalUserResource.InternalUserBuilder	setExtraProps(List<InternalUserExtraPropsResource> extraProps)
InternalUserResource.InternalUserBuilder	setFirstName(String firstName)
InternalUserResource.InternalUserBuilder	setLanguage(String language)
InternalUserResource.InternalUserBuilder	setLastModifiedDate(Date lastModifiedDate)
InternalUserResource.InternalUserBuilder	setLastName(String lastName)
InternalUserResource.InternalUserBuilder	setPassword(String password, boolean preHashed, int maxHistory, List<String> passwordHistory)	Set the password for the user.
InternalUserResource.InternalUserBuilder	setPassword(String hashedPassword, Date passwordDate, List<String> passwordHistory)	Set the password fields directly.
InternalUserResource.InternalUserBuilder	setRoles(List<String> roles)
InternalUserResource.InternalUserBuilder	setSchedule(String schedule)
InternalUserResource.InternalUserBuilder	setScheduleAdjustments(List<InternalScheduleAdjustmentResource> scheduleAdjustments)
InternalUserResource.InternalUserBuilder	setUsername(String username)
InternalUserResource.InternalUserBuilder	setUuid(String uuid)

Methods inherited from class java.lang.Object

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

Constructor Details

InternalUserBuilder

public InternalUserBuilder()

Method Details

build

public InternalUserResource build()

setBadge

public InternalUserResource.InternalUserBuilder setBadge(@Nullable
 String badge)

setContactInfos

public InternalUserResource.InternalUserBuilder setContactInfos(@Nullable
 List<InternalContactInfoResource> contactInfos)

setDescription

public InternalUserResource.InternalUserBuilder setDescription(@Nullable
 String description)

setExtraProps

public InternalUserResource.InternalUserBuilder setExtraProps(@Nullable
 List<InternalUserExtraPropsResource> extraProps)

setFirstName

public InternalUserResource.InternalUserBuilder setFirstName(@Nullable
 String firstName)

setLanguage

public InternalUserResource.InternalUserBuilder setLanguage(@Nullable
 String language)

setLastName

public InternalUserResource.InternalUserBuilder setLastName(@Nullable
 String lastName)

setPassword

public InternalUserResource.InternalUserBuilder setPassword(String password,
 boolean preHashed,
 int maxHistory,
 @Nullable
 List<String> passwordHistory)

Set the password for the user. If the password is not pre-hashed, it will be hashed using SHA-256. The password history will be updated if necessary.

Parameters:

password - The password to set.

preHashed - Is the password pre-hashed?

maxHistory - The maximum number of passwords to store in the history.

passwordHistory - The current password history.

Returns:

This builder.

setPassword

public InternalUserResource.InternalUserBuilder setPassword(String hashedPassword,
 Date passwordDate,
 @Nullable
 List<String> passwordHistory)

Set the password fields directly. This is useful when copying a user, and we don't want to rehash the password. The passwords will be stored as-is and no history checking will be made, so be careful with this method.

Parameters:

hashedPassword - The pre-hashed password.

passwordDate - The date the password was hashed.

passwordHistory - The password history.

Returns:

This builder.

See Also:

• setPassword(String, boolean, int, List)

setRoles

public InternalUserResource.InternalUserBuilder setRoles(@Nullable
 List<String> roles)

setSchedule

public InternalUserResource.InternalUserBuilder setSchedule(@Nullable
 String schedule)

setScheduleAdjustments

public InternalUserResource.InternalUserBuilder setScheduleAdjustments(@Nullable
 List<InternalScheduleAdjustmentResource> scheduleAdjustments)

setUsername

public InternalUserResource.InternalUserBuilder setUsername(String username)

setUuid

public InternalUserResource.InternalUserBuilder setUuid(String uuid)

setCreatedDate

public InternalUserResource.InternalUserBuilder setCreatedDate(Date createdDate)

setLastModifiedDate

public InternalUserResource.InternalUserBuilder setLastModifiedDate(Date lastModifiedDate)

copy

public InternalUserResource.InternalUserBuilder copy(User user,
 int maxHistory,
 @Nullable
 InternalUserResource existingUser)

Copy the fields from the given user. Any calls to set methods will overwrite the copied values.

The roles, schedule adjustments, extra properties, and contact infos are not copied because we do some special handling for those fields in the user source.

Parameters:

user - The user to copy.

maxHistory - The maximum number of passwords to store in the history.

existingUser - The existing user, if it exists.

Returns:

This builder.

copy

public InternalUserResource.InternalUserBuilder copy(InternalUserResource user)

Copy the fields from the given user. Any calls to set methods will overwrite the copied values.

Parameters:

user - The user to copy.

Returns:

This builder.