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

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

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.ContainerAware<WebTier>, oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.ParentContainerWithVariables, oracle.fmwplatform.envspec.common.Substitutable
```
public class VirtualHost
extends Object
implements oracle.fmwplatform.envspec.common.ContainerAware<WebTier>, oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.ParentContainerWithVariables
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VirtualHost.Protocol

Nested Classes
Modifier and Type	Class and Description
`static class`	`VirtualHost.Protocol`

Constructor Summary

Constructors
Constructor and Description

VirtualHost()

Constructors
Constructor and Description
`VirtualHost()`

Method Summary

All Methods Instance Methods Concrete Methods
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.

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

- Constructor Detail
  - VirtualHost
```
public VirtualHost()
```
- Method Detail
  - getParent
```
public WebTier 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<WebTier>
    
    Returns:
    
    parent container
  - setParent
```
public VirtualHost setParent(WebTier containerWebTier)
```
    Description copied from interface: oracle.fmwplatform.envspec.common.ContainerAware
    
    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<WebTier>
    
    Parameters:
    
    containerWebTier - the parent container
    
    Returns:
    
    the current container-aware object
  - getId
```
public String getId()
```
    Returns the id used to reference this model object.
    
    Specified by:
    
    getId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Returns:
    
    the id used to reference this model object
  - setId
```
public VirtualHost setId(String id)
```
    Sets the id used to reference this VirtualHost object
    
    Specified by:
    
    setId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Parameters:
    
    id - id to set
    
    Returns:
    
    this VirtualHost object (for method chaining)
  - getName
```
public String getName()
```
    Returns the name of this VirtualHost Object
    
    Returns:
    
    name of the object
  - setName
```
public VirtualHost setName(String name)
```
    Sets the name of this VirtualHost object
    
    Parameters:
    
    name - name to set
    
    Returns:
    
    this VirtualHost object (for method chaining)
  - getServerAddress
```
public String getServerAddress()
```
    Returns the server address of this VirtualHost object
    
    Returns:
    
    serverAddress of the object
  - setServerAddress
```
public VirtualHost setServerAddress(String serverAddress)
```
    Sets the server address of this VirtualHost object
    
    Parameters:
    
    serverAddress - of the object
    
    Returns:
    
    this VirtualHost object (for method chaining)
  - getServerAdmin
```
public String getServerAdmin()
```
    Returns the server admin (email) address
    
    Returns:
    
    admin address
  - setServerAdmin
```
public VirtualHost setServerAdmin(String serverAdmin)
```
    Sets email address of server admin
    
    Parameters:
    
    serverAdmin - email address to set
    
    Returns:
    
    this VirtualHost object (for method chaining)
  - getLocations
```
public List<Location> getLocations()
```
    Returns a List of Locations mapped to this VirtualHost
    
    Returns:
    
    List of Locations
  - setLocations
```
public VirtualHost setLocations(List<Location> locations)
                         throws IllegalArgumentException
```
    Sets a List of Locations to this VirtualHost object
    
    Parameters:
    
    locations - list of locations
    
    Returns:
    
    this VirtualHost object (for method chaining)
    
    Throws:
    
    IllegalArgumentException
  - addLocation
```
public boolean addLocation(Location location)
                    throws IllegalArgumentException
```
    Add a Location to this VirtualHost object
    
    Parameters:
    
    location - of the object
    
    Returns:
    
    true if the list of locations changed as a result of this call
    
    Throws:
    
    IllegalArgumentException
  - addAllLocations
```
public boolean addAllLocations(List<Location> locations)
                        throws IllegalArgumentException
```
    Add a Location to this VirtualHost object
    
    Parameters:
    
    locations - a list of locations
    
    Returns:
    
    true if the list of locations changed as a result of this call
    
    Throws:
    
    IllegalArgumentException
  - getProtocol
```
public VirtualHost.Protocol getProtocol()
```
    Returns the protocol of this VirtualHost
    
    Returns:
    
    ServiceProtocol.HTTP or ServiceProtocol.HTTPS
  - setProtocol
```
public VirtualHost setProtocol(VirtualHost.Protocol protocol)
```
    Sets the protocol of this VirtualHost
    
    Parameters:
    
    protocol - of the object
    
    Returns:
    
    this VirtualHost object (for method chaining)
  - getEffectiveVariables
```
public Map<String,String> getEffectiveVariables()
                                         throws FMWEnvSpecException
```
    Returns the derived map of variables for this element.
    
    Specified by:
    
    getEffectiveVariables in interface oracle.fmwplatform.envspec.common.ParentContainerWithVariables
    
    Returns:
    
    a map of variables
    
    Throws:
    
    FMWEnvSpecException - if an error occurs
  - 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
  - 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 VirtualHost

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VirtualHost

Method Detail

getParent

setParent

getId

setId

getName

setName

getServerAddress

setServerAddress

getServerAdmin

setServerAdmin

getLocations

setLocations

addLocation

addAllLocations

getProtocol

setProtocol

getEffectiveVariables

getVariableValue

substitute

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString