net.sf.jrtps.builtin

Class ParticipantData

java.lang.Object

net.sf.jrtps.builtin.DiscoveredData

net.sf.jrtps.builtin.ParticipantData

public class ParticipantData
extends DiscoveredData

ParticipantData represents data on topic "DCPSParticipants". In addition to represent data of type ParticipantBuiltinTopicData, this class also represents data of type ParticipantBuiltinTopicDataSecure, which extends the former and adds IdentityToken and PermissionsToken parameters.

See 8.5.3.2 SPDPdiscoveredParticipantData. DDS::ParticipantBuiltinTopicData of RTPS specification and 7.4.1.3 Extension to RTPS Standard DCPSParticipants Builtin Topic of DDS Security

Author:

mcr70

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUILTIN_TOPIC_NAME
static String	BUILTIN_TYPE_NAME

Fields inherited from class net.sf.jrtps.builtin.DiscoveredData

key, qos, topicName, typeName

Constructor Summary

Constructors

Constructor and Description
ParticipantData(GuidPrefix prefix, int endpoints, List<Locator> discoveryLocators, List<Locator> userdataLocators, IdentityToken iToken, PermissionsToken pToken, QualityOfService participantQos)
ParticipantData(GuidPrefix prefix, int endpoints, List<Locator> discoveryLocators, List<Locator> userdataLocators, QualityOfService participantQos)
ParticipantData(ParameterList parameterList) Reads SPDPdiscoveredParticipantData.

Method Summary

Modifier and Type	Method and Description
boolean	expectsInlineQos() Gets ExpectsInlineQos
int	getBuiltinEndpoints()
List<Locator>	getDiscoveryLocators() Gets the list of Locators that can be used for discovery(metadata).
Guid	getGuid() Gets the guid of the partcipant.
GuidPrefix	getGuidPrefix() Gets the guid prefix.
IdentityToken	getIdentityToken() Gets the IdentityToken of ParticipantData if present.
Duration	getLeaseDuration() Lease duration associated with remote participant represented by this ParticipantData.
long	getLeaseExpirationTime() Gets the time when the lease will be expired.
int	getManualLivelinessCount()
PermissionsToken	getPermissionsToken() Gets the PermissionsToken of ParticipantData if present.
ProtocolVersion	getProtocolVersion() Gets the ProtocolVersion.
QosUserData	getUserData() Gets the UserData QoS policy
List<Locator>	getUserdataLocators() Gets the list of Locators that can be used for user data
VendorId	getVendorId() Get the VendorId
boolean	isAuthenticated()
boolean	isLeaseExpired() Checks, if the lease has been expired or not.
void	renewLease() Renews lease time that has been associated with this ParticipantData
void	setAuthenticated(boolean b)
void	setLeaseDuration(Duration duration)
String	toString()

Methods inherited from class net.sf.jrtps.builtin.DiscoveredData

addParameter, addQosPolicy, getBuiltinTopicKey, getInlineableQosPolicies, getParameter, getParameters, getQualityOfService, getTopicName, getTypeName, resolveInconsistencies

Methods inherited from class java.lang.Object

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

Field Detail

BUILTIN_TOPIC_NAME

public static final String BUILTIN_TOPIC_NAME

See Also:

Constant Field Values

BUILTIN_TYPE_NAME

public static final String BUILTIN_TYPE_NAME

See Also:

Constant Field Values

Constructor Detail

ParticipantData

public ParticipantData(GuidPrefix prefix,
                       int endpoints,
                       List<Locator> discoveryLocators,
                       List<Locator> userdataLocators,
                       QualityOfService participantQos)

ParticipantData

public ParticipantData(GuidPrefix prefix,
                       int endpoints,
                       List<Locator> discoveryLocators,
                       List<Locator> userdataLocators,
                       IdentityToken iToken,
                       PermissionsToken pToken,
                       QualityOfService participantQos)

ParticipantData

public ParticipantData(ParameterList parameterList)

Reads SPDPdiscoveredParticipantData. It is expected that inputstream is positioned to start of serializedData of Data submessage, aligned at 32 bit boundary.

Parameters:

parameterList - ParameterList

Method Detail

getIdentityToken

public IdentityToken getIdentityToken()

Gets the IdentityToken of ParticipantData if present.

Returns:

IdentityToken, or null if it does not exist.

getPermissionsToken

public PermissionsToken getPermissionsToken()

Gets the PermissionsToken of ParticipantData if present.

Returns:

PermissionsToken, or null if it does not exist.

getProtocolVersion

public ProtocolVersion getProtocolVersion()

Gets the ProtocolVersion.

Returns:

ProtocolVersion

getGuidPrefix

public GuidPrefix getGuidPrefix()

Gets the guid prefix.

Returns:

GuidPrefix

getGuid

public Guid getGuid()

Gets the guid of the partcipant.

Returns:

Guid

getVendorId

public VendorId getVendorId()

Get the VendorId

Returns:

VendorId

expectsInlineQos

public boolean expectsInlineQos()

Gets ExpectsInlineQos

Returns:

ExpectsInlineQos

getBuiltinEndpoints

public int getBuiltinEndpoints()

getLeaseDuration

public Duration getLeaseDuration()

Lease duration associated with remote participant represented by this ParticipantData. Remote participant is expected to renew its lease during its lease duration.

Returns:

Lease duration

getManualLivelinessCount

public int getManualLivelinessCount()

renewLease

public void renewLease()

Renews lease time that has been associated with this ParticipantData

See Also:

getLeaseDuration()

setLeaseDuration

public void setLeaseDuration(Duration duration)

isLeaseExpired

public boolean isLeaseExpired()

Checks, if the lease has been expired or not.

Returns:

true, if lease has been expired

getLeaseExpirationTime

public long getLeaseExpirationTime()

Gets the time when the lease will be expired.

Returns:

the time lease will expire

getDiscoveryLocators

public List<Locator> getDiscoveryLocators()

Gets the list of Locators that can be used for discovery(metadata).

Returns:

List of Locators for discovery

getUserdataLocators

public List<Locator> getUserdataLocators()

Gets the list of Locators that can be used for user data

Returns:

List of Locators for user data

toString

public String toString()

Overrides:

toString in class DiscoveredData

getUserData

public QosUserData getUserData()

Gets the UserData QoS policy

Returns:

QosUserData

setAuthenticated

public void setAuthenticated(boolean b)

isAuthenticated

public boolean isAuthenticated()