com.ibm.rational.rpe.api.docspec
Class ConfigurationLayer

java.lang.Object
  extended by com.ibm.rational.rpe.api.docspec.ConfigurationLayer

public class ConfigurationLayer
extends java.lang.Object

Functions for accessing and operation on the configuration layer. This class is meant to be extended to be more user friendly

Author:
Spurlos

Nested Class Summary
static class ConfigurationLayer.ConfigurationValue
           
 
Constructor Summary
ConfigurationLayer()
           
 
Method Summary
static void readConfigurationData(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata, Credential credential, java.util.List<ConfigurationLayer.ConfigurationValue> data)
          Deprecated. 
 void readConfigurationData(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata, java.lang.String entityName, java.util.List<ConfigurationLayer.ConfigurationValue> data, Credential credential)
          Deprecated. 
static void readConfigurationOptions(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata, Credential credential, java.util.List<ConfigurationLayer.ConfigurationValue> data)
          Deprecated. 
 void readConfigurationOptions(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata, java.lang.String entityName, java.util.List<ConfigurationLayer.ConfigurationValue> data, Credential credential)
          Resolves the configuration metadata if not empty.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConfigurationLayer

public ConfigurationLayer()
Method Detail

readConfigurationData

@Deprecated
public void readConfigurationData(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata,
                                             java.lang.String entityName,
                                             java.util.List<ConfigurationLayer.ConfigurationValue> data,
                                             Credential credential)
                           throws com.ibm.rational.rpe.common.auth.AuthenticationException,
                                  java.io.IOException,
                                  com.ibm.rational.rpe.common.utils.RPEOtherException
Deprecated. 

Resolves the configuration metadata if not empty This method is deprecated and will be removed in a future release. Use readConfigurationOptions Deprecated in 1.2.1

Parameters:
cfgMetadata -
entityName -
data -
credential -
Throws:
com.ibm.rational.rpe.common.auth.AuthenticationException
java.io.IOException
RPEOtherException

readConfigurationData

@Deprecated
public static void readConfigurationData(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata,
                                                    Credential credential,
                                                    java.util.List<ConfigurationLayer.ConfigurationValue> data)
                                  throws com.ibm.rational.rpe.common.auth.AuthenticationException,
                                         java.io.IOException,
                                         com.ibm.rational.rpe.common.utils.RPEOtherException
Deprecated. 

Returns a collection of name-value pairs based on the configuration metadata This method is deprecated and will be removed in a future release. Use readConfigurationOptions Deprecated in 1.2.1

Parameters:
cfgMetadata -
credential -
data -
Throws:
com.ibm.rational.rpe.common.auth.AuthenticationException
java.io.IOException
RPEOtherException

readConfigurationOptions

public void readConfigurationOptions(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata,
                                     java.lang.String entityName,
                                     java.util.List<ConfigurationLayer.ConfigurationValue> data,
                                     Credential credential)
                              throws java.io.IOException,
                                     RPEException
Resolves the configuration metadata if not empty. Depending on themetadata type it will read the values from the Central Library ( Value set) or from a live stream

Parameters:
cfgMetadata -
entityName -
data -
credential -
Throws:
com.ibm.rational.rpe.common.auth.AuthenticationException
java.io.IOException
RPEOtherException
RPEException

readConfigurationOptions

@Deprecated
public static void readConfigurationOptions(com.ibm.rational.rpe.common.template.model.ConfigurationMetadata cfgMetadata,
                                                       Credential credential,
                                                       java.util.List<ConfigurationLayer.ConfigurationValue> data)
                                     throws java.io.IOException,
                                            RPEException
Deprecated. 

Returns a collection of name-value pairs based on the configuration metadata. Only live streams are used This method is deprecated and will be removed in a future release. Use the non static method

Parameters:
cfgMetadata -
credential -
data -
Throws:
com.ibm.rational.rpe.common.auth.AuthenticationException
java.io.IOException
RPEOtherException
RPEException