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

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

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.EntityWithId
```
public class MappedDomain
extends Object
implements oracle.fmwplatform.envspec.common.EntityWithId
```
MappedDomain represents the relationship between a Domain and its Servers and NodeManager.

Since:

12.2.1

Constructor Summary

Constructors
Constructor and Description

MappedDomain()
Creates an instance of MappedDomain.

MappedDomain(Domain domain)
Creates an instance of MappedDomain based on the Domain specified.

Constructors
Constructor and Description
`MappedDomain()` Creates an instance of MappedDomain.
`MappedDomain(Domain domain)` Creates an instance of MappedDomain based on the Domain specified.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addAllMappedServers(List<MappedServer> servers)`
`boolean`	`addAllMappedSystemComponents(List<MappedSystemComponent> mappedSystemComponents)` Add the specified list of SystemComponent mappings to the list of systemComponentRefs that this MappedDomain is mapped to.
`boolean`	`addAllSystemComponents(List<SystemComponent> systemComponents)` Maps the input list of SystemComponents to the domain.
`boolean`	`addMappedServer(MappedServer server)` Add the specified Server id to the list of serverRefs that this MappedDomain is mapped to.
`boolean`	`addMappedServer(ServerBinding serverBinding)` adds a mapped server to this mapped domain for the specified server binding
`boolean`	`addMappedServers(List<ServerBinding> serverBindings)` adds a mapped server to this mapped domain for each server binding in the specified list
`boolean`	`addMappedSystemComponent(MappedSystemComponent mappedSystemComponent)` Add the specified SystemComponent mapping to the list of systemComponentRefs that this MappedDomain is mapped to.
`boolean`	`addSystemComponent(SystemComponent systemComponent)` Maps the input SystemComponent to the domain.
`Domain`	`getDomain()` Returns the domain mapped to this host.
`String`	`getId()` Returns the id that is used to reference this MappedDomain.
`MappedServer`	`getMappedServer(String id)` Get the MappedServer corresponding to ID, or null if not found.
`MappedServer`	`getMappedServerByServerID(String serverId)` Get the MappedServer corresponding to the underlying server ID, or null if not found.
`List<MappedServer>`	`getMappedServers()` Returns the list of Servers id that this MappedDomain refers to or an empty list if no Servers are mapped.
`MappedSystemComponent`	`getMappedSystemComponentById(String mappedSystemComponentId)` Get the MappedSystemComponent corresponding to ID, or null if not found.
`MappedSystemComponent`	`getMappedSystemComponentBySystemComponentId(String systemComponentId)` Identifies a SystemComponent mapping corresponding to the input Id of a `SystemComponent` instance.
`List<MappedSystemComponent>`	`getMappedSystemComponents()` Returns the list of SystemComponents mappings that this MappedDomain refers to or an empty list if no SystemComponents are mapped.
`NodeManager`	`getNodeManager()` Returns the NodeManager that this MappedDomain is mapped to or null if no NodeManager has been mapped.
`boolean`	`removeMappedServer(MappedServer mappedServer)` Remove a mapped server from this mapped domain.
`boolean`	`removeMappedServer(String id)` Remove a mapped server from this mapped domain.
`MappedDomain`	`removeMappedServers()` Remove all mapped servers from this mapped domain.
`boolean`	`removeMappedSystemComponent(MappedSystemComponent mappedSystemComponent)` Remove a SystemComponent mapping from this mapped domain.
`boolean`	`removeMappedSystemComponentById(String mappedSystemComponentId)` Remove a SystemComponent mapping identified by input id from this mapped domain.
`boolean`	`removeMappedSystemComponentBySystemComponentId(String systemComponentId)` Remove a SystemComponent mapping identified by input id of SystemComponent represented by the mapping from this mapped domain.
`MappedDomain`	`removeMappedSystemComponents()` Remove all mapped SystemComponents from this mapped domain.
`MappedDomain`	`setDomain(Domain domain)` Set the domain.
`MappedDomain`	`setId(String id)` Sets the id that is used to reference this MappedDomain.
`MappedDomain`	`setNodeManager(NodeManager nodeManager)` Sets the NodeManager that is to be mapped by this MappedDomain or null.
`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
  - MappedDomain
```
public MappedDomain()
```
    Creates an instance of MappedDomain.
  - MappedDomain
```
public MappedDomain(Domain domain)
```
    Creates an instance of MappedDomain based on the Domain specified.
    
    Parameters:
    
    domain - the Domain that is to be mapped
- Method Detail
  - getDomain
