joynr.types

Class DiscoveryEntry

java.lang.Object

joynr.types.DiscoveryEntry

All Implemented Interfaces:

JoynrType, Serializable

Direct Known Subclasses:

DiscoveryEntryWithMetaInfo, GlobalDiscoveryEntry

public class DiscoveryEntry
extends Object
implements Serializable, JoynrType

Stores information about a provider instance and is used to communicate capabilities between a cluster controller and a lib-joynr instance.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAJOR_VERSION
static int	MINOR_VERSION

Constructor Summary

Constructors

Constructor and Description
DiscoveryEntry() Default Constructor
DiscoveryEntry(DiscoveryEntry discoveryEntryObj) Copy constructor
DiscoveryEntry(Version providerVersion, String domain, String interfaceName, String participantId, ProviderQos qos, Long lastSeenDateMs, Long expiryDateMs, String publicKeyId) Parameterized constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Check for equality
String	getDomain() Gets Domain
Long	getExpiryDateMs() Gets ExpiryDateMs
String	getInterfaceName() Gets InterfaceName
Long	getLastSeenDateMs() Gets LastSeenDateMs
String	getParticipantId() Gets ParticipantId
Version	getProviderVersion() Gets ProviderVersion
String	getPublicKeyId() Gets PublicKeyId
ProviderQos	getQos() Gets Qos
int	hashCode() Calculate code for hashing based on member contents
void	setDomain(String domain) Sets Domain
void	setExpiryDateMs(Long expiryDateMs) Sets ExpiryDateMs
void	setInterfaceName(String interfaceName) Sets InterfaceName
void	setLastSeenDateMs(Long lastSeenDateMs) Sets LastSeenDateMs
void	setParticipantId(String participantId) Sets ParticipantId
void	setProviderVersion(Version providerVersion) Sets ProviderVersion
void	setPublicKeyId(String publicKeyId) Sets PublicKeyId
void	setQos(ProviderQos qos) Sets Qos
String	toString() Stringifies the class

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MAJOR_VERSION

public static final int MAJOR_VERSION

See Also:

Constant Field Values

MINOR_VERSION

public static final int MINOR_VERSION

See Also:

Constant Field Values

Constructor Detail

DiscoveryEntry

public DiscoveryEntry()

Default Constructor

DiscoveryEntry

public DiscoveryEntry(DiscoveryEntry discoveryEntryObj)

Copy constructor

Parameters:

discoveryEntryObj - reference to the object to be copied

DiscoveryEntry

public DiscoveryEntry(Version providerVersion,
                      String domain,
                      String interfaceName,
                      String participantId,
                      ProviderQos qos,
                      Long lastSeenDateMs,
                      Long expiryDateMs,
                      String publicKeyId)

Parameterized constructor

Parameters:

providerVersion - semantic version information

domain - the domain to register the provider with

interfaceName - the name of the provider interface

participantId - the participant ID of the provider

qos - the qos of the provider

lastSeenDateMs - the date in millis since epoch when the source for this provider last contacted the directory

expiryDateMs - the date in millis since epoch when this entry can be purged from the directory and caches

publicKeyId - the ID of the public key to be used to encrypt messages to this provider

Method Detail

getProviderVersion

public Version getProviderVersion()

Gets ProviderVersion

Returns:

semantic version information

setProviderVersion

public void setProviderVersion(Version providerVersion)

Sets ProviderVersion

Parameters:

providerVersion - semantic version information

getDomain

public String getDomain()

Gets Domain

Returns:

the domain to register the provider with

setDomain

public void setDomain(String domain)

Sets Domain

Parameters:

domain - the domain to register the provider with

getInterfaceName

public String getInterfaceName()

Gets InterfaceName

Returns:

the name of the provider interface

setInterfaceName

public void setInterfaceName(String interfaceName)

Sets InterfaceName

Parameters:

interfaceName - the name of the provider interface

getParticipantId

public String getParticipantId()

Gets ParticipantId

Returns:

the participant ID of the provider

setParticipantId

public void setParticipantId(String participantId)

Sets ParticipantId

Parameters:

participantId - the participant ID of the provider

getQos

public ProviderQos getQos()

Gets Qos

Returns:

the qos of the provider

setQos

public void setQos(ProviderQos qos)

Sets Qos

Parameters:

qos - the qos of the provider

getLastSeenDateMs

public Long getLastSeenDateMs()

Gets LastSeenDateMs

Returns:

the date in millis since epoch when the source for this provider last contacted the directory

setLastSeenDateMs

public void setLastSeenDateMs(Long lastSeenDateMs)

Sets LastSeenDateMs

Parameters:

lastSeenDateMs - the date in millis since epoch when the source for this provider last contacted the directory

getExpiryDateMs

public Long getExpiryDateMs()

Gets ExpiryDateMs

Returns:

the date in millis since epoch when this entry can be purged from the directory and caches

setExpiryDateMs

public void setExpiryDateMs(Long expiryDateMs)

Sets ExpiryDateMs

Parameters:

expiryDateMs - the date in millis since epoch when this entry can be purged from the directory and caches

getPublicKeyId

public String getPublicKeyId()

Gets PublicKeyId

Returns:

the ID of the public key to be used to encrypt messages to this provider

setPublicKeyId

public void setPublicKeyId(String publicKeyId)

Sets PublicKeyId

Parameters:

publicKeyId - the ID of the public key to be used to encrypt messages to this provider

toString

public String toString()

Stringifies the class

Overrides:

toString in class Object

Returns:

stringified class content

equals

public boolean equals(Object obj)

Check for equality

Overrides:

equals in class Object

Parameters:

obj - Reference to the object to compare to

Returns:

true, if objects are equal, false otherwise

hashCode

public int hashCode()

Calculate code for hashing based on member contents

Overrides:

hashCode in class Object

Returns:

The calculated hash code