com.softwareag.centrasite.api.configurator
Interface Configurator


public interface Configurator


Method Summary
 java.util.List<ConfiguratorItem> getAllItems()
          Gets all Configuration items
 java.lang.String getItemAttribute(java.lang.String path, java.lang.String attribute)
          Get attribute value of given path.
 java.util.Map<java.lang.String,java.util.List<ConfiguratorItem>> getItems(java.util.List<java.lang.String> paths)
          Get ConfiguratorItems for given list of paths
 java.util.List<ConfiguratorItem> getItems(java.lang.String path)
          Get ConfiguratorItems for given path
 java.lang.String getItemValue(java.lang.String path)
          Get item value of given path.
 boolean isReadOnly(java.lang.String path)
          Checks whether its read only
 void reload()
          Clears the caches and reloads all the properties from repository
 void reload(java.util.List<ConfiguratorItem> configItems)
          Clears the specified configuration items from the cache
 void removeItem(ConfiguratorItem configItem)
           
 void removeItems(java.lang.String path)
           
 void save()
          Saves the modified configuration files
 void setItems(java.util.List<ConfiguratorItem> configItems)
          Sets the given Configuration Items
 void setProtectAll(boolean protect)
          Protects all properties
 

Method Detail

getItems

java.util.List<ConfiguratorItem> getItems(java.lang.String path)
                                          throws CLLException
Get ConfiguratorItems for given path

Parameters:
path -
Returns:
list of ConfiguratorItem
Throws:
CLLException

getItems

java.util.Map<java.lang.String,java.util.List<ConfiguratorItem>> getItems(java.util.List<java.lang.String> paths)
                                                                          throws CLLException
Get ConfiguratorItems for given list of paths

Parameters:
paths -
Returns:
Maps of ConfiguratorItems
Throws:
CLLException

getItemValue

java.lang.String getItemValue(java.lang.String path)
                              throws CLLException
Get item value of given path. It should be used for single value properties

Parameters:
path -
Returns:
item value of given path
Throws:
CLLException

getItemAttribute

java.lang.String getItemAttribute(java.lang.String path,
                                  java.lang.String attribute)
                                  throws CLLException
Get attribute value of given path. It should be used for single value properties.

Parameters:
path -
attribute -
Returns:
attribute value of given path.
Throws:
CLLException

isReadOnly

boolean isReadOnly(java.lang.String path)
                   throws CLLException
Checks whether its read only

Parameters:
path -
Returns:
true if the parameter is valid path else false
Throws:
CLLException

save

void save()
          throws CLLException
Saves the modified configuration files

Throws:
CLLException

reload

void reload()
Clears the caches and reloads all the properties from repository


reload

void reload(java.util.List<ConfiguratorItem> configItems)
Clears the specified configuration items from the cache


setItems

void setItems(java.util.List<ConfiguratorItem> configItems)
              throws CLLException
Sets the given Configuration Items

Parameters:
configItems -
Throws:
CLLException

setProtectAll

void setProtectAll(boolean protect)
                   throws CLLException
Protects all properties

Parameters:
protect -
Throws:
CLLException

getAllItems

java.util.List<ConfiguratorItem> getAllItems()
                                             throws CLLException
Gets all Configuration items

Returns:
List of ConfiguratorItem
Throws:
CLLException

removeItem

void removeItem(ConfiguratorItem configItem)
                throws CLLException
Parameters:
configItem -
Throws:
CLLException

removeItems

void removeItems(java.lang.String path)
                 throws CLLException
Parameters:
path -
Throws:
CLLException