|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.teiid.adminapi.AdminOptions
public class AdminOptions
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);
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 |
---|
public static final int BINDINGS_IGNORE_DECRYPT_ERROR
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
.
Constructor Detail |
---|
public AdminOptions(int option) throws java.lang.RuntimeException
AdminOptions
.
Note: A RutimeException is thrown for any option given that is not found in the interface.
option
- One of the available options in AdminOptions
.
java.lang.RuntimeException
- for any option given that is not
found in the interface.Method Detail |
---|
public void addOption(int anOption)
Note: A RutimeException is thrown for any option given that is not found in the interface.
anOption
- the option to add.
java.lang.RuntimeException
- for any option given that is not
found in the interface.public boolean containsOption(int anOption)
anOption
- the option to check.
true iff this opject contains the
geven option.- Since:
- 4.3
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |