AdminConfigUsers (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- se.entra.phantom.server.rconsole.AdminConfigUsers

public class AdminConfigUsers
extends Object

Handles the users definition.

Constructor Summary
Constructors
Constructor and Description
AdminConfigUsers()

Constructors
Constructor and Description
`AdminConfigUsers()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`appendChanges(Transaction trans, Hashtable<String,AdminConfigUser> old, StringBuilder buf)` Adds changes in the users configuration to a transaction.
`static void`	`appendSlaveInformation(Transaction trans)` Gets the transaction data used for informing slaves of changes in users.
`static void`	`edit(VirtualPanel vp)` Called to edit the dialog box definitions of the groups.
`static long`	`getExpirationInterval()` Gets the expiration interval in milliseconds (0 = no expiration).
`static int`	`getLoginRetryCount()` Gets the system retry count for invalid logins (default 4 if not specified).
`static AdminConfigUser`	`getUser(String userID)` Gets a user ID.
`static Enumeration<AdminConfigUser>`	`getUsers()` Gets the users.
`static void`	`loadSettings(IniFile ini)` Load the settings from the INI file.
`static AdminConfigUser`	`processChange(Transaction trans)` Processes a change of a user information from a remote machine.
`static boolean`	`processChanges(Transaction input, Transaction output, StringBuilder buf)` Processes changes in user information from a remote machine.
`static void`	`saveUser(AdminConfigUser user)` Saves the changes for a user in the INI data.

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

- Constructor Detail
  - AdminConfigUsers
```
public AdminConfigUsers()
```
- Method Detail
  - loadSettings
```
public static void loadSettings(IniFile ini)
```
    Load the settings from the INI file.
  - saveUser
```
public static void saveUser(AdminConfigUser user)
```
    Saves the changes for a user in the INI data. Note: the INI file is not saved!
  - getUsers
```
public static Enumeration<AdminConfigUser> getUsers()
```
    Gets the users.
  - getUser
```
public static AdminConfigUser getUser(String userID)
```
    Gets a user ID.
  - getExpirationInterval
```
public static long getExpirationInterval()
```
    Gets the expiration interval in milliseconds (0 = no expiration).
  - getLoginRetryCount
```
public static int getLoginRetryCount()
```
    Gets the system retry count for invalid logins (default 4 if not specified).
  - appendSlaveInformation
```
public static void appendSlaveInformation(Transaction trans)
```
    Gets the transaction data used for informing slaves of changes in users. If the "table" parameter is null, all current users are appended to the transaction.
  - appendChanges
```
public static boolean appendChanges(Transaction trans,
                                    Hashtable<String,AdminConfigUser> old,
                                    StringBuilder buf)
```
    Adds changes in the users configuration to a transaction.
    Returns:
    true if there are any changes in the transaction.
  - processChange
```
public static AdminConfigUser processChange(Transaction trans)
```
    Processes a change of a user information from a remote machine.
    Returns:
    AdminConfigUser if this requires a change to other machines, null for no change.
  - processChanges
```
public static boolean processChanges(Transaction input,
                                     Transaction output,
                                     StringBuilder buf)
```
    Processes changes in user information from a remote machine. A new transaction with changes that might be needed to sent to all other machines connected to this server is also built.
    Returns:
    true if any changes have been added to the output transaction.
  - edit
```
public static void edit(VirtualPanel vp)
```
    Called to edit the dialog box definitions of the groups.

Class AdminConfigUsers

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AdminConfigUsers

Method Detail

loadSettings

saveUser

getUsers

getUser

getExpirationInterval

getLoginRetryCount

appendSlaveInformation

appendChanges

processChange

processChanges

edit