Package csw.location.api.models

Class TcpRegistration

java.lang.Object

csw.location.api.models.Registration

csw.location.api.models.TcpRegistration

All Implemented Interfaces:

LocationSerializable, Serializable, scala.Equals, scala.Product

public final class TcpRegistration
extends Registration
implements scala.Product, Serializable

TcpRegistration holds information needed to register a Tcp service

param: port provide the port where Tcp service is available param: metadata represents additional metadata information associated with location. Defaulted to empty if not provided.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TcpRegistration(Connection.TcpConnection connection, int port)
TcpRegistration(Connection.TcpConnection connection, int port, Metadata metadata)

Method Summary

Modifier and Type	Method	Description
static TcpRegistration	apply(Connection.TcpConnection connection, int port)
Connection.TcpConnection	connection()	The Connection to register with LocationService
Location	location(String hostname)	Create a TcpLocation that represents the live Tcp service
Metadata	metadata()	metadata represents any additional information (metadata) associated with registration
int	port()
TcpRegistration	withCswVersion(String version)

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Constructor Details

TcpRegistration

public TcpRegistration(Connection.TcpConnection connection,
 int port,
 Metadata metadata)

TcpRegistration

public TcpRegistration(Connection.TcpConnection connection,
 int port)

Method Details

apply

public static TcpRegistration apply(Connection.TcpConnection connection,
 int port)

connection

public Connection.TcpConnection connection()

Description copied from class: Registration

The Connection to register with LocationService

Specified by:

connection in class Registration

Returns:

(undocumented)

port

public int port()

metadata

public Metadata metadata()

Description copied from class: Registration

metadata represents any additional information (metadata) associated with registration

Specified by:

metadata in class Registration

Returns:

(undocumented)

location

public Location location(String hostname)

Create a TcpLocation that represents the live Tcp service

Specified by:

location in class Registration

Parameters:

hostname - provide the hostname where Tcp service is available

Returns:

an TcpLocation location representing a live connection at provided hostname

withCswVersion

public TcpRegistration withCswVersion(String version)

Specified by:

withCswVersion in class Registration