org.omg.dds.core.policy

Interface UserData

All Superinterfaces:

DDSObject, QosPolicy, QosPolicy.ForDataReader, QosPolicy.ForDataWriter, QosPolicy.ForDomainParticipant, Serializable

public interface UserData
extends QosPolicy.ForDomainParticipant, QosPolicy.ForDataReader, QosPolicy.ForDataWriter

User data not known by the middleware, but distributed by means of built-in topics. The default value is an empty (zero-sized) sequence. Concerns: DomainParticipant, DataReader, DataWriter RxO: No Changeable: Yes The purpose of this QoS is to allow the application to attach additional information to the created Entity objects such that when a remote application discovers their existence it can access that information and use it for its own purposes. One possible use of this QoS is to attach security credentials or some other information that can be used by the remote application to authenticate the source. In combination with operations such as DomainParticipant.ignoreParticipant(org.omg.dds.core.InstanceHandle), DomainParticipant.ignorePublication(org.omg.dds.core.InstanceHandle), DomainParticipant.ignoreSubscription(org.omg.dds.core.InstanceHandle), and DomainParticipant.ignoreTopic(org.omg.dds.core.InstanceHandle) these QoS can assist an application to define and enforce its own security policies. The use of this QoS is not limited to security, rather it offers a simple, yet flexible extensibility mechanism.

Nested Class Summary

Nested classes/interfaces inherited from interface org.omg.dds.core.policy.QosPolicy

QosPolicy.ForDataReader, QosPolicy.ForDataWriter, QosPolicy.ForDomainParticipant, QosPolicy.ForDomainParticipantFactory, QosPolicy.ForPublisher, QosPolicy.ForSubscriber, QosPolicy.ForTopic

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getValue() Get a copy of the data.
UserData	withValue(byte[] value, int offset, int length) Copy this policy and override the value of the property.

Methods inherited from interface org.omg.dds.core.DDSObject

getEnvironment

Method Detail

getValue

byte[] getValue()

Get a copy of the data.

withValue

UserData withValue(byte[] value,
                 int offset,
                 int length)

Copy this policy and override the value of the property.

Returns:

a new policy