```
public Domain getDomain()
```
    Returns the domain mapped to this host.
    
    Returns:
    
    the domain referenced by this mapping
  - setDomain
```
public MappedDomain setDomain(Domain domain)
```
    Set the domain.
    
    Parameters:
    
    domain - the domain
    
    Returns:
    
    the MNappedDomain object
  - getId
```
public String getId()
```
    Returns the id that is used to reference this MappedDomain.
    
    Specified by:
    
    getId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Returns:
    
    the id that is used to reference this MappedDomain
  - setId
```
public MappedDomain setId(String id)
```
    Sets the id that is used to reference this MappedDomain.
    
    Specified by:
    
    setId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Parameters:
    
    id - the id that is used to reference this MappedDomain
    
    Returns:
    
    this mapped domain
  - getNodeManager
```
public NodeManager getNodeManager()
```
    Returns the NodeManager that this MappedDomain is mapped to or null if no NodeManager has been mapped.
    
    Returns:
    
    the NodeManager that this MappedDomain is mapped to or null if no NodeManager has been mapped
  - addMappedServer
```
public boolean addMappedServer(MappedServer server)
                        throws IllegalArgumentException
```
    Add the specified Server id to the list of serverRefs that this MappedDomain is mapped to.
    
    Parameters:
    
    server - The Server id to be added to the list of serverRefs
    
    Returns:
    
    true if the server was found and removed from this mapped domain
    
    Throws:
    
    IllegalArgumentException
  - addAllMappedServers
