Package csw.location.api.models

Class AkkaRegistration

java.lang.Object

csw.location.api.models.Registration

csw.location.api.models.AkkaRegistration

All Implemented Interfaces:

LocationSerializable, Serializable, scala.Equals, scala.Product

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

AkkaRegistration holds the information needed to register an akka location

param: connection the Connection to register with LocationService param: actorRefURI Provide a remote actor uri that is offering a connection. Local actors cannot be registered since they can't be communicated from components across the network param: metadata represents additional metadata information associated with location. Defaulted to empty if not provided.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AkkaRegistration(Connection.AkkaConnection connection, URI actorRefURI, Metadata metadata)

Method Summary

Modifier and Type	Method	Description
URI	actorRefURI()
Connection.AkkaConnection	connection()	The Connection to register with LocationService
Location	location(String hostname)	Create a AkkaLocation that represents the live connection offered by the actor
Metadata	metadata()	metadata represents any additional information (metadata) associated with registration
AkkaRegistration	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

AkkaRegistration

public AkkaRegistration(Connection.AkkaConnection connection,
 URI actorRefURI,
 Metadata metadata)

Method Details

connection

public Connection.AkkaConnection connection()

Description copied from class: Registration

The Connection to register with LocationService

Specified by:

connection in class Registration

Returns:

(undocumented)

actorRefURI

public URI actorRefURI()

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 AkkaLocation that represents the live connection offered by the actor

Specified by:

location in class Registration

Parameters:

hostname - provide a hostname where the connection endpoint is available

Returns:

an AkkaLocation location representing a live connection at provided hostname

withCswVersion

public AkkaRegistration withCswVersion(String version)

Specified by:

withCswVersion in class Registration