public class ServerBinding extends Object implements oracle.fmwplatform.envspec.common.Tunable<Domain>, oracle.fmwplatform.util.validation.ValidationParticipant
Modifier and Type | Field and Description |
---|---|
static String |
RESERVED_TOKEN_SERVER |
Constructor and Description |
---|
ServerBinding() |
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.
|
oracle.fmwplatform.envspec.lookup.data.AliasCategory |
getAliasCategory() |
String |
getClusterName() |
String |
getId()
Returns the id used to reference this ServerBinding.
|
String |
getListenAddress()
Returns the server's listen address.
|
String |
getListenPort()
Returns the server's listen port.
|
String |
getMachineName()
Return name of the machine associated with Server.
|
String |
getName()
Returns the server's name, as used in the domain.
|
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 |
setId(String id)
Sets id to be used when referencing this ServerBinding.
|
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 container object that contains this.
|
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 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)
A server binding must have a listen port or an SSL listen port.
|
public static final String RESERVED_TOKEN_SERVER
public String getMachineName()
public String getId()
public ServerBinding setId(String id)
id
- the id to be used when referencing this ServerBindingpublic String getServerRef()
public ServerBinding setServerRef(String serverRef)
serverRef
- the server reference that this binding is forpublic String getName()
getName
in interface oracle.fmwplatform.envspec.common.Tunable<Domain>
public ServerBinding setName(String name)
name
- the name of this ServerBindingpublic String getListenAddress()
public ServerBinding setListenAddress(String listenAddress)
listenAddress
- the TCP/IP listen addresspublic String getListenPort()
public ServerBinding setListenPort(String listenPort)
listenPort
- the TCP/IP listen portpublic String getSslListenPort()
public ServerBinding setSslListenPort(String sslListenPort)
sslListenPort
- the TCP/IP listen port for SSL trafficpublic TuningParameters getTuningParameters()
getTuningParameters
in interface oracle.fmwplatform.envspec.common.Tunable<Domain>
public ServerBinding setTuningParameters(TuningParameters tuningParameters)
setTuningParameters
in interface oracle.fmwplatform.envspec.common.Tunable<Domain>
tuningParameters
- the TuningParameters for this ServerBinding or null if no TuningParameterspublic oracle.fmwplatform.envspec.lookup.data.AliasCategory getAliasCategory()
getAliasCategory
in interface oracle.fmwplatform.envspec.common.Tunable<Domain>
public Domain getParent()
oracle.fmwplatform.envspec.common.ContainerAware
getParent
in interface oracle.fmwplatform.envspec.common.ContainerAware<Domain>
public ServerBinding setParent(Domain containerDomain)
oracle.fmwplatform.envspec.common.ContainerAware
setParent
in interface oracle.fmwplatform.envspec.common.ContainerAware<Domain>
containerDomain
- the parent containerpublic boolean addSetting(String alias, String value)
addSetting
in interface oracle.fmwplatform.envspec.common.Tunable<Domain>
alias
- the alias of a Settingvalue
- the value of a Settingpublic String getClusterName()
public Map<String,String> getReservedKeywords()
oracle.fmwplatform.envspec.common.ReservedKeywordProvider
getReservedKeywords
in interface oracle.fmwplatform.envspec.common.ReservedKeywordProvider
public String getVariableValue(String key)
getVariableValue
in interface oracle.fmwplatform.envspec.common.Substitutable
key
- the key of the variable to be checkedpublic String substitute(String text)
substitute
in interface oracle.fmwplatform.envspec.common.Substitutable
text
- the original textpublic void validate(oracle.fmwplatform.util.validation.Validate validate)
validate
in interface oracle.fmwplatform.util.validation.ValidationParticipant
public String toXmlCompactString()
public String toXmlString()
public String toJsonCompactString()
public String toJsonString()
public String toCompactString()