Serialized Form

  • Package africa.absa.inception.security

    • Exception africa.absa.inception.security.AuthenticationFailedException

      class AuthenticationFailedException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Class africa.absa.inception.security.AuthenticationToken

      class AuthenticationToken extends org.springframework.security.authentication.AbstractAuthenticationToken implements Serializable
      • Serialized Fields

        • userDetails
          org.springframework.security.core.userdetails.UserDetails userDetails
          The user details.
    • Exception africa.absa.inception.security.DuplicateFunctionException

      class DuplicateFunctionException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Exception africa.absa.inception.security.DuplicateGroupException

      class DuplicateGroupException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Exception africa.absa.inception.security.DuplicateTenantException

      class DuplicateTenantException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Exception africa.absa.inception.security.DuplicateUserDirectoryException

      class DuplicateUserDirectoryException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Exception africa.absa.inception.security.DuplicateUserException

      class DuplicateUserException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Exception africa.absa.inception.security.ExistingGroupMembersException

      class ExistingGroupMembersException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Exception africa.absa.inception.security.ExistingPasswordException

      class ExistingPasswordException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Exception africa.absa.inception.security.ExpiredPasswordException

      class ExpiredPasswordException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Class africa.absa.inception.security.Function

      class Function extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • code
          @NotNull @Size(min=1,max=100) String code
          The code for the function.
        • description
          @Size(max=100) String description
          The description for the function.
        • name
          @NotNull @Size(min=1,max=100) String name
          The name of the function.
        • roles
          Set<Role> roles
          The roles the user is associated with.
    • Exception africa.absa.inception.security.FunctionNotFoundException

      class FunctionNotFoundException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Class africa.absa.inception.security.Group

      class Group extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • created
          LocalDateTime created
          The date and time the group was created.
        • description
          @Size(max=100) String description
          The description for the group.
        • id
          UUID id
          The ID for the group.
        • name
          @NotNull @Size(min=1,max=100) String name
          The name of the group.
        • roles
          Set<Role> roles
          The roles associated with the group.
        • updated
          LocalDateTime updated
          The date and time the group was last updated.
        • userDirectoryId
          @NotNull UUID userDirectoryId
          The ID for the user directory the group is associated with.
        • users
          Set<User> users
          The users associated with the group.
    • Class africa.absa.inception.security.GroupMember

      class GroupMember extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • groupName
          @NotNull @Size(min=1,max=100) String groupName
          The name of the group.
        • memberName
          @NotNull @Size(min=1,max=100) String memberName
          The name of the group member.
        • memberType
          @NotNull GroupMemberType memberType
          The group member type.
        • userDirectoryId
          @NotNull UUID userDirectoryId
          The ID for the user directory the group is associated with.
    • Exception africa.absa.inception.security.GroupMemberNotFoundException

      class GroupMemberNotFoundException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Class africa.absa.inception.security.GroupMembers

      class GroupMembers extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • filter
          String filter
          The optional filter that was applied to the group members.
        • groupMembers
          List<GroupMember> groupMembers
          The group members.
        • groupName
          String groupName
          The name of the group the group members are associated with.
        • pageIndex
          Integer pageIndex
          The optional page index.
        • pageSize
          Integer pageSize
          The optional page size.
        • sortDirection
          africa.absa.inception.core.sorting.SortDirection sortDirection
          The optional sort direction that was applied to the group members.
        • total
          long total
          The total number of group members.
        • userDirectoryId
          UUID userDirectoryId
          The ID for the user directory the group members are associated with.
    • Exception africa.absa.inception.security.GroupNotFoundException

      class GroupNotFoundException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Class africa.absa.inception.security.GroupRole

      class GroupRole extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • groupName
          @NotNull @Size(min=1,max=100) String groupName
          The name of the group.
        • roleCode
          @NotNull @Size(min=1,max=100) String roleCode
          The code for the role.
        • userDirectoryId
          @NotNull UUID userDirectoryId
          The ID for the user directory the group is associated with.
    • Exception africa.absa.inception.security.GroupRoleNotFoundException

      class GroupRoleNotFoundException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Class africa.absa.inception.security.Groups

      class Groups extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • filter
          String filter
          The optional filter that was applied to the groups.
        • groups
          List<Group> groups
          The groups.
        • pageIndex
          Integer pageIndex
          The optional page index.
        • pageSize
          Integer pageSize
          The optional page size.
        • sortDirection
          africa.absa.inception.core.sorting.SortDirection sortDirection
          The optional sort direction that was applied to the groups.
        • total
          long total
          The total number of groups.
        • userDirectoryId
          UUID userDirectoryId
          The ID for the user directory the groups are associated with.
    • Exception africa.absa.inception.security.InvalidAttributeException

      class InvalidAttributeException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Exception africa.absa.inception.security.InvalidConfigurationException

      class InvalidConfigurationException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Exception africa.absa.inception.security.InvalidSecurityCodeException

      class InvalidSecurityCodeException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Class africa.absa.inception.security.PasswordChange

      class PasswordChange extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • expirePassword
          Boolean expirePassword
          Expire the user's password when performing an administrative password change.
        • lockUser
          Boolean lockUser
          Lock the user when performing an administrative password change.
        • newPassword
          @NotNull @Size(min=1,max=100) String newPassword
          The new password.
        • password
          @Size(min=1,max=100) String password
          The password for the user that is used to authorise the operation when performing a user password change.
        • reason
          @NotNull PasswordChangeReason reason
          The reason for changing the password.
        • resetPasswordHistory
          Boolean resetPasswordHistory
          Reset the user's password history when performing an administrative password change.
        • securityCode
          String securityCode
          The security code when performing a forgotten password change.
    • Class africa.absa.inception.security.PasswordReset

      class PasswordReset extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • completed
          LocalDateTime completed
          The date and time the password reset was completed.
        • expired
          LocalDateTime expired
          The date and time the password reset expired.
        • requested
          LocalDateTime requested
          The date and time the password reset was requested.
        • securityCodeHash
          @NotNull @Size(min=1,max=100) String securityCodeHash
          The security code hash.
        • status
          @NotNull PasswordResetStatus status
          The status of the password reset.
        • username
          @NotNull @Size(min=1,max=100) String username
          The username for the user associated with the password reset.
    • Class africa.absa.inception.security.PasswordResetId

      class PasswordResetId extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • requested
          LocalDateTime requested
          The date and time the password reset was requested.
        • username
          String username
          The username for the user associated with the password reset.
    • Class africa.absa.inception.security.Role

      class Role extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • code
          @NotNull @Size(min=1,max=100) String code
          The code for the role.
        • description
          @Size(max=100) String description
          The description for the role.
        • functions
          Set<Function> functions
          The functions associated with the role.
        • groups
          Set<Group> groups
          The groups the role is associated with.
        • name
          @NotNull @Size(min=1,max=100) String name
          The name of the role.
    • Exception africa.absa.inception.security.RoleNotFoundException

      class RoleNotFoundException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Class africa.absa.inception.security.Tenant

      class Tenant extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • created
          LocalDateTime created
          The date and time the tenant was created.
        • id
          @NotNull UUID id
          The ID for the tenant.
        • name
          @NotNull @Size(min=1,max=100) String name
          The name of the tenant.
        • status
          @NotNull TenantStatus status
          The status for the tenant.
        • updated
          LocalDateTime updated
          The date and time the tenant was last updated.
        • userDirectories
          Set<UserDirectory> userDirectories
          The user directories associated with the tenant.
    • Exception africa.absa.inception.security.TenantNotFoundException

      class TenantNotFoundException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Class africa.absa.inception.security.Tenants

      class Tenants extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • filter
          String filter
          The optional filter that was applied to the tenants.
        • pageIndex
          Integer pageIndex
          The optional page index.
        • pageSize
          Integer pageSize
          The optional page size.
        • sortDirection
          africa.absa.inception.core.sorting.SortDirection sortDirection
          The optional sort direction that was applied to the tenants.
        • tenants
          List<Tenant> tenants
          The tenants.
        • total
          long total
          The total number of tenants.
    • Class africa.absa.inception.security.TenantUserDirectory

      class TenantUserDirectory extends Object implements Serializable
      • Serialized Fields

        • tenantId
          @NotNull UUID tenantId
          The ID for the tenant.
        • userDirectoryId
          @NotNull UUID userDirectoryId
          The ID for the user directory.
    • Exception africa.absa.inception.security.TenantUserDirectoryNotFoundException

      class TenantUserDirectoryNotFoundException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Class africa.absa.inception.security.User

      class User extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • created
          LocalDateTime created
          The date and time the user was created.
        • email
          @Size(max=100) @Pattern(message="invalid e-mail address",regexp="^$|(?:[a-zA-Z0-9!#$%&\'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&\'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])") String email
          The e-mail address for the user.
        • groups
          Set<Group> groups
          The groups the user is associated with.
        • id
          UUID id
          The ID for the user.
        • mobileNumber
          @Size(max=100) @Pattern(message="invalid international format mobile number",regexp="^$|(\\+|00)(297|93|244|1264|358|355|376|971|54|374|1684|1268|61|43|994|257|32|229|226|880|359|973|1242|387|590|375|501|1441|591|55|1246|673|975|267|236|1|61|41|56|86|225|237|243|242|682|57|269|238|506|53|5999|61|1345|357|420|49|253|1767|45|1809|1829|1849|213|593|20|291|212|34|372|251|358|679|500|33|298|691|241|44|995|44|233|350|224|590|220|245|240|30|1473|299|502|594|1671|592|852|504|385|509|36|62|44|91|246|353|98|964|354|972|39|1876|44|962|81|76|77|254|996|855|686|1869|82|383|965|856|961|231|218|1758|423|94|266|370|352|371|853|590|212|377|373|261|960|52|692|389|223|356|95|382|976|1670|258|222|1664|596|230|265|60|262|264|687|227|672|234|505|683|31|47|977|674|64|968|92|507|64|51|63|680|675|48|1787|1939|850|351|595|970|689|974|262|40|7|250|966|249|221|65|500|4779|677|232|503|378|252|508|381|211|239|597|421|386|46|268|1721|248|963|1649|235|228|66|992|690|993|670|676|1868|216|90|688|886|255|256|380|598|1|998|3906698|379|1784|58|1284|1340|84|678|681|685|967|27|260|263)(9[976]\\d|8[987530]\\d|6[987]\\d|5[90]\\d|42\\d|3[875]\\d|2[98654321]\\d|9[8543210]|8[6421]|6[6543210]|5[87654321]|4[987654310]|3[9643210]|2[70]|7|1)\\d{4,20}$") String mobileNumber
          The international format mobile number for the user.
        • name
          @NotNull @Size(max=100) String name
          The name of the user.
        • password
          @Size(max=100) String password
          The password or password hash for the user.

          The password is not required as part of the JSON or XML representation of the user, other than when creating the user, so the field is nullable but the database column is not.

        • passwordAttempts
          Integer passwordAttempts
          The number of failed authentication attempts as a result of an incorrect password for the user.
        • passwordExpiry
          LocalDateTime passwordExpiry
          The date and time the password for the user expires.
        • phoneNumber
          @Size(max=100) String phoneNumber
          The phone number for the user.
        • preferredName
          @Size(max=100) String preferredName
          The preferred name for the user.
        • status
          @NotNull UserStatus status
          The status for the user.
        • updated
          LocalDateTime updated
          The date and time the user was last updated.
        • userDirectoryId
          @NotNull UUID userDirectoryId
          The ID for the user directory the user is associated with.
        • username
          @NotNull @Size(min=1,max=100) String username
          The username for the user.
    • Class africa.absa.inception.security.UserAttribute

      class UserAttribute extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • name
          @NotNull @Size(min=1,max=100) String name
          The name of the user attribute.
        • value
          @NotNull @Size(max=4000) String value
          The value for the user attribute.
    • Exception africa.absa.inception.security.UserAttributeException

      class UserAttributeException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Class africa.absa.inception.security.UserDetails

      class UserDetails extends Object implements Serializable
      • Serialized Fields

        • authorities
          List<org.springframework.security.core.GrantedAuthority> authorities
          The authorities granted to the user.
        • user
          User user
          The user.
    • Class africa.absa.inception.security.UserDirectories

      class UserDirectories extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • filter
          String filter
          The optional filter that was applied to the user directories.
        • pageIndex
          Integer pageIndex
          The optional page index.
        • pageSize
          Integer pageSize
          The optional page size.
        • sortDirection
          africa.absa.inception.core.sorting.SortDirection sortDirection
          The optional sort direction that was applied to the user directories.
        • total
          long total
          The total number of user directories.
        • userDirectories
          List<UserDirectory> userDirectories
          The user directories.
    • Class africa.absa.inception.security.UserDirectory

      class UserDirectory extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • created
          LocalDateTime created
          The date and time the user directory was created.
        • id
          @NotNull UUID id
          The ID for the user directory.
        • name
          @NotNull @Size(min=1,max=100) String name
          The name of the user directory.
        • parameters
          @Valid List<UserDirectoryParameter> parameters
          The parameters for the user directory.
        • tenants
          Set<Tenant> tenants
          The tenants the user directory is associated with.
        • type
          @NotNull @Size(min=1,max=100) String type
          The code for the user directory type.
        • updated
          LocalDateTime updated
          The date and time the user directory was last updated.
    • Exception africa.absa.inception.security.UserDirectoryNotFoundException

      class UserDirectoryNotFoundException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Class africa.absa.inception.security.UserDirectoryParameter

      class UserDirectoryParameter extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • name
          @NotNull @Size(min=1,max=100) String name
          The name of the user directory parameter.
        • value
          @NotNull @Size(max=4000) String value
          The value for the user directory parameter.
    • Exception africa.absa.inception.security.UserDirectoryParameterException

      class UserDirectoryParameterException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Class africa.absa.inception.security.UserDirectorySummaries

      class UserDirectorySummaries extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • filter
          String filter
          The optional filter that was applied to the user directory summaries.
        • pageIndex
          Integer pageIndex
          The optional page index.
        • pageSize
          Integer pageSize
          The optional page size.
        • sortDirection
          africa.absa.inception.core.sorting.SortDirection sortDirection
          The optional sort direction that was applied to the user directory summaries.
        • total
          long total
          The total number of user directory summaries.
        • userDirectorySummaries
          List<UserDirectorySummary> userDirectorySummaries
          The user directory summaries.
    • Class africa.absa.inception.security.UserDirectorySummary

      class UserDirectorySummary extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • id
          @NotNull UUID id
          The ID for the user directory.
        • name
          @NotNull @Size(min=1,max=100) String name
          The name of the user directory.
        • tenants
          Set<Tenant> tenants
          The user directories associated with the tenant.
        • type
          @NotNull @Size(min=1,max=100) String type
          The code for the user directory type.
    • Class africa.absa.inception.security.UserDirectoryType

      class UserDirectoryType extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • code
          @NotNull @Size(min=1,max=100) String code
          The code for the user directory type.
        • name
          @NotNull @Size(min=1,max=100) String name
          The name of the user directory type.
        • userDirectoryClassName
          @NotNull @Size(min=1,max=1000) String userDirectoryClassName
          The fully qualified name of the Java class that implements the user directory type.
    • Exception africa.absa.inception.security.UserDirectoryTypeNotFoundException

      class UserDirectoryTypeNotFoundException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Exception africa.absa.inception.security.UserLockedException

      class UserLockedException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Exception africa.absa.inception.security.UserNotFoundException

      class UserNotFoundException extends africa.absa.inception.core.service.ServiceException implements Serializable
      serialVersionUID:
      1000000L
    • Class africa.absa.inception.security.Users

      class Users extends Object implements Serializable
      serialVersionUID:
      1000000L
      • Serialized Fields

        • filter
          String filter
          The optional filter that was applied to the users.
        • pageIndex
          Integer pageIndex
          The optional page index.
        • pageSize
          Integer pageSize
          The optional page size.
        • sortBy
          UserSortBy sortBy
          The optional method used to sort the users e.g. by name.
        • sortDirection
          africa.absa.inception.core.sorting.SortDirection sortDirection
          The optional sort direction that was applied to the users.
        • total
          long total
          The total number of users.
        • userDirectoryId
          UUID userDirectoryId
          The ID for the user directory the users are associated with.
        • users
          List<User> users
          The users.