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

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

All Implemented Interfaces:

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WebTier.Type

Nested Classes
Modifier and Type	Class and Description
`static class`	`WebTier.Type`

Constructor Summary

Constructors
Constructor and Description

WebTier()

Constructors
Constructor and Description
`WebTier()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addAllVirtualHosts(List<VirtualHost> virtualHosts)` Add a VirtualHost object to the list of VirtualHosts part of this WebTier object
`boolean`	`addVirtualHost(VirtualHost virtualHost)` Add a VirtualHost object to the list of VirtualHosts part of this WebTier object
`String`	`getAddress()` Returns the address of this WebTier object
`String`	`getAdminCredentialRef()` Returns the credential reference mapped to this WebTier object
`Map<String,String>`	`getEffectiveVariables()` Returns the derived map of variables for this element.
`String`	`getId()` Returns the id used to reference this WebTier.
`String`	`getName()` Returns the name of this WebTier object
`Topology`	`getParent()` Returns the object that contains this entity
`WebTier.Type`	`getType()` Returns the type of this WebTier object
`String`	`getVariableValue(String key)` Returns the variable value assigned to the specified key.
`List<VirtualHost>`	`getVirtualHosts()` Returns the list of VirtualHosts part of this WebTier object
`WebTier`	`setAddress(String address)` Set the address of this WebTier object
`WebTier`	`setAdminCredentialRef(String adminCredentialRef)` Set the admin credential reference for this WebTier object
`WebTier`	`setId(String id)` Sets the id that is used when referencing this WebTier.
`WebTier`	`setName(String name)` Sets the name of this WebTier object
`WebTier`	`setParent(Topology containerTopology)` Sets the container object that contains this.
`WebTier`	`setType(WebTier.Type type)` Set the type of the WebTier.
`WebTier`	`setVirtualHosts(List<VirtualHost> virtualHosts)` Set a list of VirtualHosts
`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
  - WebTier
```
public WebTier()
```
- Method Detail
  - getParent
```
public Topology 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<Topology>
    
    Returns:
    
    parent container
  - setParent
```
public WebTier setParent(Topology containerTopology)
```
    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<Topology>
    
    Parameters:
    
    containerTopology - the parent container
    
    Returns:
    
    the current container-aware object
  - getAdminCredentialRef
```
public String getAdminCredentialRef()
```
    Returns the credential reference mapped to this WebTier object
    
    Returns:
    
    alias of the credential
  - setAdminCredentialRef
```
public WebTier setAdminCredentialRef(String adminCredentialRef)
```
    Set the admin credential reference for this WebTier object
    
    Parameters:
    
    adminCredentialRef - of this object
    
    Returns:
    
    this WebTier object (for method chaining)
  - getVirtualHosts
```
public List<VirtualHost> getVirtualHosts()
```
    Returns the list of VirtualHosts part of this WebTier object
    
    Returns:
    
    list of VirtualHost objects
  - setVirtualHosts
```
public WebTier setVirtualHosts(List<VirtualHost> virtualHosts)
```
    Set a list of VirtualHosts
    
    Parameters:
    
    virtualHosts - list of VirtualHost objects
    
    Returns:
    
    this WebTier object (for method chaining)
  - addVirtualHost
```
public boolean addVirtualHost(VirtualHost virtualHost)
                       throws IllegalArgumentException
```
    Add a VirtualHost object to the list of VirtualHosts part of this WebTier object
    
    Parameters:
    
    virtualHost - VirtualHost object to add
    
    Returns:
    
    true if the list of virtualHosts changed as a result of this call
    
    Throws:
    
    IllegalArgumentException
  - addAllVirtualHosts
```
public boolean addAllVirtualHosts(List<VirtualHost> virtualHosts)
                           throws IllegalArgumentException
```
    Add a VirtualHost object to the list of VirtualHosts part of this WebTier object
    
    Parameters:
    
    virtualHosts - VirtualHost object to add
    
    Returns:
    
    true if the list of virtualHosts changed as a result of this call
    
    Throws:
    
    IllegalArgumentException
  - getType
```
public WebTier.Type getType()
```
    Returns the type of this WebTier object
    
    Returns:
    
    type of webtier
  - setType
```
public WebTier setType(WebTier.Type type)
```
    Set the type of the WebTier. OHS or OTD
    
    Parameters:
    
    type - of webtier
    
    Returns:
    
    this WebTier object (for method chaining)
  - getAddress
```
public String getAddress()
```
    Returns the address of this WebTier object
    
    Returns:
    
    address of object
  - setAddress
```
public WebTier setAddress(String address)
```
    Set the address of this WebTier object
    
    Parameters:
    
    address - string to set
    
    Returns:
    
    this WebTier object (for method chaining)
  - getName
```
public String getName()
```
    Returns the name of this WebTier object
    
    Returns:
    
    name of webtier object
  - setName
```
public WebTier setName(String name)
```
    Sets the name of this WebTier object
    
    Parameters:
    
    name - name to set to this WebTier object
    
    Returns:
    
    this WebTier object (for method chaining)
  - getId
```
public String getId()
```
    Returns the id used to reference this WebTier.
    
    Specified by:
    
    getId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Returns:
    
    the id used to reference this WebTier.
  - setId
```
public WebTier setId(String id)
```
    Sets the id that is used when referencing this WebTier.
    
    Specified by:
    
    setId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Parameters:
    
    id - the id that is used when referencing this WebTier
    
    Returns:
    
    this WebTier 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 WebTier

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebTier

Method Detail

getParent

setParent

getAdminCredentialRef

setAdminCredentialRef

getVirtualHosts

setVirtualHosts

addVirtualHost

addAllVirtualHosts

getType

setType

getAddress

setAddress

getName

setName

getId

setId

getEffectiveVariables

getVariableValue

substitute

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString