Class AnyUser
java.lang.Object
eu.c6.gibraltar.api.common.CObject
eu.c6.gibraltar.api.managers.users.AnyUser
- All Implemented Interfaces:
ICObject,IAnyUser,IApiUserConstants,Serializable,Cloneable
The Class AnyUser to get, update and create user.
- See Also:
-
Field Summary
Fields inherited from interface eu.c6.gibraltar.api.managers.users.IApiUserConstants
API, AUTH_INLINE, AUTH_LDAP, AUTHENTICATION, CREATION_DATE, DISABLED, EXTENDED_METADATA, EXTERNAL, FIRST_LOGIN_DATE, FREE_USER, GROUPS, ID, LAST_LOGIN_DATE, MAIL, NAME, PASSWORD, PASSWORD_EXPIRED, RESET_COLUMN, RESET_MFA, RESET_PASSWORD, ROLES, SUBSCRIPTION_DATEFields inherited from interface eu.c6.gibraltar.api.common.ICObject
CHARSET, FIELD_SEPARATOR_DOT, FIELD_SEPARATOR_PATH -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the authentication mode.Gets the user custom metadata node.getId()Gets the identifier.getMail()Gets the user mail address.getName()Gets the user name.voidsetApi(boolean api) Sets the API value.voidsetAuthentication(String authentication) Sets the authentication mode.voidsetCreationDate(Date creationDate) Sets the creation date.voidsetDisabled(boolean disable) Sets the disabled value.voidsetExtendedMetadata(ICObject extendedMetadata) sets the user custom metadata .voidsetExternal(boolean external) Sets the external value.voidsetFirstLoginDate(Date firstLoginDate) Sets the first login date.voidsetFreeUser(boolean freeUser) Sets the free user value.voidSets the groups.voidSets the identifier.voidsetLastLoginDate(Date lastLoginDate) Sets the last login date.voidSets the user mail address.voidSets the user name.voidsetPassword(String password) Sets the password.voidsetPasswordExpired(boolean expire) Sets the password expired value.voidsetResetColumns(boolean reset) Set reset columns valuevoidsetResetMFA(boolean reset) Set MFA reset valuevoidSets the roles.voidsetSubscriptionDate(Date subscriptionDate) Sets the subscription date.Methods inherited from class eu.c6.gibraltar.api.common.CObject
addIntoList, addValueIntoList, buildPath, clearList, clone, clone, clone, contains, containsField, convertFieldNameToJsonPath, convertJsonPathToFieldName, equals, get, getBoolean, getBoolean, getDate, getDate, getDouble, getDouble, getFieldNames, getFieldNamesFlattenList, getFieldNamesList, getInputStream, getInt, getInt, getList, getListNestedObject, getListNestedObject, getListNestedObject, getListNestedObjectByAttribute, getListNestedObjectByAttribute, getListSize, getListString, getLocalDateTime, getLocalDateTime, getLong, getLong, getNestedObject, getNestedObject, getNestedObject, getNestedObjectNamesList, getOutputStream, getReader, getString, getString, insertIntoList, isBoolean, isDate, isDateList, isDouble, isEmpty, isFieldEmpty, isInt, isJSONValid, isList, isNestedObject, isNestedObjectList, isString, load, load, merge, mergeDeep, parse, remove, removeFromList, removeValueFromList, replaceIntoList, resetField, set, set, set, set, set, set, set, set, set, setList, setNull, textValue, toFlattenMapValues, toJson, toMap, toString, toString
-
Constructor Details
-
AnyUser
public AnyUser()Instantiates a new any user. -
AnyUser
Instantiates a new any user from object fields.Used fields are :
- "id" (
String) - "authentication" (
String) - "creationDate" (
Date) - "disabled" (
Boolean) - "external" (
Boolean) - "api" (
Boolean) *
- "firstLoginDate" (
Date) - "freeUser" (
Boolean) - "groups" (
ListofString) - "lastLoginDate" (
Date) - "mail" (
String) - "name" (
String) - "password" (
String) - "password_expired" (
Boolean) - "roles" (
ListofString) - "subscriptionDate" (
Date)
- Parameters:
object- the object- See Also:
- "id" (
-
AnyUser
public AnyUser(com.fasterxml.jackson.databind.JsonNode jsonNode) Instantiates a new any user from JSON object.Used fields are :
- "id" (
String) - "authentication" (
String) - "creationDate" (
Date) - "disabled" (
Boolean) - "firstLoginDate" (
Date) - "freeUser" (
Boolean) - "groups" (
ListofString) - "lastLoginDate" (
Date) - "mail" (
String) - "name" (
String) - "password" (
String) - "password_expired" (
Boolean) - "roles" (
ListofString) - "subscriptionDate" (
Date)
- Parameters:
jsonNode- the json node- See Also:
- "id" (
-
-
Method Details
-
getId
Description copied from interface:IAnyUserGets the identifier. -
setId
Description copied from interface:IAnyUserSets the identifier.You must use the user login to identify a user.
-
getName
Description copied from interface:IAnyUserGets the user name. -
setName
Description copied from interface:IAnyUserSets the user name. -
getMail
Description copied from interface:IAnyUserGets the user mail address. -
setMail
Description copied from interface:IAnyUserSets the user mail address. -
getAuthentication
Description copied from interface:IAnyUserGets the authentication mode.- Specified by:
getAuthenticationin interfaceIAnyUser- Returns:
- the authentication mode ("inline" or
"ldap" (
String))
-
setAuthentication
Description copied from interface:IAnyUser- Specified by:
setAuthenticationin interfaceIAnyUser- Parameters:
authentication- the new authentication mode
-
setCreationDate
Description copied from interface:IAnyUserSets the creation date.- Specified by:
setCreationDatein interfaceIAnyUser- Parameters:
creationDate- the new creation date
-
setFirstLoginDate
Description copied from interface:IAnyUserSets the first login date.- Specified by:
setFirstLoginDatein interfaceIAnyUser- Parameters:
firstLoginDate- the new first login date
-
setSubscriptionDate
Description copied from interface:IAnyUserSets the subscription date.- Specified by:
setSubscriptionDatein interfaceIAnyUser- Parameters:
subscriptionDate- the new subscription date
-
setLastLoginDate
Description copied from interface:IAnyUserSets the last login date.- Specified by:
setLastLoginDatein interfaceIAnyUser- Parameters:
lastLoginDate- the new last login date
-
setDisabled
public void setDisabled(boolean disable) Description copied from interface:IAnyUserSets the disabled value.- Specified by:
setDisabledin interfaceIAnyUser- Parameters:
disable- the new disabled value
-
setApi
public void setApi(boolean api) Description copied from interface:IAnyUserSets the API value. -
setExternal
public void setExternal(boolean external) Description copied from interface:IAnyUserSets the external value.- Specified by:
setExternalin interfaceIAnyUser
-
setPasswordExpired
public void setPasswordExpired(boolean expire) Description copied from interface:IAnyUserSets the password expired value.- Specified by:
setPasswordExpiredin interfaceIAnyUser- Parameters:
expire- the new password expired value
-
getExtendedMetadata
Description copied from interface:IAnyUserGets the user custom metadata node.- Specified by:
getExtendedMetadatain interfaceIAnyUser- Returns:
- a JSON containing each user custom metadata
-
setExtendedMetadata
Description copied from interface:IAnyUsersets the user custom metadata .- Specified by:
setExtendedMetadatain interfaceIAnyUser
-
setFreeUser
public void setFreeUser(boolean freeUser) Description copied from interface:IAnyUserSets the free user value.- Specified by:
setFreeUserin interfaceIAnyUser- Parameters:
freeUser- the new free user value
-
setRoles
Description copied from interface:IAnyUserSets the roles. -
setGroups
Description copied from interface:IAnyUserSets the groups. -
setPassword
Description copied from interface:IAnyUserSets the password.- Specified by:
setPasswordin interfaceIAnyUser- Parameters:
password- the new password
-
setResetMFA
public void setResetMFA(boolean reset) Description copied from interface:IAnyUserSet MFA reset value- Specified by:
setResetMFAin interfaceIAnyUser- Parameters:
reset- the reset action
-
setResetColumns
public void setResetColumns(boolean reset) Description copied from interface:IAnyUserSet reset columns value- Specified by:
setResetColumnsin interfaceIAnyUser- Parameters:
reset- the reset action
-