ServerBinding (Oracle? Fusion Middleware Java API Reference for the Lifecycle Management Environment Specification)

java.lang.Object
- oracle.fmwplatform.envspec.model.topology.ServerBinding

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.ContainerAware<Domain>, oracle.fmwplatform.envspec.common.ReservedKeywordProvider, oracle.fmwplatform.envspec.common.Substitutable, oracle.fmwplatform.envspec.common.Tunable<Domain>
```
public class ServerBinding
extends Object
implements oracle.fmwplatform.envspec.common.Tunable<Domain>
```
Binding information for a server.

Since:

12.2.1

Field Summary

Fields
Modifier and Type Field and Description

static String RESERVED_TOKEN_SERVER

Fields
Modifier and Type	Field and Description
`static String`	`RESERVED_TOKEN_SERVER`

Constructor Summary

Constructors
Constructor and Description

ServerBinding()

Constructors
Constructor and Description
`ServerBinding()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addSetting(String alias, String value)` Convenience method to add a setting with the given alias and value, to the tuning parameters for this ServerBinding.
`String`	`getListenAddress()` Returns the TCP/IP listen address.
`String`	`getListenPort()` Returns the TCP/IP listen port.
`String`	`getName()` Returns the name of the server represented by this ServerBinding.
`Domain`	`getParent()` Returns the object that contains this entity.
`Map<String,String>`	`getReservedKeywords()` Returns a map containing any reserved keywords and values for variable substitution for this entity
`String`	`getServerRef()` Returns the server reference that this binding is for.
`String`	`getSslListenPort()` Returns the TCP/IP listen port for SSL traffic.
`TuningParameters`	`getTuningParameters()` Returns the TuningParameters.
`String`	`getVariableValue(String key)` Returns the variable value assigned to the specified key.
`ServerBinding`	`setListenAddress(String listenAddress)` Sets the TCP/IP listen address.
`ServerBinding`	`setListenPort(String listenPort)` Sets the TCP/IP listen port.
`ServerBinding`	`setName(String name)` Sets the name of this ServerBinding.
`ServerBinding`	`setParent(Domain containerDomain)` Sets the parent of this object.
`ServerBinding`	`setServerRef(String serverRef)` Sets the server reference that this binding is for.
`ServerBinding`	`setSslListenPort(String sslListenPort)` Sets the TCP/IP listen port for SSL traffic.
`ServerBinding`	`setTuningParameters(TuningParameters tuningParameters)` Sets the TuningParameters for this ServerBinding or null if no TuningParameters.
`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 JSON format.
`String`	`toString()` Returns a string representation of the object in JSON 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

- Field Detail
  - RESERVED_TOKEN_SERVER
```
public static final String RESERVED_TOKEN_SERVER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ServerBinding
```
public ServerBinding()
```
- Method Detail
  - addSetting
```
public boolean addSetting(String alias,
                          String value)
```
    Convenience method to add a setting with the given alias and value, to the tuning parameters for this ServerBinding.
    
    Specified by:
    
    addSetting in interface oracle.fmwplatform.envspec.common.Tunable<Domain>
    
    Parameters:
    
    alias - the alias of a Setting
    
    value - the value of a Setting
    
    Returns:
    
    true if the data is successfully added to the list
  - getListenAddress
```
public String getListenAddress()
```
    Returns the TCP/IP listen address.
    
    Returns:
    
    TCP/IP listen address
  - getListenPort
```
public String getListenPort()
```
    Returns the TCP/IP listen port.
    
    Returns:
    
    TCP/IP listen port
  - getName
```
public String getName()
```
    Returns the name of the server represented by this ServerBinding.
    
    Returns:
    
    server name
  - getParent
```
public Domain getParent()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.ContainerAware
    
    Returns the object that contains this entity.
    
    Specified by:
    
    getParent in interface oracle.fmwplatform.envspec.common.ContainerAware<Domain>
    
    Returns:
    
    the object that contains this entity
  - getReservedKeywords
```
public Map<String,String> getReservedKeywords()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.ReservedKeywordProvider
    
    Returns a map containing any reserved keywords and values for variable substitution for this entity
    
    Specified by:
    
    getReservedKeywords in interface oracle.fmwplatform.envspec.common.ReservedKeywordProvider
    
    Returns:
    
    a Map with key value pairs for the reserved keywords
  - getServerRef
