com.vmware.content

Interface Configuration

All Superinterfaces:

ConfigurationTypes, Service

All Known Implementing Classes:

ConfigurationStub

public interface Configuration
extends Service, ConfigurationTypes

The Configuration interface provides methods to configure the global settings of the Content Library Service.

The configuration settings are used by the Content Library Service to control the behavior of various operations.

Method Summary

Methods

Modifier and Type	Method and Description
ConfigurationModel	get() Retrieves the current configuration values.
void	get(AsyncCallback<ConfigurationModel> asyncCallback) Retrieves the current configuration values.
void	get(AsyncCallback<ConfigurationModel> asyncCallback, InvocationConfig invocationConfig) Retrieves the current configuration values.
ConfigurationModel	get(InvocationConfig invocationConfig) Retrieves the current configuration values.
void	update(ConfigurationModel model) Updates the configuration.
void	update(ConfigurationModel model, AsyncCallback<Void> asyncCallback) Updates the configuration.
void	update(ConfigurationModel model, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Updates the configuration.
void	update(ConfigurationModel model, InvocationConfig invocationConfig) Updates the configuration.

Method Detail

update

void update(ConfigurationModel model)

Updates the configuration. The update is incremental. Any property in the ConfigurationModel class that is null will not be modified. Note that this update method doesn't guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated.

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

Parameters:

model - The ConfigurationModel specifying the settings to update.

Throws:

InvalidArgument - if one of the configuration properties is not within the proper range.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires ContentLibrary.UpdateConfiguration.

update

void update(ConfigurationModel model,
          InvocationConfig invocationConfig)

Updates the configuration. The update is incremental. Any property in the ConfigurationModel class that is null will not be modified. Note that this update method doesn't guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated.

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:

model - The ConfigurationModel specifying the settings to update.

invocationConfig - Configuration for the method invocation.

Throws:

InvalidArgument - if one of the configuration properties is not within the proper range.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires ContentLibrary.UpdateConfiguration.

update

void update(ConfigurationModel model,
          AsyncCallback<Void> asyncCallback)

Updates the configuration. The update is incremental. Any property in the ConfigurationModel class that is null will not be modified. Note that this update method doesn't guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated.

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

Operation Errors:
InvalidArgument - if one of the configuration properties is not within the proper range.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires ContentLibrary.UpdateConfiguration.

Parameters:

model - The ConfigurationModel specifying the settings to update.

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

update

void update(ConfigurationModel model,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Updates the configuration. The update is incremental. Any property in the ConfigurationModel class that is null will not be modified. Note that this update method doesn't guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated.

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:
InvalidArgument - if one of the configuration properties is not within the proper range.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires ContentLibrary.UpdateConfiguration.

Parameters:

model - The ConfigurationModel specifying the settings to update.

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

invocationConfig - Configuration for the method invocation.

get

ConfigurationModel get()

Retrieves the current configuration values.

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

Returns:

The ConfigurationModel instance representing the configuration of the Content Library Service.

Throws:

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires ContentLibrary.GetConfiguration.

get

ConfigurationModel get(InvocationConfig invocationConfig)

Retrieves the current configuration values.

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:

The ConfigurationModel instance representing the configuration of the Content Library Service.

Throws:

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires ContentLibrary.GetConfiguration.

get

void get(AsyncCallback<ConfigurationModel> asyncCallback)

Retrieves the current configuration values.

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

Operation Result:
The ConfigurationModel instance representing the configuration of the Content Library Service.

Operation Errors:
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires ContentLibrary.GetConfiguration.

Parameters:

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

get

void get(AsyncCallback<ConfigurationModel> asyncCallback,
       InvocationConfig invocationConfig)

Retrieves the current configuration values.

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:
The ConfigurationModel instance representing the configuration of the Content Library Service.

Operation Errors:
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires ContentLibrary.GetConfiguration.

Parameters:

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

invocationConfig - Configuration for the method invocation.