public class Topology extends Object implements oracle.fmwplatform.envspec.common.Versioned, oracle.fmwplatform.envspec.common.ParentContainerWithVariables
Constructor and Description |
---|
Topology() |
Modifier and Type | Method and Description |
---|---|
boolean |
addAllDirectories(List<Directory> directories)
Adds a list of Directory objects to the list of Directories in this Topology
|
boolean |
addAllDomains(List<Domain> domains)
Adds the Domains provided to the list of Domains in this Topology.
|
boolean |
addAllNodeManagers(List<NodeManager> nodeManagers)
Adds the NodeManager provided to the list of NodeManagers in this Topology.
|
boolean |
addAllSystemComponents(List<SystemComponent> systemComponents)
Adds the list of SystemComponent provided to the list of SystemComponents
in this Topology.
|
boolean |
addAllWebTiers(List<WebTier> webTiers)
Adds a list of WebTier objects to the list of WebTiers in this Topology
|
boolean |
addDatabase(Database database)
Adds the Database provided to the list of Databases in this Topology.
|
boolean |
addDirectory(Directory directory)
Adds a Directory object to the list of Directories in this Topology
|
boolean |
addDomain(Domain domain)
Adds the Domain provided to the list of Domains in this Topology.
|
boolean |
addHost(Host host)
Adds the Host provided to the list of Hosts in this Topology.
|
boolean |
addNodeManager(NodeManager nodeManager)
Adds the NodeManager provided to the list of NodeManagers in this Topology.
|
boolean |
addOracleHome(OracleHome oracleHome)
Adds the OracleHome provided to the list of OracleHomes in this Topology.
|
boolean |
addService(Service service)
Adds the Service provided to the list of Services in this Topology.
|
Service |
addService(String serviceID)
Adds a new service with the provided ID to the list of Services in this Topology.
|
boolean |
addSystemComponent(SystemComponent systemComponent)
Adds the SystemComponent provided to the list of SystemComponent in this
Topology.
|
boolean |
addWebTier(WebTier webTier)
Adds a WebTier object to the list of WebTiers in this Topology
|
Database |
getDatabase(String databaseID)
Get a Database by id in this Topology.
|
List<Database> |
getDatabases()
Returns the list of Databases in this Topology or an empty list if none are present.
|
List<Directory> |
getDirectories()
Returns the list of Directory objects in this Topology or an empty list if none are present
|
List<Domain> |
getDomains()
Identify the WebLogic Domains in this Topology or an empty list if none are present.
|
Map<String,String> |
getEffectiveVariables()
Returns a map view of the Variables in the Topology.
|
String |
getFMWVersionRange()
Returns the range of FMW releases that this model object is supported under.
|
Host |
getHostByAddress(String address)
Returns the Host (physical, virtual, etc.) by its Address.
|
Host |
getHostById(String id)
Returns the Host (physical, virtual, etc.) by its ID
|
List<Host> |
getHosts()
Returns the Hosts (physical, virtual, etc.) that are part of this Topology.
|
Path |
getLocation()
Returns the location of this Topology on the filesystem.
|
Properties |
getMiscProperties()
Return misc properties.
|
String |
getMiscProperty(String key)
Return the value of a misc property for this topology
|
String |
getName()
Returns the name.
|
NodeManager |
getNodeManagerByName(String name)
Return the NodeManager that matches the given name
|
List<NodeManager> |
getNodeManagers()
Returns the list of NodeManagers in this Topology.
|
List<OracleHome> |
getOracleHomes()
Return the list of OracleHomes (binary directories) in this Topology.
|
String |
getSchemaVersion()
Returns the version of the EnvSpec (XML) schema that applies to this model.
|
Service |
getService(String serviceId)
Return the service in this topology identified by the provided service ID
|
List<Service> |
getServices()
Return the list of servies in this Topology.
|
SystemComponent |
getSystemComponentByName(String name)
Return the
SystemComponent that matches the given name. |
List<SystemComponent> |
getSystemComponents()
Returns the list of
SystemComponent in this Topology. |
List<Variable> |
getVariables()
Returns the variables that are used for substitution - note the variable dereference format is %x%.
|
String |
getVariableValue(String key)
Returns the variable value assigned to the specified key.
|
String |
getVersion()
Returns the consumer specified version of the this model file.
|
List<WebTier> |
getWebTiers()
Returns the list of WebTier objects in this Topology or an empty list if none are present
|
boolean |
removeNodeManager(NodeManager nodeManager)
Removes the first occurrence of the specified NodeManager from this Topology.
|
boolean |
removeService(Service service)
Remove the Service provided from the list of Services in this Topology.
|
boolean |
removeSystemComponent(SystemComponent systemComponent)
Removes the first occurrence of the specified SystemComponent from this
Topology and as well as any mappings present in
MappedDomain . |
Topology |
setDatabases(List<Database> databases)
Sets the list of Databases in this Topology.
|
Topology |
setDirectories(List<Directory> directories)
Sets the list of Directories in this Topology.
|
Topology |
setDomains(List<Domain> domains)
Sets the list of Domains in this Topology.
|
Topology |
setFMWVersionRange(String fmwVersionRange)
Sets the the range of FMW releases that this model object is supported under.
|
Topology |
setHosts(List<Host> hosts)
Set the hosts used by this Topology.
|
Topology |
setLocation(Path location)
Sets the location of the Topology file.
|
Topology |
setMiscProperties(Properties miscProperties)
Set the misc properties for this topology
|
Topology |
setMiscProperty(String key,
String value)
Set a property to the misc properties for this topology
|
Topology |
setName(String name)
Sets the name.
|
Topology |
setNodeManagers(List<NodeManager> nodeManagers)
Set the list of specified NodeManager objects
|
Topology |
setOracleHomes(List<OracleHome> oracleHomes)
Identify the Oracle Homes (binary directories) in this Topology.
|
Topology |
setSchemaVersion(String schemaVersion)
Sets the version of the EnvSpec (XML) schema that applies to this model.
|
Topology |
setServices(List<Service> services)
Set the services used by this Topology.
|
Topology |
setSystemComponents(List<SystemComponent> systemComponents)
Set the list of specified SystemComponet instances in the topology
|
Topology |
setVariables(List<Variable> variables)
Sets the Variables that are used for substitution - note the variable dereference format is %x%.
|
Topology |
setVersion(String version)
Sets the consumer specified version of the their model file.
|
Topology |
setWebTiers(List<WebTier> webTiers)
Sets the webTiers with the provided list
|
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.
|
boolean |
updateVariable(String name,
String value)
Update the value of the named variable.
|
public Properties getMiscProperties()
public Topology setMiscProperties(Properties miscProperties)
miscProperties
- misc properties objectpublic String getMiscProperty(String key)
key
- the key for the propertypublic Topology setMiscProperty(String key, String value)
key
- property keyvalue
- property valuepublic boolean addAllDirectories(List<Directory> directories) throws IllegalArgumentException
directories
- list of Directory objects to addtrue
if the list of Directory changed in this topology as a result of the callIllegalArgumentException
public boolean addDirectory(Directory directory) throws IllegalArgumentException
directory
- the Directory object to addtrue
if the list of webTiers changed as a result of this callIllegalArgumentException
public boolean addAllWebTiers(List<WebTier> webTiers) throws IllegalArgumentException
webTiers
- list of WebTier objects to addtrue
if the list of WebTiers changed in this topology as a result of the callIllegalArgumentException
- if the webTiers argument is nullpublic boolean addWebTier(WebTier webTier) throws IllegalArgumentException
webTier
- the WebTier object to addtrue
if the list of webTiers changed as a result of this callIllegalArgumentException
- if the webTier argument is nullpublic boolean addAllDomains(List<Domain> domains) throws IllegalArgumentException
domains
- the Domains to be added to the list of DomainsIllegalArgumentException
- if the domains argument is nullpublic boolean addAllNodeManagers(List<NodeManager> nodeManagers) throws IllegalArgumentException
nodeManagers
- the NodeManager to be added to the list of NodeManagersIllegalArgumentException
- if the nodeManagers argument is nullpublic NodeManager getNodeManagerByName(String name)
name
- of the node managerpublic boolean removeNodeManager(NodeManager nodeManager)
nodeManager
- the NodeManager to be removed, if presentpublic boolean addDatabase(Database database) throws IllegalArgumentException
database
- the Database to be added to the list of DatabasesIllegalArgumentException
public boolean addDomain(Domain domain) throws IllegalArgumentException
domain
- the Domain to be added to the list of DomainsIllegalArgumentException
public boolean addNodeManager(NodeManager nodeManager) throws IllegalArgumentException
nodeManager
- the NodeManager to be added to the list of NodeManagersIllegalArgumentException
public boolean addOracleHome(OracleHome oracleHome) throws IllegalArgumentException
oracleHome
- The OracleHome to be added to the list of OracleHomesIllegalArgumentException
public boolean addHost(Host host) throws IllegalArgumentException
host
- The Host to be added to the list of HostsIllegalArgumentException
public List<Service> getServices()
public Topology setServices(List<Service> services)
services
- the list of services in this Topology or null to clear the current list.public Service addService(String serviceID)
serviceID
- the ID of the new service to be added to the list of servicespublic boolean addService(Service service)
service
- The service to be added to the list of servicespublic boolean removeService(Service service)
service
- The service to be removed to the list of servicespublic Service getService(String serviceId)
serviceId
- id of the service in the topologypublic List<WebTier> getWebTiers()
public List<Directory> getDirectories()
public List<Database> getDatabases()
public Database getDatabase(String databaseID)
databaseID
- the name of the blueprint to findpublic List<Domain> getDomains()
public Map<String,String> getEffectiveVariables()
getEffectiveVariables
in interface oracle.fmwplatform.envspec.common.ParentContainerWithVariables
public 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 List<Host> getHosts()
public Host getHostById(String id)
id
- the ID of the requested Hostpublic Host getHostByAddress(String address)
address
- the address of the requested Host.public Path getLocation()
public String getName()
oracle.fmwplatform.envspec.common.Versioned
getName
in interface oracle.fmwplatform.envspec.common.Versioned
public List<NodeManager> getNodeManagers()
public List<OracleHome> getOracleHomes()
public String getSchemaVersion()
oracle.fmwplatform.envspec.common.Versioned
getSchemaVersion
in interface oracle.fmwplatform.envspec.common.Versioned
public List<Variable> getVariables()
public boolean updateVariable(String name, String value)
name
- name of variable to updatevalue
- new value for the variablepublic String getVersion()
oracle.fmwplatform.envspec.common.Versioned
getVersion
in interface oracle.fmwplatform.envspec.common.Versioned
public String getFMWVersionRange()
oracle.fmwplatform.envspec.common.Versioned
getFMWVersionRange
in interface oracle.fmwplatform.envspec.common.Versioned
public Topology setFMWVersionRange(String fmwVersionRange)
oracle.fmwplatform.envspec.common.Versioned
setFMWVersionRange
in interface oracle.fmwplatform.envspec.common.Versioned
fmwVersionRange
- the range of FMW releases that this model object is supported underpublic Topology setDatabases(List<Database> databases)
databases
- the list of Databases in this Topologypublic Topology setDirectories(List<Directory> directories)
directories
- the list of Databases in this Topologypublic Topology setDomains(List<Domain> domains)
domains
- the list of Databases in this Topologypublic Topology setHosts(List<Host> hosts)
hosts
- the list of hosts in this Topology.public Topology setLocation(Path location)
location
- The location of the Topology filepublic Topology setName(String name)
setName
in interface oracle.fmwplatform.envspec.common.Versioned
name
- the name of this Topologypublic Topology setNodeManagers(List<NodeManager> nodeManagers)
nodeManagers
- the list of Oracle Homes (binary directories) in this Topology.public Topology setOracleHomes(List<OracleHome> oracleHomes)
oracleHomes
- the list of Oracle Homes (binary directories) in this Topology.public Topology setSchemaVersion(String schemaVersion)
oracle.fmwplatform.envspec.common.Versioned
setSchemaVersion
in interface oracle.fmwplatform.envspec.common.Versioned
schemaVersion
- the version of the EnvSpec (XML) schema that applies to this modelpublic Topology setVariables(List<Variable> variables)
variables
- The list of the Variables in this Topology.public Topology setVersion(String version)
oracle.fmwplatform.envspec.common.Versioned
setVersion
in interface oracle.fmwplatform.envspec.common.Versioned
version
- the consumer specified version of the their model file.public Topology setWebTiers(List<WebTier> webTiers)
webTiers
- The list of the Variables in this Topology.public List<SystemComponent> getSystemComponents()
SystemComponent
in this Topology.public boolean removeSystemComponent(SystemComponent systemComponent)
MappedDomain
.systemComponent
- the SystemComponent to be removed, if presentpublic boolean addAllSystemComponents(List<SystemComponent> systemComponents)
systemComponents
- the SystemComponents to be added to the list of
SystemComponentspublic SystemComponent getSystemComponentByName(String name)
SystemComponent
that matches the given name.name
- of the SystemComponentpublic boolean addSystemComponent(SystemComponent systemComponent)
systemComponent
- the SystemComponent
instance to be added to the list
of SystemComponenytspublic Topology setSystemComponents(List<SystemComponent> systemComponents)
systemComponents
- the list of SystemComponents to be set in this Topology.public String toXmlCompactString()
public String toXmlString()
public String toJsonCompactString()
public String toJsonString()
public String toCompactString()