oracle.fmwplatform.envspec.model.topology

Class MappedDomain

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.

Method Summary

Modifier and Type	Method and Description
boolean	addAllServerRefs(List<String> serverRefs) Add the specified Server id to the list of serverRefs that this MappedDomain is mapped to.
boolean	addServerRef(String serverRef) Add the specified Server id to the list of serverRefs that this MappedDomain is mapped to.
Domain	getDomain() Returns the domain that this MappedDomain is based on.
String	getId() Returns the id that is used to reference this MappedDomain.
NodeManager	getNodeManager() Returns the NodeManager that this MappedDomain is mapped to or null if no NodeManager has been mapped.
List<String>	getServerRefs() Returns the list of Servers id that this MappedDomain refers to or an empty list if no Servers are mapped.
MappedDomain	setDomain(Domain domain) Sets the Domain that this MappedDomain is based on.
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.
MappedDomain	setServerRefs(List<String> serverRefs) Sets the Server ids of the Servers that are to mapped by this MappedDomain.
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

MappedDomain

public MappedDomain()

Creates an instance of MappedDomain.

MappedDomain

public MappedDomain(Domain domain)
             throws IllegalArgumentException

Creates an instance of MappedDomain based on the Domain specified.

Parameters:

domain - the Domain that is to be mapped

Throws:

IllegalArgumentException

Method Detail

getDomain

public Domain getDomain()

Returns the domain that this MappedDomain is based on.

Returns:

domain the Domain that this MappedDomain is based on

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

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

addServerRef

public boolean addServerRef(String serverRef)
                     throws IllegalArgumentException

Add the specified Server id to the list of serverRefs that this MappedDomain is mapped to.

Parameters:

serverRef - The Server id to be added to the list of serverRefs

Returns:

true if the list has changed as a result of this call

Throws:

IllegalArgumentException

addAllServerRefs

public boolean addAllServerRefs(List<String> serverRefs)
                         throws IllegalArgumentException

Add the specified Server id to the list of serverRefs that this MappedDomain is mapped to.

Parameters:

serverRefs - The Server id to be added to the list of serverRefs

Returns:

true if the list has changed as a result of this call

Throws:

IllegalArgumentException

getServerRefs

public List<String> getServerRefs()

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

setDomain

public MappedDomain setDomain(Domain domain)

Sets the Domain that this MappedDomain is based on.

Parameters:

domain - the Domain that this MappedDomain is to be based on

Returns:

this MappedDomain object (for method chaining)

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 MappedDomain object (for method chaining)

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:

this MappedDomain object (for method chaining)

setServerRefs

public MappedDomain setServerRefs(List<String> serverRefs)

Sets the Server ids of the Servers that are to mapped by this MappedDomain.

Parameters:

serverRefs - the Server ids of the Servers that are to mapped by this MappedDomain

Returns:

this MappedDomain object (for method chaining)

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