Package com.carfey.ops.api.bean.user

Class UserUpdateRequest

java.lang.Object

com.carfey.ops.api.bean.user.UserUpdateRequest

public class UserUpdateRequest
extends java.lang.Object

Used to update a user via UserManager. This request supports nulls for all fields. Nulls indicate that the value should not be updated. This allows for changing values without supplying the password, and also allows for password changes without updating other attributes.

Note that all active users have an implicit read role that is not included in this object.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
UserUpdateRequest()

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	getActive()
java.lang.String	getPassword()	If password is provided, a password change will be processed with the request.
java.util.Set<java.lang.String>	getRoles()
void	setActive(java.lang.Boolean active)
void	setPassword(java.lang.String password)	See getPassword() for notes on changing passwords.
void	setRoles(java.util.Set<java.lang.String> roles)
java.lang.String	toString()
UserUpdateRequest	withActive(java.lang.Boolean active)
UserUpdateRequest	withPassword(java.lang.String password)	See getPassword() for notes on changing passwords.
UserUpdateRequest	withRoles(java.util.Set<java.lang.String> roles)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserUpdateRequest

public UserUpdateRequest()

Method Detail

getActive

public java.lang.Boolean getActive()

setActive

public void setActive(java.lang.Boolean active)

withActive

public UserUpdateRequest withActive(java.lang.Boolean active)

getRoles

public java.util.Set<java.lang.String> getRoles()

Since:

5.0 this is Set of Strings instead of a Set a Roles

setRoles

public void setRoles(java.util.Set<java.lang.String> roles)

Since:

5.0 this is Set of Strings instead of a Set a Roles

withRoles

public UserUpdateRequest withRoles(java.util.Set<java.lang.String> roles)

Since:

5.0 this is Set of Strings instead of a Set a Roles

getPassword

public java.lang.String getPassword()

If password is provided, a password change will be processed with the request. This can be left blank to leave the password as is.

Returns:

password

setPassword

public void setPassword(java.lang.String password)

See getPassword() for notes on changing passwords.

Parameters:

password - updated password

withPassword

public UserUpdateRequest withPassword(java.lang.String password)

See getPassword() for notes on changing passwords.

Parameters:

password - updated password

Returns:

this, suitable for chaining

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object