com.metamatrix.admin.api.objects
Class AdminOptions

java.lang.Object
  com.metamatrix.admin.api.objects.AdminOptions

All Implemented Interfaces:

java.io.Serializable

public class AdminOptions
extends java.lang.Object
implements java.io.Serializable

Creates, collects and stores option values for evaluation when executing methods where decisions should be made based on user preferences.

Method of use is to create with an option and use the method addOption(int) when more than one option is wished or required.

Example:

   AdminOptions options = new AdminOptions(AdminOptions.OnConflict.OVERWRITE);
   options.addOption(BINDINGS_IGNORE_DECRYPT_ERROR);
 

Since:

4.3

See Also:

Serialized Form

Nested Class Summary

static interface

AdminOptions.OnConflict In the case when adding resource to the system, if the resource already exists in the system, these modes define how to handle the situation.

Field Summary

static int

BINDINGS_IGNORE_DECRYPT_ERROR Connector bindings have encrypted passwords as connection properties.

Constructor Summary

AdminOptions(int option)
Construct with an option.

Method Summary

void	addOption(int anOption) Add an option to this object if multiple options are required.
boolean	containsOption(int anOption) Check if the given option was specified.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BINDINGS_IGNORE_DECRYPT_ERROR

public static final int BINDINGS_IGNORE_DECRYPT_ERROR

Connector bindings have encrypted passwords as connection properties. If the password property cannot be decrypted, the connector binding will not start until the connector binding password property is changed.

Adding a VDB with this option allows the VDB and its connector bindings to be added and persisted to the system configuration, even if the connector binding properties cannot be decrypted. Users should set the password property on all connectors added after using this option.

NOTE: This will result in a VDB with a status of VDB.INACTIVE.

See Also:

Constant Field Values

Constructor Detail

AdminOptions

public AdminOptions(int option)
             throws java.lang.RuntimeException

Construct with an option. For available options, see AdminOptions.

Note: A RutimeException is thrown for any option given that is not found in the interface.

Parameters:

option - One of the available options in AdminOptions.

Throws:

java.lang.RuntimeException - for any option given that is not found in the interface.

Since:

4.3

Method Detail

addOption

public void addOption(int anOption)

Add an option to this object if multiple options are required.

Note: A RutimeException is thrown for any option given that is not found in the interface.

Parameters:

anOption - the option to add.

Throws:

java.lang.RuntimeException - for any option given that is not found in the interface.

Since:

4.3

containsOption

public boolean containsOption(int anOption)

Check if the given option was specified.

Parameters:

anOption - the option to check.

Returns:

true iff this opject contains the geven option.

Since:

4.3

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Since:

4.3

See Also:

Object.toString()