oracle.fmwplatform.envspec.model.topology

Class Location

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

Defines the location of a virtual host.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Location.Handler Type of virtual host handler.
static class	Location.WLProxySSL Store the state of a WLS SSL proxy.
static class	Location.WLProxySSLPassThrough Store the state of a WLS SSL proxy pass throught.

Constructor Summary

Constructors

Constructor and Description
Location()

Method Summary

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 parent of this object.
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 JSON format.
String	toString() Returns a string representation of the object in JSON 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:

the object that contains this entity

setParent

public Location setParent(VirtualHost containerVirtualHost)

Description copied from interface: oracle.fmwplatform.envspec.common.ContainerAware

Sets the parent of this object. The container object has variables in it that are used by child objects.

Specified by:

setParent in interface oracle.fmwplatform.envspec.common.ContainerAware<VirtualHost>

Parameters:

containerVirtualHost - the parent container

Returns:

the ContainerAware parent object

getId

public String getId()

Returns the id of this Location object

Specified by:

getId in interface oracle.fmwplatform.envspec.common.EntityWithId

Returns:

id

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 - the id of this location

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

setWebLogicHost

public Location setWebLogicHost(String webLogicHost)

Sets the webLogicHost to this Location

Parameters:

webLogicHost - value to set for the webLogicHost

Returns:

this Location object (for method chaining)

getWebLogicPort

public String getWebLogicPort()

Returns the port number

Returns:

port number

setWebLogicPort

public Location setWebLogicPort(String webLogicPort)

Sets the port number

Parameters:

webLogicPort - value for the webLogicPort

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 - value for the webLogicCluster

Returns:

this Location object (for method chaining)

getHandler

public Location.Handler getHandler()

Returns the handler

Returns:

a Handler object for this location

setHandler

public Location setHandler(Location.Handler handler)

Sets the handler

Parameters:

handler - a Handler object for this location

Returns:

this Location object (for method chaining)

getWlProxySSL

public Location.WLProxySSL getWlProxySSL()

Returns whether the proxy uses SSL

Returns:

enum WLProxySSL value

setWlProxySSL

public Location setWlProxySSL(Location.WLProxySSL wlProxySSL)

Sets whether proxy uses SSL

Parameters:

wlProxySSL - enum WLProxySSL value

Returns:

this Location object (for method chaining)

getWlProxySSLPassThrough

public Location.WLProxySSLPassThrough getWlProxySSLPassThrough()

Returns whether SSL passthrough is enabled

Returns:

enum for WLProxySSLPassThrough

setWlProxySSLPassThrough

public Location setWlProxySSLPassThrough(Location.WLProxySSLPassThrough wlProxySSLPassThrough)

Set SSL passthrough

Parameters:

wlProxySSLPassThrough - enum for WLProxySSLPassThrough

Returns:

this Location object (for method chaining)

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

toCompactString

public String toCompactString()

Returns a compact string representation of the object in JSON format.

Returns:

a compact string representation of the object in JSON format

toString

public String toString()

Returns a string representation of the object in JSON format.

Overrides:

toString in class Object

Returns:

a string representation of the object in JSON format