```
public String getServerRef()
```
    Returns the server reference that this binding is for.
    
    Returns:
    
    server reference that this binding is for.
  - getSslListenPort
```
public String getSslListenPort()
```
    Returns the TCP/IP listen port for SSL traffic.
    
    Returns:
    
    TCP/IP listen port for SSL traffic
  - getTuningParameters
```
public TuningParameters getTuningParameters()
```
    Returns the TuningParameters.
    
    Specified by:
    
    getTuningParameters in interface oracle.fmwplatform.envspec.common.Tunable<Domain>
    
    Returns:
    
    the TuningParameters
  - setListenAddress
```
public ServerBinding setListenAddress(String listenAddress)
```
    Sets the TCP/IP listen address.
    
    Parameters:
    
    listenAddress - the TCP/IP listen address
    
    Returns:
    
    this ServerBinding object (for method chaining)
  - setListenPort
```
public ServerBinding setListenPort(String listenPort)
```
    Sets the TCP/IP listen port.
    
    Parameters:
    
    listenPort - the TCP/IP listen port
    
    Returns:
    
    this ServerBinding object (for method chaining)
  - setName
```
public ServerBinding setName(String name)
```
    Sets the name of this ServerBinding.
    
    Parameters:
    
    name - the name of this ServerBinding
    
    Returns:
    
    this ServerBinding object (for method chaining)
  - setParent
```
public ServerBinding setParent(Domain containerDomain)
                        throws IllegalArgumentException
```
    Description copied from interface: oracle.fmwplatform.envspec.common.ContainerAware
    
    Sets the parent of this object. The container object has variables in it that are used by child objects.
    
    Specified by:
    
    setParent in interface oracle.fmwplatform.envspec.common.ContainerAware<Domain>
    
    Parameters:
    
    containerDomain - the parent container
    
    Returns:
    
    the ContainerAware parent object
    
    Throws:
    
    IllegalArgumentException
  - setServerRef
```
public ServerBinding setServerRef(String serverRef)
```
    Sets the server reference that this binding is for.
    
    Parameters:
    
    serverRef - the server reference that this binding is for
    
    Returns:
    
    this ServerBinding object (for method chaining)
  - setSslListenPort
```
public ServerBinding setSslListenPort(String sslListenPort)
```
    Sets the TCP/IP listen port for SSL traffic.
    
    Parameters:
    
    sslListenPort - the TCP/IP listen port for SSL traffic
    
    Returns:
    
    this ServerBinding object (for method chaining)
  - setTuningParameters
```
public ServerBinding setTuningParameters(TuningParameters tuningParameters)
```
    Sets the TuningParameters for this ServerBinding or null if no TuningParameters.
    
    Specified by:
    
    setTuningParameters in interface oracle.fmwplatform.envspec.common.Tunable<Domain>
    
    Parameters:
    
    tuningParameters - the TuningParameters for this ServerBinding or null if no TuningParameters
    
    Returns:
    
    this ServerBinding object (for method chaining)
  - getVariableValue
```
public String getVariableValue(String key)
```
    Returns the variable value assigned to the specified key.
    
    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
  - 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
  - toCompactString
```
public String toCompactString()
```
    Returns a compact string representation of the object in JSON format.
    
    Returns:
    
    a compact string representation of the object in JSON format
  - toString
```
public String toString()
```
    Returns a string representation of the object in JSON format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object in JSON format

Class ServerBinding

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RESERVED_TOKEN_SERVER

Constructor Detail

ServerBinding

Method Detail

addSetting

getListenAddress

getListenPort

getName

getParent

getReservedKeywords

getServerRef

getSslListenPort

getTuningParameters

setListenAddress

setListenPort

setName

setParent

setServerRef

setSslListenPort

setTuningParameters

getVariableValue

substitute

toXmlCompactString

toXmlString

toCompactString

toString