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

java.lang.Object
- oracle.fmwplatform.envspec.model.topology.coherence.CoherenceAddressProviderBinding

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.ContainerAware<CoherenceModuleBinding>, oracle.fmwplatform.envspec.common.ParentContainerWithVariables, oracle.fmwplatform.envspec.common.Substitutable, oracle.fmwplatform.util.validation.ValidationParticipant
```
public class CoherenceAddressProviderBinding
extends Object
implements oracle.fmwplatform.envspec.common.ContainerAware<CoherenceModuleBinding>, oracle.fmwplatform.envspec.common.ParentContainerWithVariables, oracle.fmwplatform.util.validation.ValidationParticipant
```
CoherenceAddressProviderBinding is an element of the CoherenceClusterBinding that holds address provider bindings.

Since:

12.2.2.0

Field Summary

Fields
Modifier and Type Field and Description

static String COHERENCE_ADDRESS_PROVIDER_TOKEN
The alias token used to substitute the address provider name in the alias' WLST path.

Fields
Modifier and Type	Field and Description
`static String`	`COHERENCE_ADDRESS_PROVIDER_TOKEN` The alias token used to substitute the address provider name in the alias' WLST path.

Constructor Summary

Constructors
Constructor and Description

CoherenceAddressProviderBinding()

Constructors
Constructor and Description
`CoherenceAddressProviderBinding()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addSocketAddressBinding(CoherenceSocketAddressBinding binding)` Add the new socket address binding if one with the same name is not already present.
`String`	`getCoherenceAddressProviderRef()` Get the CoherenceAddressProvider reference for this binding.
`Map<String,String>`	`getEffectiveVariables()` Returns the variables from the tuning parameters of this binding, as well as from its containing domain.
`String`	`getName()` Get the name of the address provider.
`CoherenceModuleBinding`	`getParent()` Returns the object that contains this entity
`String`	`getResourceRef()` Get the resource reference for this binding.
`CoherenceSocketAddressBinding`	`getSocketAddressBinding(String bindingName)` Get the specified socket address binding.
`CoherenceSocketAddressBinding`	`getSocketAddressBindingByResourceReference(String refName)` Get the specified socket address binding by its resource reference.
`List<CoherenceSocketAddressBinding>`	`getSocketAddressBindings()` Get the list of socket address bindings.
`String`	`getVariableValue(String key)` Returns the variable value assigned to the specified key.
`CoherenceAddressProviderBinding`	`setCoherenceAddressProviderRef(String coherenceAddressProviderRef)` Set the CoherenceAddressProvider reference for this binding.
`CoherenceAddressProviderBinding`	`setName(String name)` Set the name of the address provider.
`CoherenceAddressProviderBinding`	`setParent(CoherenceModuleBinding containerCoherenceModuleBinding)` Sets the container object that contains this.
`String`	`substitute(String text)` Replaces substitution keys in the specified text with their corresponding values.
`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.
`void`	`validate(oracle.fmwplatform.util.validation.Validate validate)`

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

- Field Detail
  - COHERENCE_ADDRESS_PROVIDER_TOKEN
```
public static final String COHERENCE_ADDRESS_PROVIDER_TOKEN
```
    The alias token used to substitute the address provider name in the alias' WLST path.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CoherenceAddressProviderBinding
```
public CoherenceAddressProviderBinding()
```
- Method Detail
  - getResourceRef
```
public String getResourceRef()
```
    Get the resource reference for this binding.
    
    Returns:
    
    the resource reference
  - getCoherenceAddressProviderRef
```
public String getCoherenceAddressProviderRef()
```
    Get the CoherenceAddressProvider reference for this binding.
    
    Returns:
    
    the CoherenceAddressProvider reference
  - setCoherenceAddressProviderRef
```
public CoherenceAddressProviderBinding setCoherenceAddressProviderRef(String coherenceAddressProviderRef)
```
    Set the CoherenceAddressProvider reference for this binding.
    
    Parameters:
    
    coherenceAddressProviderRef - the new CoherenceAddressProvider reference
    
    Returns:
    
    the current CoherenceAddressProviderBinding object
  - getName
```
public String getName()
```
    Get the name of the address provider.
    
    Returns:
    
    the address provider name
  - setName
```
public CoherenceAddressProviderBinding setName(String name)
```
    Set the name of the address provider.
    
    Parameters:
    
    name - the new address provider name
    
    Returns:
    
    the current CoherenceAddressProviderBinding object
  - addSocketAddressBinding
```
public boolean addSocketAddressBinding(CoherenceSocketAddressBinding binding)
```
    Add the new socket address binding if one with the same name is not already present.
    
    Parameters:
    
    binding - the new binding to add
    
    Returns:
    
    whether or not the binding was added
  - getSocketAddressBinding
```
public CoherenceSocketAddressBinding getSocketAddressBinding(String bindingName)
```
    Get the specified socket address binding.
    
    Parameters:
    
    bindingName - the name of the socket address binding to get
    
    Returns:
    
    the specified socket address binding, or null if it was not found
  - getSocketAddressBindingByResourceReference
```
public CoherenceSocketAddressBinding getSocketAddressBindingByResourceReference(String refName)
```
    Get the specified socket address binding by its resource reference.
    
    Parameters:
    
    refName - the value of the Coherence socket address reference to use
    
    Returns:
    
    the specified socket address binding, or null if it was not found
  - getSocketAddressBindings
```
public List<CoherenceSocketAddressBinding> getSocketAddressBindings()
```
    Get the list of socket address bindings.
    
    Returns:
    
    the list of socket address bindings
  - validate
```
public void validate(oracle.fmwplatform.util.validation.Validate validate)
```
    Specified by:
    
    validate in interface oracle.fmwplatform.util.validation.ValidationParticipant
  - getParent
```
public CoherenceModuleBinding getParent()
```
    Returns the object that contains this entity
    
    Specified by:
    
    getParent in interface oracle.fmwplatform.envspec.common.ContainerAware<CoherenceModuleBinding>
    
    Returns:
    
    parent container
  - setParent
```
public CoherenceAddressProviderBinding setParent(CoherenceModuleBinding containerCoherenceModuleBinding)
```
    Sets the container object that contains this. The container object has variables in it that are used in this.
    
    Specified by:
    
    setParent in interface oracle.fmwplatform.envspec.common.ContainerAware<CoherenceModuleBinding>
    
    Parameters:
    
    containerCoherenceModuleBinding - the parent container
    
    Returns:
    
    the current container-aware object
  - getVariableValue
```
public String getVariableValue(String key)
```
    Returns the variable value assigned to the specified key. Reserved keywords are checked first, then tuning parameters and parent topology.
    
    Specified by:
    
    getVariableValue in interface oracle.fmwplatform.envspec.common.Substitutable
    
    Parameters:
    
    key - the key of the variable to be checked
    
    Returns:
    
    the variable value, or null if not found
  - substitute
```
public String substitute(String text)
```
    Replaces substitution keys in the specified text with their corresponding values.
    
    Specified by:
    
    substitute in interface oracle.fmwplatform.envspec.common.Substitutable
    
    Parameters:
    
    text - the original text
    
    Returns:
    
    the text with substitution keys replaced
  - getEffectiveVariables
```
public Map<String,String> getEffectiveVariables()
                                         throws FMWEnvSpecException
```
    Returns the variables from the tuning parameters of this binding, as well as from its containing domain. Any variables defined within the tuning parameters of this binding overrides the ones from domain.
    
    Specified by:
    
    getEffectiveVariables in interface oracle.fmwplatform.envspec.common.ParentContainerWithVariables
    
    Returns:
    
    the variables from the tuning parameters of this binding, as well as its domain and the topology
    
    Throws:
    
    FMWEnvSpecException - When any tuning parameters references cannot be read
  - 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 CoherenceAddressProviderBinding

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COHERENCE_ADDRESS_PROVIDER_TOKEN

Constructor Detail

CoherenceAddressProviderBinding

Method Detail

getResourceRef

getCoherenceAddressProviderRef

setCoherenceAddressProviderRef

getName

setName

addSocketAddressBinding

getSocketAddressBinding

getSocketAddressBindingByResourceReference

getSocketAddressBindings

validate

getParent

setParent

getVariableValue

substitute

getEffectiveVariables

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString