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

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

All Implemented Interfaces:: oracle.fmwplatform.envspec.common.ContainerAware<VirtualHost>, oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.Substitutable

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Location.Handler

static class Location.WLProxySSL

static class Location.WLProxySSLPassThrough

Nested Classes
Modifier and Type	Class and Description
`static class`	`Location.Handler`
`static class`	`Location.WLProxySSL`
`static class`	`Location.WLProxySSLPassThrough`

Constructor Summary

Constructors
Constructor and Description

Location()

Constructors
Constructor and Description
`Location()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Location.Handler`	`getHandler()` Returns the handler
`String`	`getId()` Returns the id of this Location object
`VirtualHost`	`getParent()` Returns the object that contains this entity
`String`	`getUrlPattern()` Returns the urlPattern to match this Location
`String`	`getVariableValue(String key)` Returns the variable value assigned to the specified key.
`String`	`getWebLogicCluster()` Returns the cluster name
`String`	`getWebLogicHost()` Returns the webLogicHost mapped to this Location
`String`	`getWebLogicPort()` Returns the port number
`Location.WLProxySSL`	`getWlProxySSL()` Returns whether the proxy uses SSL
`Location.WLProxySSLPassThrough`	`getWlProxySSLPassThrough()` Returns whether SSL passthrough is enabled
`Location`	`setHandler(Location.Handler handler)` Sets the handler
`Location`	`setId(String id)` Set the id of this Location object
`Location`	`setParent(VirtualHost containerVirtualHost)` Sets the container object that contains this.
`Location`	`setUrlPattern(String urlPattern)` Sets the urlPattern to match this Location
`Location`	`setWebLogicCluster(String webLogicCluster)` Sets the cluster name
`Location`	`setWebLogicHost(String webLogicHost)` Sets the webLogicHost to this Location
`Location`	`setWebLogicPort(String webLogicPort)` Sets the port number
`Location`	`setWlProxySSL(Location.WLProxySSL wlProxySSL)` Sets whether proxy uses SSL
`Location`	`setWlProxySSLPassThrough(Location.WLProxySSLPassThrough wlProxySSLPassThrough)` Set SSL passthrough
`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
  - Location
```
public Location()
```
- Method Detail
  - getParent
```
public VirtualHost 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<VirtualHost>
    
    Returns:
    
    parent container
  - setParent
```
public Location setParent(VirtualHost containerVirtualHost)
```
    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<VirtualHost>
    
    Parameters:
    
    containerVirtualHost - the parent container
    
    Returns:
    
    the current container-aware object
  - getId
```
public String getId()
```
    Returns the id of this Location object
    
    Specified by:
    
    getId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Returns:
    
    id of the object
  - setId
```
public Location setId(String id)
```
    Set the id of this Location object
    
    Specified by:
    
    setId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Parameters:
    
    id - of the object
    
    Returns:
    
    this Location object (for method chaining)
  - getUrlPattern
```
public String getUrlPattern()
```
    Returns the urlPattern to match this Location
    
    Returns:
    
    the urlPattern. ex: "/myapplication"
  - setUrlPattern
```
public Location setUrlPattern(String urlPattern)
```
    Sets the urlPattern to match this Location
    
    Parameters:
    
    urlPattern - pattern to set
    
    Returns:
    
    this Location object (for method chaining)
  - getWebLogicHost
```
public String getWebLogicHost()
```
    Returns the webLogicHost mapped to this Location
    
    Returns:
    
    webLogicHost mapped to the location
  - setWebLogicHost
```
public Location setWebLogicHost(String webLogicHost)
```
    Sets the webLogicHost to this Location
    
    Parameters:
    
    webLogicHost - of this location
    
    Returns:
    
    this Location object (for method chaining)
  - getWebLogicPort
```
public String getWebLogicPort()
```
    Returns the port number
    
    Returns:
    
    port number of this location
  - setWebLogicPort
```
public Location setWebLogicPort(String webLogicPort)
```
    Sets the port number
    
    Parameters:
    
    webLogicPort - of this object
    
    Returns:
    
    this Location object (for method chaining)
  - getWebLogicCluster
```
public String getWebLogicCluster()
```
    Returns the cluster name
    
    Returns:
    
    the cluster name
  - setWebLogicCluster
```
public Location setWebLogicCluster(String webLogicCluster)
```
    Sets the cluster name
    
    Parameters:
    
    webLogicCluster - of the location
    
    Returns:
    
    this Location object (for method chaining)
  - getHandler
```
public Location.Handler getHandler()
```
    Returns the handler
    
    Returns:
    
    handler of the location
  - setHandler
```
public Location setHandler(Location.Handler handler)
```
    Sets the handler
    
    Parameters:
    
    handler - of this object
    
    Returns:
    
    this Location object (for method chaining)
  - getWlProxySSL
```
public Location.WLProxySSL getWlProxySSL()
```
    Returns whether the proxy uses SSL
    
    Returns:
    
    true if the proxy uses SSL
  - setWlProxySSL
```
public Location setWlProxySSL(Location.WLProxySSL wlProxySSL)
```
    Sets whether proxy uses SSL
    
    Parameters:
    
    wlProxySSL - for ssl
    
    Returns:
    
    location that contains this ssl proxy
  - getWlProxySSLPassThrough
```
public Location.WLProxySSLPassThrough getWlProxySSLPassThrough()
```
    Returns whether SSL passthrough is enabled
    
    Returns:
    
    proxy of ssl passthrough
  - setWlProxySSLPassThrough
```
public Location setWlProxySSLPassThrough(Location.WLProxySSLPassThrough wlProxySSLPassThrough)
```
    Set SSL passthrough
    
    Parameters:
    
    wlProxySSLPassThrough - proxy of ssl pass through
    
    Returns:
    
    this Location object (
  - 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 Location

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Location

Method Detail

getParent

setParent

getId

setId

getUrlPattern

setUrlPattern

getWebLogicHost

setWebLogicHost

getWebLogicPort

setWebLogicPort

getWebLogicCluster

setWebLogicCluster

getHandler

setHandler

getWlProxySSL

setWlProxySSL

getWlProxySSLPassThrough

setWlProxySSLPassThrough

getVariableValue

substitute

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString