User (JanosRuntime JavaDOC)

java.lang.Object
- com.integpg.system.User

```
public class User
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`PERMS_ADMIN` This permissions flag is set if the user is an administrator.
`static int`	`PERMS_CONTROL` This permissions flag is set if the user can control outputs.
`static int`	`PERMS_DISABLED` This permissions flag is set if the user account is disabled.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`canControl()` Check for control access.
`static boolean`	`canControl(String username)` Check for control access.
`static byte[]`	`digestMD5(int userid, String prefix, String suffix)` Calculates the MD5 digest obtained by concatenating the user's password to the 'prefix' and then concatenating the 'suffix'.
`static byte[]`	`digestSHA1(int userid, String prefix, String suffix)` Calculates the SHA1 digest obtained by concatenating the user's password to the 'prefix' and then concatenating the 'suffix'.
`static int`	`getCurrentUID()` Query the current user.
`static String`	`getCurrentUserName()` Returns the name of the current user account.
`static int`	`getUserID(String username)` Retrieves the user account name for a specific ID.
`static String`	`getUserName(int id)` Retrieves the user account name for the specified ID.
`static boolean`	`isAdmin(int uid)` Determines if the given user ID has administrative rights.
`static boolean`	`isCurrentUserAdmin()` Indicates whether or not the current user has administrator privileges.
`static boolean`	`isDisabled(int uid)` Determines if the given user ID has been disabled.
`static boolean`	`isUser(String username)` Queries the existence of a user.
`static int`	`perms(String username)` Obtains the permissions byte for the specified user.
`static int`	`validate(String username, String password)` Confirms access to a user account.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PERMS_ADMIN
```
public static final int PERMS_ADMIN
```
    This permissions flag is set if the user is an administrator.
    
    Since:
    
    1.4.1
    
    See Also:
    
    Constant Field Values
  - PERMS_CONTROL
```
public static final int PERMS_CONTROL
```
    This permissions flag is set if the user can control outputs. Note that an administrator can also control outputs.
    
    Since:
    
    1.4.1
    
    See Also:
    
    Constant Field Values
  - PERMS_DISABLED
```
public static final int PERMS_DISABLED
```
    This permissions flag is set if the user account is disabled.
    
    Since:
    
    1.4.1
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getCurrentUID
```
public static int getCurrentUID()
```
    Query the current user. Programs executed at startup run as administrator using the account with the lowest ID. Programs executed from the command line run under the current login.
    
    Returns:
    
    the current user's ID
    
    Since:
    
    1.4.1
  - getCurrentUserName
```
public static String getCurrentUserName()
```
    Returns the name of the current user account.
    
    Returns:
    
    String containing the current user name
    
    Since:
    
    1.4.1
  - isUser
```
public static boolean isUser(String username)
```
    Queries the existence of a user.
    
    Parameters:
    
    username - user's account (e.g. "jnior")
    
    Returns:
    
    TRUE if an account exists for the specified user
  - perms
```
public static int perms(String username)
```
    Obtains the permissions byte for the specified user.
    
    Parameters:
    
    username - user's account (e.g. "jnior")
    
    Returns:
    
    permissions or -1 if the user does not exist
  - getUserID
```
public static int getUserID(String username)
```
    Retrieves the user account name for a specific ID.
    
    Parameters:
    
    username - user's account name (e.g. "jnior")
    
    Returns:
    
    account ID number or -1 if the user does not exist
  - getUserName
```
public static String getUserName(int id)
```
    Retrieves the user account name for the specified ID.
    
    Parameters:
    
    id - account ID
    
    Returns:
    
    user's account name or NULL if the account does not exist
  - isCurrentUserAdmin
```
public static boolean isCurrentUserAdmin()
```
    Indicates whether or not the current user has administrator privileges. Administrators have access to all commands and functions.
    
    Returns:
    
    true if the user has administrative rights
    
    Since:
    
    v1.5.1
  - isAdmin
```
public static boolean isAdmin(int uid)
```
    Determines if the given user ID has administrative rights.
    
    Parameters:
    
    uid - user ID for the query
    
    Returns:
    
    true if the supplied user is an administrator
    
    Since:
    
    v1.5.1
  - isDisabled
```
public static boolean isDisabled(int uid)
```
    Determines if the given user ID has been disabled.
    
    Parameters:
    
    uid - user ID for the query
    
    Returns:
    
    true if the supplied user account has been disabled
    
    Since:
    
    v1.5.1
  - canControl
```
public static boolean canControl()
```
    Check for control access.
    
    Returns:
    
    TRUE if the current user can control outputs
    
    Since:
    
    1.4.1
  - canControl
```
public static boolean canControl(String username)
```
    Check for control access. In order to control outputs the user's account must exist and cannot be disabled. The user must have control permission or be an administrator.
    
    Parameters:
    
    username - user's account name
    
    Returns:
    
    TRUE if the specified user can control outputs
    
    Since:
    
    1.4.1
  - validate
```
public static int validate(String username,
                           String password)
```
    Confirms access to a user account. Requires both a valid account name and password. Does not change the current user.
    
    Parameters:
    
    username - the user account name (e.g. "jnior")
    
    password - the account password
    
    Returns:
    
    the account permissions if the login is successful or -1 otherwise
  - digestMD5
```
public static byte[] digestMD5(int userid,
                               String prefix,
                               String suffix)
```
    Calculates the MD5 digest obtained by concatenating the user's password to the 'prefix' and then concatenating the 'suffix'.
    
    Parameters:
    
    userid - the user's account ID
    
    prefix - String prepended to the user's credentials
    
    suffix - String appended to the user's credentials
    
    Returns:
    
    16-byte array containing the MD5 digest or NULL if the user does not exist
  - digestSHA1
```
public static byte[] digestSHA1(int userid,
                                String prefix,
                                String suffix)
```
    Calculates the SHA1 digest obtained by concatenating the user's password to the 'prefix' and then concatenating the 'suffix'.
    
    Parameters:
    
    userid - the user's account ID
    
    prefix - String prepended to the user's credentials
    
    suffix - String appended to the user's credentials
    
    Returns:
    
    16-byte array containing the SHA1 digest or NULL if the user does not exist

Class User

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PERMS_ADMIN

PERMS_CONTROL

PERMS_DISABLED

Method Detail

getCurrentUID

getCurrentUserName

isUser

perms

getUserID

getUserName

isCurrentUserAdmin

isAdmin

isDisabled

canControl

canControl

validate

digestMD5

digestSHA1