TuningParameters (Oracle® Fusion Middleware Java API Reference for the Lifecycle Management Environment Specification)

java.lang.Object
- oracle.fmwplatform.envspec.model.tuning.TuningParameters

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.Versioned
```
public class TuningParameters
extends Object
implements oracle.fmwplatform.envspec.common.Versioned
```
TuningParameters are used to provide low level additional settings that the user wishes to customize/tune. We provide a predefined list of parameters that can be tuned. This list is based on experience with the most commonly required parameters.

Since:

12.2.1

Constructor Summary

Constructors
Constructor and Description

TuningParameters()

TuningParameters(TuningParameters original)

Constructors
Constructor and Description
`TuningParameters()`
`TuningParameters(TuningParameters original)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addSetting(String alias, String value)` Add a setting with the given alias and value, to this tuning parameter instance.
`boolean`	`addTuningParameters(String tuningParametersName)` Add a TuningParameters to the list of TuningParameters in this TuningParameters identified by the tuningParametersName.
`boolean`	`addTuningParameters(String tuningParametersName, String version, EnvironmentModelFileLocator locator)` Add a TuningParameters to the list of TuningParameters in this TuningParameters identified by the tuningParametersName.
`boolean`	`addTuningParameters(TuningParameters tuningParameters)` Add a TuningParameters to the list of TuningParameters in this TuningParameters.
`List<MBeanSetting>`	`getAllMBeanSettings()` Returns MBeanSettings from this TuningParameters as well as from any references, all the way down the chain of nested references.
`List<Setting>`	`getAllSettings()` Returns settings from this TuningParameters as well as from any references, all the way down the chain.
`List<Variable>`	`getAllVariables()` Returns the variables from this TuningParameters as well as any referenced TuningParameters, all the way down the chain.
`List<WLSTSetting>`	`getAllWLSTSettings()` Returns WLSTSettings from this TuningParameters as well as from any references, all the way down the chain of nested references.
`Map<String,String>`	`getEffectiveVariables()` Returns the combined set of variables from this object as well as any containing objects.
`String`	`getFMWVersionRange()` Returns the range of FMW releases that this model object is supported under.
`List<MBeanSetting>`	`getmBeanSettings()` Returns the mbean settings only from this TuningParameters.
`String`	`getName()` Returns the name for the TuningParameters.
`String`	`getSchemaVersion()` Returns the schema version for the TuningParameters.
`Setting`	`getSetting(String alias)` Returns the Setting for this alias or null if no match found.
`List<Setting>`	`getSettings()` Returns the settings only from this TuningParameters.
`String`	`getSettingValueByAlias(String alias)` Returns the Setting value for this alias or null if no match found.
`List<TuningParameters>`	`getTuningParameters()` The child TuningParameters of this TuningParameters or null if one has not been set.
`String`	`getTuningVariableValue(String key)` Returns the value for the specified variable key.
`List<Variable>`	`getVariables()` Returns the list of variables for this TuningParameters for use in substituting any wildcard values %x%.
`String`	`getVersion()` Returns the consumer specified version of the this model file.
`List<WLSTSetting>`	`getWlstSettings()` Returns the wlst settings only from this TuningParameters.
`boolean`	`removeSetting(String alias)` Removes the Setting for this alias from this tuning parameter instance.
`TuningParameters`	`setFMWVersionRange(String fmwVersionRange)` Sets the the range of FMW releases that this model object is supported under.
`TuningParameters`	`setmBeanSettings(List<MBeanSetting> mBeanSettings)` Sets the mbean settings only from this TuningParameters.
`TuningParameters`	`setName(String name)` Sets the name for the TuningParameters.
`TuningParameters`	`setParent(oracle.fmwplatform.envspec.common.Tunable tunable)` Sets the container of this tuning params object and the entity type.
`TuningParameters`	`setSchemaVersion(String schemaVersion)` Sets the schema version for the TuningParameters.
`TuningParameters`	`setSettings(List<Setting> settings)` Sets the settings only on this TuningParameters.
`TuningParameters`	`setTuningParameters(List<TuningParameters> tuningParameters)` Set the list of child TuningParameters for this TuningParameters
`TuningParameters`	`setVersion(String version)` Sets the consumer specified version of the their model file.
`TuningParameters`	`setWlstSettings(List<WLSTSetting> wlstSettings)` The wlst settings only from this TuningParameters.
`String`	`toCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toJsonCompactString()` Returns a compact string representation of the object in JSON format.
`String`	`toJsonString()` Returns a string representation of the object in JSON format.
`String`	`toString()` Returns a string representation of the object in XML format.
`String`	`toXmlCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toXmlString()` Returns a string representation of the object in XML format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TuningParameters
```
public TuningParameters()
```
  - TuningParameters
```
public TuningParameters(TuningParameters original)
```
- Method Detail
  - addTuningParameters
```
public boolean addTuningParameters(String tuningParametersName,
                                   String version,
                                   EnvironmentModelFileLocator locator)
                            throws FMWEnvSpecException
```
    Add a TuningParameters to the list of TuningParameters in this TuningParameters identified by the tuningParametersName. When multiple versions of a TuningParameters are available with the same name, the version number can be specified to select the desired TuningParameters. Specifying the optional file locator allows the TuningParameters search to include other TuningParameters locations outside the Oracle Home. If there are any unresolved TuningParameters reference then they will be resolved first.
    
    Parameters:
    
    tuningParametersName - The name of the TuningParameters to be added
    
    version - The version of the TuningParameters to be added or null if any version is acceptable
    
    locator - An EnvironmentModelFileLocator locator that has been initialized with the paths that are to be searched when finding the TuningParameters or null if only the Oracle Home needs to be searched
    
    Returns:
    
    whether or not the tuning parameter was added
    
    Throws:
    
    FMWEnvSpecException - The TuningParameters could not be loaded
  - addTuningParameters
```
public boolean addTuningParameters(TuningParameters tuningParameters)
```
    Add a TuningParameters to the list of TuningParameters in this TuningParameters. If there are any unresolved TuningParameters reference then they will be resolved first.
    
    Parameters:
    
    tuningParameters - the TuningParameters to be added
    
    Returns:
    
    whether or not the tuning parameters were added
  - addTuningParameters
```
public boolean addTuningParameters(String tuningParametersName)
                            throws FMWEnvSpecException
```
    Add a TuningParameters to the list of TuningParameters in this TuningParameters identified by the tuningParametersName. This method uses the internal file locator to find and instantiate the TuningParameters identified by the tuningParametersName provided. If multiple versions of the TuningParameters exist that are identified by the same name, the first one found will be used. If there are any unresolved TuningParameters reference then they will be resolved first.
    
    Parameters:
    
    tuningParametersName - the name to be used to identify the TuningParameters
    
    Returns:
    
    whether or not the tuning parameters were added
    
    Throws:
    
    FMWEnvSpecException - the TuningParameters could not be loaded
  - getAllMBeanSettings
```
public List<MBeanSetting> getAllMBeanSettings()
                                       throws FMWEnvSpecException
```
    Returns MBeanSettings from this TuningParameters as well as from any references, all the way down the chain of nested references. If the TuningParameters are inlined, and there are also references to TuningParameters in separate file(s), then the inline MBeanSettings will be unioned with those in the file(s). If there is a collision, the inlined MBeanSetting will take precedence. A MBeanSetting is determined unique based on fields mBeanName, mBeanProperty, mBeanServer.
    
    Returns:
    
    MBeanSettings from this TuningParameters as well as from any references, all the way down the chain of nested references
    
    Throws:
    
    FMWEnvSpecException - when any external TuningParameters file references cannot be read
  - getAllSettings
```
public List<Setting> getAllSettings()
                             throws FMWEnvSpecException
```
    Returns settings from this TuningParameters as well as from any references, all the way down the chain. If the TuningParameters are inlined, and there are also references to TuningParameters in separate file(s), then the inline settings will be unioned with those in the file(s). If there is a collision, the inlined setting will take precedence.
    
    Returns:
    
    settings from this TuningParameters as well as from any references, all the way down the chain
    
    Throws:
    
    FMWEnvSpecException - when any external TuningParameters file references cannot be read
  - getAllVariables
```
public List<Variable> getAllVariables()
                               throws FMWEnvSpecException
```
    Returns the variables from this TuningParameters as well as any referenced TuningParameters, all the way down the chain. Does not contain variables from the container domain or topology
    
    Returns:
    
    the variables from this TuningParameters as well as any referenced TuningParameters, all the way down the chain
    
    Throws:
    
    FMWEnvSpecException - when any external TuningParameters file references cannot be read
  - getAllWLSTSettings
```
public List<WLSTSetting> getAllWLSTSettings()
                                     throws FMWEnvSpecException
```
    Returns WLSTSettings from this TuningParameters as well as from any references, all the way down the chain of nested references. If the TuningParameters are inlined, and there are also references to TuningParameters in separate file(s), then the inline WLSTSettings will be unioned with those in the file(s). If there is a collision, the inlined WLSTSetting will take precedence. A WLSTSeting is determined unique based on fields wlstName and wlstPath.
    
    Returns:
    
    WLSTSettings from this TuningParameters as well as from any references, all the way down the chain of nested references
    
    Throws:
    
    FMWEnvSpecException - when any external TuningParameters file references cannot be read
  - getEffectiveVariables
```
public Map<String,String> getEffectiveVariables()
                                         throws FMWEnvSpecException
```
    Returns the combined set of variables from this object as well as any containing objects. For a server binding, cluster binding or data source binding, it will combine all variables defined in these entities with those from the containing domain and containing topology. For a domain or node manager, it will combine any variables defined in these entities with those from the containing topology. When performing substitution, if there are multiple definitions of the same parameter name, then the one with closest scope is used — definitions of a parameter in an entity x, effectively ‘hide’ any definitions of that parameter in larger entities containing the entity x
    
    Returns:
    
    the combined set of variables from this object as well as any containing objects
    
    Throws:
    
    FMWEnvSpecException - when any external TuningParameters file references cannot be read
  - getTuningVariableValue
```
public String getTuningVariableValue(String key)
```
    Returns the value for the specified variable key. Only local variables are examined. Variables from the assigned element and its parents are not considered.
    
    Parameters:
    
    key - the key of the variable to be checked
    
    Returns:
    
    the variable value, or null if not found
  - getmBeanSettings
```
public List<MBeanSetting> getmBeanSettings()
```
    Returns the mbean settings only from this TuningParameters. Does not include mbean settings from any referenced files
    
    Returns:
    
    the mbean settings only from this TuningParameters
  - getName
```
public String getName()
```
    Returns the name for the TuningParameters.
    
    Specified by:
    
    getName in interface oracle.fmwplatform.envspec.common.Versioned
    
    Returns:
    
    the name for the TuningParametersthe name for the TuningParameters
  - getSchemaVersion
```
public String getSchemaVersion()
```
    Returns the schema version for the TuningParameters.
    
    Specified by:
    
    getSchemaVersion in interface oracle.fmwplatform.envspec.common.Versioned
    
    Returns:
    
    the schema version for the TuningParameters
  - getSettings
```
public List<Setting> getSettings()
```
    Returns the settings only from this TuningParameters. Does not include settings from any referenced files
    
    Returns:
    
    the settings only from this TuningParameters
  - getSettingValueByAlias
```
public String getSettingValueByAlias(String alias)
                              throws FMWEnvSpecException
```
    Returns the Setting value for this alias or null if no match found.
    
    Parameters:
    
    alias - the value of a Setting by its key or alias
    
    Returns:
    
    the Setting value for this alias or null if no match found
    
    Throws:
    
    FMWEnvSpecException - When any external TuningParameters file references cannot be read
  - getSetting
```
public Setting getSetting(String alias)
                   throws FMWEnvSpecException
```
    Returns the Setting for this alias or null if no match found.
    
    Parameters:
    
    alias - the value of a Setting by its key or alias
    
    Returns:
    
    the Setting value for this alias or null if no match found
    
    Throws:
    
    FMWEnvSpecException - when any external TuningParameters file references cannot be read
  - addSetting
```
public boolean addSetting(String alias,
                          String value)
```
    Add a setting with the given alias and value, to this tuning parameter instance. If the setting already exists within this tuning parameter list, the value will be replaced with this new value.
    
    Parameters:
    
    alias - the alias of a Setting
    
    value - the value of a Setting
    
    Returns:
    
    whether or not the setting was added
  - removeSetting
```
public boolean removeSetting(String alias)
                      throws FMWEnvSpecException
```
    Removes the Setting for this alias from this tuning parameter instance.
    
    Parameters:
    
    alias - the Setting alias
    
    Returns:
    
    true if the setting was successfully removed
    
    Throws:
    
    FMWEnvSpecException - when any external TuningParameters file references cannot be read
  - getTuningParameters
```
public List<TuningParameters> getTuningParameters()
```
    The child TuningParameters of this TuningParameters or null if one has not been set. If there is a ResourceReference then the reference will be resolved from the file system.
    
    Returns:
    
    the child TuningParameters of this TuningParameters or null if one has not been set
  - getVariables
```
public List<Variable> getVariables()
```
    Returns the list of variables for this TuningParameters for use in substituting any wildcard values %x%.
    
    Returns:
    
    the list of variables for this TuningParameters for use in substituting any wildcard values %x%
  - getVersion
```
public String getVersion()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Returns the consumer specified version of the this model file. This should be incremented when the model file is changed. This is used to allow the consumer to select a version by using it's version or a version range.
    
    Specified by:
    
    getVersion in interface oracle.fmwplatform.envspec.common.Versioned
    
    Returns:
    
    the consumer specified version of the their model file
  - getFMWVersionRange
```
public String getFMWVersionRange()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Returns the range of FMW releases that this model object is supported under.
    
    Specified by:
    
    getFMWVersionRange in interface oracle.fmwplatform.envspec.common.Versioned
    
    Returns:
    
    the consumer specified version of the their model
  - setFMWVersionRange
