com.ibm.di.eclipse.http.commands
Class PropertiesCommand
java.lang.Object
com.ibm.di.eclipse.http.commands.RestCommand
com.ibm.di.eclipse.http.commands.PropertiesCommand
public class PropertiesCommand
- extends RestCommand
This command is used to manipulate the standard shared property stores as well as
configuration specific property stores.
- properties/[instance:]storename/propname[/value] - Get or set value in specific
store
- properties/[instance:]storename - Get all values in store (HTTP GET)
- properties/[instance:]storename - Put all posted values to store (HTTP POST)
- properties/☆/propname[/value] - Get or set value in default store
- properties - List all property stores
The instance ID is optional. If one is specified, the instance ID is used to access the
property store. If the instance is running, the properties for the running configuration
is used, otherwise the configuration file for the instance is loaded to update the property
store.
Fields inherited from class com.ibm.di.eclipse.http.commands.RestCommand |
HTTP_BODY, HTTP_CONTENT_TYPE, HTTP_QS, RES_ASSEMBLY_LINE, RES_ASSEMBLY_LINE_LOG, RES_CONFIG_AL, RES_CONFIG_INSTANCE, RES_CONFIG_RUNAL, RES_CONFIGURATION, RES_CONNECTOR_CLOSE, RES_CONNECTOR_GETNEXT, RES_CONNECTOR_LOAD, RES_CONNECTOR_QUERYSCHEMA, sRes |
Methods inherited from class com.ibm.di.eclipse.http.commands.RestCommand |
addPendingCommand, appendBody, appendResult, dispose, getApi, getCommand, getConnector, getPath, getPath, getPendingCommand, getRequest, getRequestBody, getRequestParam, getResponse, getSession, isParamTrue, isReusable, readFile, setApi, setBody, setBody, setPath, setResponse |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PropertiesCommand
public PropertiesCommand()
execute
public void execute()
throws Exception
- Specified by:
execute
in class RestCommand
- Throws:
Exception
setPropertyValue
public Object setPropertyValue(Object store,
String key,
String value)
throws Exception
- Returns the value for key and sets the new value.
- Parameters:
store
- TDIProperties or TDIPropertyStorekey
- value
- if null the property is removed (if applicable)
- Returns:
- the value before setting the new one
- Throws:
Exception
setPropertyValue
public void setPropertyValue(Object store,
String key,
String value,
boolean protect)
throws Exception
- Sets a new value for the key in the store.
- Parameters:
store
- TDIProperties or TDIPropertyStorekey
- value
- if null the property is removed (if applicable)protect
- if true, the property should be encrypted
- Throws:
Exception
getPropertyValue
public Object getPropertyValue(Object store,
String key)
throws Exception
- Throws:
Exception
commitStore
public void commitStore(Object store)
throws Exception
- Throws:
Exception