auth.userstore package

public struct FilebasedUserstore

Represents the file-based user store

  • <FilebasedUserstore> FilebasedUserstore.<init>()

  • <FilebasedUserstore> authenticate(string user, string password) returns (boolean)

    Attempts to authenticate with username and password

    Parameter Name Data Type Description
    user string
    password string password

    Return Variable Data Type Description
    boolean boolean: true if authentication is a success, else false
  • <FilebasedUserstore> readGroupsOfUser(string username) returns (string)

    Reads the groups for a user

    Parameter Name Data Type Description
    username string

    Return Variable Data Type Description
    string string: comma separeted groups list, as specified in the userstore file or null if not found

public struct UserStore

Represents the user store. Any type of implementation, such as ldap, jdbc, file based, etc. should be struct-wise similar

  • <UserStore> UserStore.<init>()

  • <UserStore> authenticate(string username, string password) returns (boolean)

    Attempts to authenticate with username and password

    Parameter Name Data Type Description
    username string user name
    password string password

    Return Variable Data Type Description
    boolean boolean: true if authentication is a success, else false
  • <UserStore> readGroupsOfUser(string username) returns (string)

    Reads the group(s) for the user with the given username

    Parameter Name Data Type Description
    username string user name

    Return Variable Data Type Description
    string string: relevant group(s) for the user, null if not found

public function readUserId(string username) returns (string)

Reads the user id for the given username

Parameter Name Data Type Description
username string

Return Variable Data Type Description
string string: user id read from the userstore, or null if not found