```
public TuningParameters setFMWVersionRange(String fmwVersionRange)
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Sets the the range of FMW releases that this model object is supported under.
    
    Specified by:
    
    setFMWVersionRange in interface oracle.fmwplatform.envspec.common.Versioned
    
    Parameters:
    
    fmwVersionRange - the range of FMW releases that this model object is supported under
    
    Returns:
    
    this (for method chaining)
  - getWlstSettings
```
public List<WLSTSetting> getWlstSettings()
```
    Returns the wlst settings only from this TuningParameters. Does not include wlst settings from any referenced files.
    
    Returns:
    
    the wlst settings only from this TuningParameters
  - setParent
```
public TuningParameters setParent(oracle.fmwplatform.envspec.common.Tunable tunable)
```
    Sets the container of this tuning params object and the entity type.
    
    Parameters:
    
    tunable - the object that contains this TuningParameters in it
    
    Returns:
    
    this (for method chaining)
  - setmBeanSettings
```
public TuningParameters setmBeanSettings(List<MBeanSetting> mBeanSettings)
```
    Sets the mbean settings only from this TuningParameters. Does not impact mbean settings from any referenced files.
    
    Parameters:
    
    mBeanSettings - the mbean settings to be set for this TuningParameters.
    
    Returns:
    
    this (for method chaining)
  - setName
```
public TuningParameters setName(String name)
```
    Sets the name for the TuningParameters.
    
    Specified by:
    
    setName in interface oracle.fmwplatform.envspec.common.Versioned
    
    Parameters:
    
    name - the name to be set for this TuningParameters.
    
    Returns:
    
    this (for method chaining)
  - setSchemaVersion
```
public TuningParameters setSchemaVersion(String schemaVersion)
```
    Sets the schema version for the TuningParameters.
    
    Specified by:
    
    setSchemaVersion in interface oracle.fmwplatform.envspec.common.Versioned
    
    Parameters:
    
    schemaVersion - the schema version for the TuningParameter
    
    Returns:
    
    this (for method chaining)
  - setSettings
```
public TuningParameters setSettings(List<Setting> settings)
```
    Sets the settings only on this TuningParameters. Does not impact settings from any referenced files
    
    Parameters:
    
    settings - the settings only on this TuningParameter
    
    Returns:
    
    this (for method chaining)
  - setTuningParameters
```
public TuningParameters setTuningParameters(List<TuningParameters> tuningParameters)
```
    Set the list of child TuningParameters for this TuningParameters
    
    Parameters:
    
    tuningParameters - the list of child tuningParameters to be set to this TuningParameters
    
    Returns:
    
    this (for method chaining)
  - setVersion
```
public TuningParameters setVersion(String version)
```
    Description copied from interface: oracle.fmwplatform.envspec.common.Versioned
    
    Sets the consumer specified version of the their model file. This should be incremented when the model file is changed. This is used to allow the consumer to select a version by using it's version or a version range.
    
    Specified by:
    
    setVersion in interface oracle.fmwplatform.envspec.common.Versioned
    
    Parameters:
    
    version - the consumer specified version of the their model file.
    
    Returns:
    
    this (for method chaining)
  - setWlstSettings
```
public TuningParameters setWlstSettings(List<WLSTSetting> wlstSettings)
```
    The wlst settings only from this TuningParameters. Does not impact wlst settings from any referenced files.
    
    Parameters:
    
    wlstSettings - the wlst settings only from this TuningParameters
    
    Returns:
    
    this (for method chaining)
  - toXmlCompactString
```
public String toXmlCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Returns:
    
    a compact string representation of the object in XML format
  - toXmlString
```
public String toXmlString()
```
    Returns a string representation of the object in XML format.
    
    Returns:
    
    a string representation of the object in XML format
  - toJsonCompactString
```
public String toJsonCompactString()
```
    Returns a compact string representation of the object in JSON format.
    
    Returns:
    
    a compact string representation of the object in JSON format
  - toJsonString
```
public String toJsonString()
```
    Returns a string representation of the object in JSON format.
    
    Returns:
    
    a string representation of the object in JSON format
  - toCompactString
```
public String toCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Returns:
    
    a compact string representation of the object in XML format
  - toString
```
public String toString()
```
    Returns a string representation of the object in XML format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object in XML format

Class TuningParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TuningParameters

TuningParameters

Method Detail

addTuningParameters

addTuningParameters

addTuningParameters

getAllMBeanSettings

getAllSettings

getAllVariables

getAllWLSTSettings

getEffectiveVariables

getTuningVariableValue

getmBeanSettings

getName

getSchemaVersion

getSettings

getSettingValueByAlias

getSetting

addSetting

removeSetting

getTuningParameters

getVariables

getVersion

getFMWVersionRange

setFMWVersionRange

getWlstSettings

setParent

setmBeanSettings

setName

setSchemaVersion

setSettings

setTuningParameters

setVersion

setWlstSettings

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString