public class VirtualHost extends Object implements oracle.fmwplatform.envspec.common.ContainerAware<WebTier>, oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.ParentContainerWithVariables
Modifier and Type | Class and Description |
---|---|
static class |
VirtualHost.Protocol |
Constructor and Description |
---|
VirtualHost() |
Modifier and Type | Method and Description |
---|---|
boolean |
addAllLocations(List<Location> locations)
Add a Location to this VirtualHost object
|
boolean |
addLocation(Location location)
Add a Location to this VirtualHost object
|
Map<String,String> |
getEffectiveVariables()
Returns the derived map of variables for this element.
|
String |
getId()
Returns the id used to reference this model object.
|
List<Location> |
getLocations()
Returns a List of Locations mapped to this VirtualHost
|
String |
getName()
Returns the name of this VirtualHost Object
|
WebTier |
getParent()
Returns the object that contains this entity
|
VirtualHost.Protocol |
getProtocol()
Returns the protocol of this VirtualHost
|
String |
getServerAddress()
Returns the server address of this VirtualHost object
|
String |
getServerAdmin()
Returns the server admin (email) address
|
String |
getVariableValue(String key)
Returns the variable value assigned to the specified key.
|
VirtualHost |
setId(String id)
Sets the id used to reference this VirtualHost object
|
VirtualHost |
setLocations(List<Location> locations)
Sets a List of Locations to this VirtualHost object
|
VirtualHost |
setName(String name)
Sets the name of this VirtualHost object
|
VirtualHost |
setParent(WebTier containerWebTier)
Sets the container object that contains this.
|
VirtualHost |
setProtocol(VirtualHost.Protocol protocol)
Sets the protocol of this VirtualHost
|
VirtualHost |
setServerAddress(String serverAddress)
Sets the server address of this VirtualHost object
|
VirtualHost |
setServerAdmin(String serverAdmin)
Sets email address of server admin
|
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.
|
public WebTier getParent()
oracle.fmwplatform.envspec.common.ContainerAware
getParent
in interface oracle.fmwplatform.envspec.common.ContainerAware<WebTier>
public VirtualHost setParent(WebTier containerWebTier)
oracle.fmwplatform.envspec.common.ContainerAware
setParent
in interface oracle.fmwplatform.envspec.common.ContainerAware<WebTier>
containerWebTier
- the parent containerpublic String getId()
getId
in interface oracle.fmwplatform.envspec.common.EntityWithId
public VirtualHost setId(String id)
setId
in interface oracle.fmwplatform.envspec.common.EntityWithId
id
- id to setpublic String getName()
public VirtualHost setName(String name)
name
- name to setpublic String getServerAddress()
public VirtualHost setServerAddress(String serverAddress)
serverAddress
- of the objectpublic String getServerAdmin()
public VirtualHost setServerAdmin(String serverAdmin)
serverAdmin
- email address to setpublic List<Location> getLocations()
public VirtualHost setLocations(List<Location> locations) throws IllegalArgumentException
locations
- list of locationsIllegalArgumentException
public boolean addLocation(Location location) throws IllegalArgumentException
location
- of the objecttrue
if the list of locations changed as a result of this callIllegalArgumentException
public boolean addAllLocations(List<Location> locations) throws IllegalArgumentException
locations
- a list of locationstrue
if the list of locations changed as a result of this callIllegalArgumentException
public VirtualHost.Protocol getProtocol()
public VirtualHost setProtocol(VirtualHost.Protocol protocol)
protocol
- of the objectpublic Map<String,String> getEffectiveVariables() throws FMWEnvSpecException
getEffectiveVariables
in interface oracle.fmwplatform.envspec.common.ParentContainerWithVariables
FMWEnvSpecException
- if an error occurspublic 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 String toXmlCompactString()
public String toXmlString()
public String toJsonCompactString()
public String toJsonString()
public String toCompactString()