Package csw.location.api.models

Class Connection

java.lang.Object

csw.location.api.models.Connection

All Implemented Interfaces:

LocationSerializable

Direct Known Subclasses:

TypedConnection

public abstract class Connection
extends Object
implements LocationSerializable

Represents a connection based on a componentId and the type of connection offered by the component

param: connectionType represents a type of connection offered by the Component

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Connection.AkkaConnection	Represents a connection offered by remote Actors e.g.
static class	Connection.AkkaConnection$
static class	Connection.HttpConnection	Represents a http connection provided by the component e.g.
static class	Connection.HttpConnection$
static class	Connection.TcpConnection	represents a tcp connection provided by the component e.g.
static class	Connection.TcpConnection$

Constructor Summary

Constructors

Constructor	Description
Connection(ConnectionType connectionType)

Method Summary

Modifier and Type	Method	Description
abstract ComponentId	componentId()	The component that is providing this connection
ConnectionInfo	connectionInfo()	Returns a ConnectionInfo which represents component name, component type and connection type for this Connection
ConnectionType	connectionType()
static Connection	from(ConnectionInfo connectionInfo)	Create a Connection from provided ConnectionInfo
static Connection	from(String input)	Create a Connection from provided String input
String	name()	Creates a unique name for Connection based on Component name, ComponentType and ConnectionType
<T extends Location> TypedConnection<T>	of()	A helper method to cast this Connection to TypedConnection
Prefix	prefix()	Represents the fully qualified component name along with the subsystem for e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Connection

public Connection(ConnectionType connectionType)

Method Details

from

public static Connection from(String input)

Create a Connection from provided String input

Parameters:

input - is the string representation of connection e.g. TromboneAssembly-assembly-akka

Returns:

a Connection model created from string

from

public static Connection from(ConnectionInfo connectionInfo)

Create a Connection from provided ConnectionInfo

Parameters:

connectionInfo - represents component name, component type and connection type

Returns:

A Connection created from connectionInfo

connectionType

public ConnectionType connectionType()

componentId

public abstract ComponentId componentId()

The component that is providing this connection

Returns:

(undocumented)

connectionInfo

public ConnectionInfo connectionInfo()

Returns a ConnectionInfo which represents component name, component type and connection type for this Connection

Returns:

(undocumented)

name

public String name()

Creates a unique name for Connection based on Component name, ComponentType and ConnectionType

Returns:

(undocumented)

prefix

public Prefix prefix()

Represents the fully qualified component name along with the subsystem for e.g. tcs.filter.wheel

Returns:

(undocumented)

of

public <T extends Location> TypedConnection<T> of()

A helper method to cast this Connection to TypedConnection

Returns:

A TypedConnection casted from this Connection