com.vmware.appliance.techpreview.localaccounts

Interface User

All Superinterfaces:

Service, UserTypes

All Known Implementing Classes:

UserStub

public interface User
extends Service, UserTypes

User interface provides methods Perform operations on local user account.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.techpreview.localaccounts.UserTypes

UserTypes.NewUserConfig, UserTypes.UserAccountStatus, UserTypes.UserConfig, UserTypes.UserConfigGet, UserTypes.UserPasswordStatus, UserTypes.UserRole

Method Summary

Methods

Modifier and Type	Method and Description
void	add(UserTypes.NewUserConfig config) Create a new local user account.
void	add(UserTypes.NewUserConfig config, AsyncCallback<Void> asyncCallback) Create a new local user account.
void	add(UserTypes.NewUserConfig config, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Create a new local user account.
void	add(UserTypes.NewUserConfig config, InvocationConfig invocationConfig) Create a new local user account.
void	delete(String username) Delete a local user account.
void	delete(String username, AsyncCallback<Void> asyncCallback) Delete a local user account.
void	delete(String username, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Delete a local user account.
void	delete(String username, InvocationConfig invocationConfig) Delete a local user account.
UserTypes.UserConfigGet	get(String username) Get the local user account information.
void	get(String username, AsyncCallback<UserTypes.UserConfigGet> asyncCallback) Get the local user account information.
void	get(String username, AsyncCallback<UserTypes.UserConfigGet> asyncCallback, InvocationConfig invocationConfig) Get the local user account information.
UserTypes.UserConfigGet	get(String username, InvocationConfig invocationConfig) Get the local user account information.
List<UserTypes.UserConfigGet>	list() List of local accounts
void	list(AsyncCallback<List<UserTypes.UserConfigGet>> asyncCallback) List of local accounts
void	list(AsyncCallback<List<UserTypes.UserConfigGet>> asyncCallback, InvocationConfig invocationConfig) List of local accounts
List<UserTypes.UserConfigGet>	list(InvocationConfig invocationConfig) List of local accounts
void	set(UserTypes.UserConfig config) Update local user account properties role, full name, enabled status and password
void	set(UserTypes.UserConfig config, AsyncCallback<Void> asyncCallback) Update local user account properties role, full name, enabled status and password
void	set(UserTypes.UserConfig config, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Update local user account properties role, full name, enabled status and password
void	set(UserTypes.UserConfig config, InvocationConfig invocationConfig) Update local user account properties role, full name, enabled status and password

Method Detail

delete

void delete(String username)

Delete a local user account.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

username - User login name.

Throws:

Error - Generic error

delete

void delete(String username,
          InvocationConfig invocationConfig)

Delete a local user account.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

username - User login name.

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

delete

void delete(String username,
          AsyncCallback<Void> asyncCallback)

Delete a local user account.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - Generic error

Parameters:

username - User login name.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

delete

void delete(String username,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Delete a local user account.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - Generic error

Parameters:

username - User login name.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

add

void add(UserTypes.NewUserConfig config)

Create a new local user account.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

config - User configuration.

Throws:

Error - Generic error

add

void add(UserTypes.NewUserConfig config,
       InvocationConfig invocationConfig)

Create a new local user account.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

config - User configuration.

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

add

void add(UserTypes.NewUserConfig config,
       AsyncCallback<Void> asyncCallback)

Create a new local user account.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - Generic error

Parameters:

config - User configuration.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

add

void add(UserTypes.NewUserConfig config,
       AsyncCallback<Void> asyncCallback,
       InvocationConfig invocationConfig)

Create a new local user account.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - Generic error

Parameters:

config - User configuration.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

set

void set(UserTypes.UserConfig config)

Update local user account properties role, full name, enabled status and password

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

config - User configuration.

Throws:

Error - Generic error

set

void set(UserTypes.UserConfig config,
       InvocationConfig invocationConfig)

Update local user account properties role, full name, enabled status and password

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

config - User configuration.

invocationConfig - Configuration for the method invocation.

Throws:

Error - Generic error

set

void set(UserTypes.UserConfig config,
       AsyncCallback<Void> asyncCallback)

Update local user account properties role, full name, enabled status and password

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - Generic error

Parameters:

config - User configuration.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

set

void set(UserTypes.UserConfig config,
       AsyncCallback<Void> asyncCallback,
       InvocationConfig invocationConfig)

Update local user account properties role, full name, enabled status and password

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - Generic error

Parameters:

config - User configuration.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

List<UserTypes.UserConfigGet> list()

List of local accounts

Synchronous method overload. Result of the invocation will be reported as a method return value.

Returns:

User configuration.

Throws:

Error - Generic error

list

List<UserTypes.UserConfigGet> list(InvocationConfig invocationConfig)

List of local accounts

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

User configuration.

Throws:

Error - Generic error

list

void list(AsyncCallback<List<UserTypes.UserConfigGet>> asyncCallback)

List of local accounts

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
User configuration.

Operation Errors:
Error - Generic error

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(AsyncCallback<List<UserTypes.UserConfigGet>> asyncCallback,
        InvocationConfig invocationConfig)

List of local accounts

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
User configuration.

Operation Errors:
Error - Generic error

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

UserTypes.UserConfigGet get(String username)

Get the local user account information.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

username - User login name.

Returns:

local user account information

Throws:

Error - Generic error

get

UserTypes.UserConfigGet get(String username,
                          InvocationConfig invocationConfig)

Get the local user account information.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

username - User login name.

invocationConfig - Configuration for the method invocation.

Returns:

local user account information

Throws:

Error - Generic error

get

void get(String username,
       AsyncCallback<UserTypes.UserConfigGet> asyncCallback)

Get the local user account information.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
local user account information

Operation Errors:
Error - Generic error

Parameters:

username - User login name.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(String username,
       AsyncCallback<UserTypes.UserConfigGet> asyncCallback,
       InvocationConfig invocationConfig)

Get the local user account information.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
local user account information

Operation Errors:
Error - Generic error

Parameters:

username - User login name.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.