```
public boolean addAllMappedServers(List<MappedServer> servers)
                            throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException
  - addMappedServers
```
public boolean addMappedServers(List<ServerBinding> serverBindings)
```
    adds a mapped server to this mapped domain for each server binding in the specified list
    
    Parameters:
    
    serverBindings - - List of ServerBindings of a domain.
    
    Returns:
    
    true if the bindings were successfully added
  - addMappedServer
```
public boolean addMappedServer(ServerBinding serverBinding)
```
    adds a mapped server to this mapped domain for the specified server binding
    
    Parameters:
    
    serverBinding - the server binding to be added
    
    Returns:
    
    true if the server binding was successfully added
  - getMappedServers
```
public List<MappedServer> getMappedServers()
```
    Returns the list of Servers id that this MappedDomain refers to or an empty list if no Servers are mapped.
    
    Returns:
    
    the list of Servers id that this MappedDomain refers to or an empty list if no Servers are mapped
  - removeMappedServer
```
public boolean removeMappedServer(MappedServer mappedServer)
```
    Remove a mapped server from this mapped domain. The underlying referenced server binding is unaffected.
    
    Parameters:
    
    mappedServer - the MappedServer object to be removed from this MappedDomain
    
    Returns:
    
    true if the mapped server was found and removed
  - removeMappedServer
```
public boolean removeMappedServer(String id)
```
    Remove a mapped server from this mapped domain. The underlying referenced server binding is unaffected.
    
    Parameters:
    
    id - the ID of the mapped server in this mapped domain
    
    Returns:
    
    true if the mapped server was found and removed
  - removeMappedServers
```
public MappedDomain removeMappedServers()
```
    Remove all mapped servers from this mapped domain. The underlying referenced server binding is unaffected.
    
    Returns:
    
    this MappedDomain
  - getMappedServerByServerID
```
public MappedServer getMappedServerByServerID(String serverId)
```
    Get the MappedServer corresponding to the underlying server ID, or null if not found. Searches the MappedServers in this MappedDomain looking for a MappedServer that references a ServerBinding that references the serverId parameter.
    
    Parameters:
    
    serverId - the ID of the server from a domain profile
    
    Returns:
    
    the MappedServer referenced by this MappedDomain matching the parameters provided, or null if not found
  - getMappedServer
```
public MappedServer getMappedServer(String id)
```
    Get the MappedServer corresponding to ID, or null if not found.
    
    Parameters:
    
    id - the ID of the mapped server in this mapped domain
    
    Returns:
    
    the MappedServer from this mapped domain matching the id, or null if not found
  - setNodeManager
```
public MappedDomain setNodeManager(NodeManager nodeManager)
```
    Sets the NodeManager that is to be mapped by this MappedDomain or null.
    
    Parameters:
    
    nodeManager - the NodeManager that is to be mapped by this MappedDomain or null
    
    Returns:
    
    the current MappedDomain object
  - addMappedSystemComponent
```
public boolean addMappedSystemComponent(MappedSystemComponent mappedSystemComponent)
```
    Add the specified SystemComponent mapping to the list of systemComponentRefs that this MappedDomain is mapped to.
    
    Parameters:
    
    mappedSystemComponent - The SystemComponent mapping to be added to the list of systemComponentRefs
    
    Returns:
    
    true if the systemComponent mapping was added to this mapped domain
  - addAllMappedSystemComponents
```
public boolean addAllMappedSystemComponents(List<MappedSystemComponent> mappedSystemComponents)
```
    Add the specified list of SystemComponent mappings to the list of systemComponentRefs that this MappedDomain is mapped to.
    
    Parameters:
    
    mappedSystemComponents - The SystemComponent mappings to be added to the list of systemComponentRefs
    
    Returns:
    
    true if all the systemComponent mappings were added to this mapped domain
  - addAllSystemComponents
```
public boolean addAllSystemComponents(List<SystemComponent> systemComponents)
```
    Maps the input list of SystemComponents to the domain.
    
    Parameters:
    
    systemComponents - - list of SystemComponents to be mapped
    
    Returns:
    
    - true if all the input SystemComponents were mapped
  - addSystemComponent
```
public boolean addSystemComponent(SystemComponent systemComponent)
```
    Maps the input SystemComponent to the domain.
    
    Parameters:
    
    systemComponent - - SystemComponent instance to be mapped
    
    Returns:
    
    true if SystemComponent was mapped to the domain
  - getMappedSystemComponents
```
public List<MappedSystemComponent> getMappedSystemComponents()
```
    Returns the list of SystemComponents mappings that this MappedDomain refers to or an empty list if no SystemComponents are mapped.
    
    Returns:
    
    the SystemComponents mappings
  - removeMappedSystemComponent
```
public boolean removeMappedSystemComponent(MappedSystemComponent mappedSystemComponent)
```
    Remove a SystemComponent mapping from this mapped domain.
    
    Parameters:
    
    mappedSystemComponent - the MappedSystemComponent object to be removed from this MappedDomain
    
    Returns:
    
    true if the mapped server was found and removed
  - removeMappedSystemComponentById
```
public boolean removeMappedSystemComponentById(String mappedSystemComponentId)
```
    Remove a SystemComponent mapping identified by input id from this mapped domain.
    
    Parameters:
    
    mappedSystemComponentId - the ID of the mapped SystemComponent in this mapped domain
    
    Returns:
    
    true if the SystemComponent mapping was found and removed
  - removeMappedSystemComponentBySystemComponentId
```
public boolean removeMappedSystemComponentBySystemComponentId(String systemComponentId)
```
    Remove a SystemComponent mapping identified by input id of SystemComponent represented by the mapping from this mapped domain.
    
    Parameters:
    
    systemComponentId - the ID of the SystemComponent for which mapping is to be removed in this mapped domain
    
    Returns:
    
    true if the SystemComponent mapping was found and removed
  - removeMappedSystemComponents
```
public MappedDomain removeMappedSystemComponents()
```
    Remove all mapped SystemComponents from this mapped domain.
    
    Returns:
    
    this MappedDomain
  - getMappedSystemComponentBySystemComponentId
```
public MappedSystemComponent getMappedSystemComponentBySystemComponentId(String systemComponentId)
```
    Identifies a SystemComponent mapping corresponding to the input Id of a SystemComponent instance.
    
    Parameters:
    
    systemComponentId - - Id of a SystemComponent instance for which mapping is to be identified
    
    Returns:
    
    If mapping is found - MappedSystemComponent instance corresponding to the input id, null otherwise
  - getMappedSystemComponentById
```
public MappedSystemComponent getMappedSystemComponentById(String mappedSystemComponentId)
```
    Get the MappedSystemComponent corresponding to ID, or null if not found.
    
    Parameters:
    
    mappedSystemComponentId - the ID of the mapped SystemComponent in this mapped domain
    
    Returns:
    
    the MappedSystemComponent from this mapped domain matching the id, or null if not found
  - 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 MappedDomain

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MappedDomain

MappedDomain

Method Detail

getDomain

setDomain

getId

setId

getNodeManager

addMappedServer

addAllMappedServers

addMappedServers

addMappedServer

getMappedServers

removeMappedServer

removeMappedServer

removeMappedServers

getMappedServerByServerID

getMappedServer

setNodeManager

addMappedSystemComponent

addAllMappedSystemComponents

addAllSystemComponents

addSystemComponent

getMappedSystemComponents

removeMappedSystemComponent

removeMappedSystemComponentById

removeMappedSystemComponentBySystemComponentId

removeMappedSystemComponents

getMappedSystemComponentBySystemComponentId

getMappedSystemComponentById

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString