oracle.fmwplatform.envspec.model.topology

Class Service

java.lang.Object

oracle.fmwplatform.envspec.model.topology.Service

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.ContainerAware<Topology>, oracle.fmwplatform.envspec.common.EntityWithId

public class Service
extends Object
implements oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.ContainerAware<Topology>

Service represents a logical service that contains a set of endpoint(s)

Since:

12.2.2

Constructor Summary

Constructors

Constructor and Description
Service()

Method Summary

Modifier and Type	Method and Description
Service	addEndpoint(Endpoint endpoint)
Endpoint	getEndpointForId(String endpointId) Return the endpoint that matches the id
<T extends Endpoint> T	getEndpointForId(String endpointId, Class<T> clazzType) Return the endpoint that matches the id and the endpoint type
List<Endpoint>	getEndpoints()
String	getId() Returns the id used to reference this model object.
String	getName()
Topology	getParent() Returns the object that contains this entity
Service	setEndpoints(List<Endpoint> endpoints) Set the list of endpoints used to connect to the service
Service	setId(String id) Sets the id used to reference this model object.
Service	setName(String name)
Service	setParent(Topology containerTopology) Sets the container object that contains this.
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

Service

public Service()

Method Detail

getId

public String getId()

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

Returns the id used to reference this model object.

Specified by:

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

Returns:

the id used to reference this model object

setId

public Service setId(String id)

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

Sets the id used to reference this model object.

Specified by:

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

Parameters:

id - the id to be used when referencing this model object

Returns:

this (for method chaining)

getName

public String getName()

setName

public Service setName(String name)

getEndpoints

public List<Endpoint> getEndpoints()

getEndpointForId

public <T extends Endpoint> T getEndpointForId(String endpointId,
                                               Class<T> clazzType)

Return the endpoint that matches the id and the endpoint type

Type Parameters:

T - the class type

Parameters:

endpointId - to match

clazzType - type of endpoint

Returns:

endpoint or null if no match is found

getEndpointForId

public Endpoint getEndpointForId(String endpointId)

Return the endpoint that matches the id

Parameters:

endpointId - to match

Returns:

endpoint or null if no match is found

setEndpoints

public Service setEndpoints(List<Endpoint> endpoints)

Set the list of endpoints used to connect to the service

Parameters:

endpoints - connection protocol list

Returns:

Service that contains the endpoints

addEndpoint

public Service addEndpoint(Endpoint endpoint)

getParent

public Topology 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<Topology>

Returns:

parent container

setParent

public Service setParent(Topology containerTopology)

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<Topology>

Parameters:

containerTopology - the parent container

Returns:

the current container-aware object

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