org.omg.dds.core.QosProvider Class Reference

The QoS provider API allows users to specify the QoS settings of their DCPS entities outside of application code in XML. More...

Inheritance diagram for org.omg.dds.core.QosProvider:

Collaboration diagram for org.omg.dds.core.QosProvider:

Public Member Functions
abstract DataReaderQos	getDataReaderQos ()
	Resolves the DataReaderQos associated with QosProvider. More...
abstract DataReaderQos	getDataReaderQos (String id)
	Resolves the DataReaderQos identified by the id from the uri the QosProvider is associated with. More...
abstract DataWriterQos	getDataWriterQos ()
	Resolves the DataWriterQos associated with QosProvider. More...
abstract DataWriterQos	getDataWriterQos (String id)
	Resolves the DataWriterQos identified by the id from the uri the QosProvider is associated with. More...
abstract DomainParticipantFactoryQos	getDomainParticipantFactoryQos ()
	Resolves the DomainParticipantFactoryQos associated with QosProvider. More...
abstract DomainParticipantFactoryQos	getDomainParticipantFactoryQos (String id)
	Resolves the DomainParticipantFactoryQos identified by the id from the uri the QosProvider is associated with. More...
abstract DomainParticipantQos	getDomainParticipantQos ()
	Resolves the DomainParticipantQos associated with QosProvider. More...
abstract DomainParticipantQos	getDomainParticipantQos (String id)
	Resolves the DomainParticipantQos identified by the id from the uri the QosProvider is associated with. More...
ServiceEnvironment	getEnvironment ()
abstract PublisherQos	getPublisherQos ()
	Resolves the PublisherQos associated with QosProvider. More...
abstract PublisherQos	getPublisherQos (String id)
	Resolves the PublisherQos identified by the id from the uri the QosProvider is associated with. More...
abstract SubscriberQos	getSubscriberQos ()
	Resolves the SubscriberQos associated with QosProvider. More...
abstract SubscriberQos	getSubscriberQos (String id)
	Resolves the SubscriberQos identified by the id from the uri the QosProvider is associated with. More...
abstract TopicQos	getTopicQos ()
	Resolves the TopicQos associated with QosProvider. More...
abstract TopicQos	getTopicQos (String id)
	Resolves the TopicQos identified by the id from the uri the QosProvider is associated with. More...

Static Public Member Functions
static QosProvider	newQosProvider (String uri, String profile, ServiceEnvironment env)
	Constructs a new QosProvider based on the provided uri and profile. More...

Detailed Description

The QoS provider API allows users to specify the QoS settings of their DCPS entities outside of application code in XML.

This can be seen as a useful feature where code recompilation is restricted during the later stages of application development / during application support.

Example:

// Create a named QosProvider from a URL
QosProvider qosProvider = QosProvider.newQosProvider("file://qos.xml", "foo-profile", env);

//Create a topic named "FooTopic" using the QoS Provider and no Listener and no status.
TopicListener<Foo> listener = null;
Collection<Class<? extends Status>> status = new HashSet<Class<? extends Status>>();
Topic<Foo> fooTopic = participant.createTopic("FooTopic", Foo.class,qosProvider.getTopicQos("foo-topic-qos"),listener, status);

Definition at line 47 of file QosProvider.java.

Member Function Documentation

getDataReaderQos() [1/2]

abstract DataReaderQos org.omg.dds.core.QosProvider.getDataReaderQos ( )

abstract

Resolves the DataReaderQos associated with QosProvider.

Returns

A valid DataReaderQos instance, null if no DataReaderQos can be found in the associated QosProvider.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the QosProvider instance is not properly initialized.
org.omg.dds.core.OutOfResourcesException	if not enough memory is available to perform the operation.
org.omg.dds.core.DDSException	if an internal error occurred.

getDataReaderQos() [2/2]

abstract DataReaderQos org.omg.dds.core.QosProvider.getDataReaderQos ( String  id )

abstract

Resolves the DataReaderQos identified by the id from the uri the QosProvider is associated with.

Parameters

id

The fully-qualified name that identifies a QoS within the uri associated with the QosProvider or a name that identifies a QoS within the uri associated with the QosProvider instance relative to its default QoS profile. Id's starting with "::" are interpreted as fully-qualified names and all others are interpreted as names relative to the default QoS profile of the QosProvider instance. A nil id is interpreted as a non-named QoS within the default QoS profile associated with the QosProvider.

Returns

A valid DataReaderQos instance, null if no DataReaderQos that matches the provided id can be found within the uri associated with the QosProvider.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the QosProvider instance is not properly initialized.
org.omg.dds.core.OutOfResourcesException	if not enough memory is available to perform the operation.
org.omg.dds.core.DDSException	if an internal error occurred.

getDataWriterQos() [1/2]

abstract DataWriterQos org.omg.dds.core.QosProvider.getDataWriterQos ( )

abstract

Resolves the DataWriterQos associated with QosProvider.

Returns

A valid DataWriterQos instance, null if no DataWriterQos can be found in the associated QosProvider.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the QosProvider instance is not properly initialized.
org.omg.dds.core.OutOfResourcesException	if not enough memory is available to perform the operation.
org.omg.dds.core.DDSException	if an internal error occurred.

getDataWriterQos() [2/2]

abstract DataWriterQos org.omg.dds.core.QosProvider.getDataWriterQos ( String  id )

abstract

Resolves the DataWriterQos identified by the id from the uri the QosProvider is associated with.

Parameters

id

The fully-qualified name that identifies a QoS within the uri associated with the QosProvider or a name that identifies a QoS within the uri associated with the QosProvider instance relative to its default QoS profile. Id's starting with "::" are interpreted as fully-qualified names and all others are interpreted as names relative to the default QoS profile of the QosProvider instance. A nil id is interpreted as a non-named QoS within the default QoS profile associated with the QosProvider.

Returns

A valid DataWriterQos instance, null if no DataWriterQos that matches the provided id can be found within the uri associated with the QosProvider.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the QosProvider instance is not properly initialized.
org.omg.dds.core.OutOfResourcesException	if not enough memory is available to perform the operation.
org.omg.dds.core.DDSException	if an internal error occurred.

getDomainParticipantFactoryQos() [1/2]

abstract DomainParticipantFactoryQos org.omg.dds.core.QosProvider.getDomainParticipantFactoryQos ( )

abstract

Resolves the DomainParticipantFactoryQos associated with QosProvider.

Returns

A valid DomainParticipantFactoryQos instance, null if no DomainParticipantFactoryQos can be found in the associated QosProvider.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the QosProvider instance is not properly initialized.
org.omg.dds.core.OutOfResourcesException	if not enough memory is available to perform the operation.
org.omg.dds.core.DDSException	if an internal error occurred.
java.lang.UnsupportedOperationException	if the supplied operation is not implemented.

getDomainParticipantFactoryQos() [2/2]

abstract DomainParticipantFactoryQos org.omg.dds.core.QosProvider.getDomainParticipantFactoryQos ( String  id )

abstract

Resolves the DomainParticipantFactoryQos identified by the id from the uri the QosProvider is associated with.

Parameters

id

The fully-qualified name that identifies a QoS within the uri associated with the QosProvider or a name that identifies a QoS within the uri associated with the QosProvider instance relative to its default QoS profile. Id's starting with "::" are interpreted as fully-qualified names and all others are interpreted as names relative to the default QoS profile of the QosProvider instance. A nil id is interpreted as a non-named QoS within the default QoS profile associated with the QosProvider.

Returns

A valid DomainParticipantFactoryQos instance, null if no DomainParticipantFactoryQos that matches the provided id can be found within the uri associated with the QosProvider.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the QosProvider instance is not properly initialized.
org.omg.dds.core.OutOfResourcesException	if not enough memory is available to perform the operation.
org.omg.dds.core.DDSException	if an internal error occurred.
java.lang.UnsupportedOperationException	if the supplied operation is not implemented.

getDomainParticipantQos() [1/2]

abstract DomainParticipantQos org.omg.dds.core.QosProvider.getDomainParticipantQos ( )

abstract

Resolves the DomainParticipantQos associated with QosProvider.

Returns

A valid DomainParticipantQos instance, null if no DomainParticipantQos can be found in the associated QosProvider.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the QosProvider instance is not properly initialized.
org.omg.dds.core.OutOfResourcesException	if not enough memory is available to perform the operation.
org.omg.dds.core.DDSException	if an internal error occurred.

getDomainParticipantQos() [2/2]

abstract DomainParticipantQos org.omg.dds.core.QosProvider.getDomainParticipantQos ( String  id )

abstract

Resolves the DomainParticipantQos identified by the id from the uri the QosProvider is associated with.

Parameters

id

The fully-qualified name that identifies a QoS within the uri associated with the QosProvider or a name that identifies a QoS within the uri associated with the QosProvider instance relative to its default QoS profile. Id's starting with "::" are interpreted as fully-qualified names and all others are interpreted as names relative to the default QoS profile of the QosProvider instance. A nil id is interpreted as a non-named QoS within the default QoS profile associated with the QosProvider.

Returns

A valid DomainParticipantQos instance, null if no DomainParticipantQos that matches the provided id can be found within the uri associated with the QosProvider.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the QosProvider instance is not properly initialized.
org.omg.dds.core.OutOfResourcesException	if not enough memory is available to perform the operation.
org.omg.dds.core.DDSException	if an internal error occurred.

getEnvironment()

ServiceEnvironment org.omg.dds.core.DDSObject.getEnvironment ( )

inherited

Returns

the org.omg.dds.core.ServiceEnvironment object that directly or indirectly was used to create this object.

Implemented in org.omg.dds.core.ServiceEnvironment, org.opensplice.dds.sub.ReflectionDataReader< TYPE, OUT_TYPE >, org.opensplice.dds.core.ModifiableTimeImpl, org.opensplice.dds.pub.ReflectionDataWriter< TYPE >, org.opensplice.dds.core.DurationImpl, org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >, org.opensplice.dds.sub.ReadConditionImpl< TYPE >, org.opensplice.dds.core.EntityQosImpl< T extends QosPolicy >, org.opensplice.dds.type.TypeSupportImpl< TYPE >, org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl, org.opensplice.dds.topic.SubscriptionBuiltinTopicDataImpl, org.opensplice.dds.topic.TopicBuiltinTopicDataImpl, org.opensplice.dds.domain.DomainParticipantFactoryImpl, org.opensplice.dds.core.QosProviderImpl, org.opensplice.dds.core.status.OfferedIncompatibleQosStatusImpl, org.opensplice.dds.core.status.RequestedIncompatibleQosStatusImpl, org.opensplice.dds.core.InstanceHandleImpl, org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>, org.opensplice.dds.core.status.LivelinessChangedStatusImpl, org.opensplice.dds.core.status.PublicationMatchedStatusImpl, org.opensplice.dds.core.status.SubscriptionMatchedStatusImpl, org.opensplice.dds.sub.SampleImpl< TYPE >, org.opensplice.dds.core.policy.ShareImpl, org.opensplice.dds.core.status.OfferedDeadlineMissedStatusImpl, org.opensplice.dds.core.status.SampleRejectedStatusImpl, org.opensplice.dds.core.WaitSetImpl, org.opensplice.dds.topic.ParticipantBuiltinTopicDataImpl, org.opensplice.dds.core.status.RequestedDeadlineMissedStatusImpl, org.opensplice.dds.topic.BuiltinTopicKeyImpl, org.opensplice.dds.core.GuardConditionImpl, org.opensplice.dds.core.event.AllDataDisposedEventImpl< TYPE >, org.opensplice.dds.core.policy.QosPolicyCountImpl, org.opensplice.dds.core.status.InconsistentTopicStatusImpl, org.opensplice.dds.core.status.LivelinessLostStatusImpl, org.opensplice.dds.core.status.SampleLostStatusImpl, org.opensplice.dds.core.policy.QosPolicyImpl, org.opensplice.dds.core.status.AllDataDisposedStatusImpl, org.opensplice.dds.core.IllegalArgumentExceptionImpl, org.opensplice.dds.core.InconsistentPolicyExceptionImpl, org.opensplice.dds.core.policy.PolicyFactoryImpl, org.opensplice.dds.core.policy.TypeConsistencyEnforcementImpl, org.opensplice.dds.core.PreconditionNotMetExceptionImpl, org.opensplice.dds.core.AlreadyClosedExceptionImpl, org.opensplice.dds.core.IllegalOperationExceptionImpl, org.opensplice.dds.core.ImmutablePolicyExceptionImpl, org.opensplice.dds.core.NotEnabledExceptionImpl, org.opensplice.dds.core.OutOfResourcesExceptionImpl, org.opensplice.dds.core.DDSExceptionImpl, org.opensplice.dds.core.status.DataAvailableStatusImpl, and org.opensplice.dds.core.status.DataOnReadersStatusImpl.

getPublisherQos() [1/2]

abstract PublisherQos org.omg.dds.core.QosProvider.getPublisherQos ( )

abstract

Resolves the PublisherQos associated with QosProvider.

Returns

A valid PublisherQos instance, null if no PublisherQos can be found in the associated QosProvider.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the QosProvider instance is not properly initialized.
org.omg.dds.core.OutOfResourcesException	if not enough memory is available to perform the operation.
org.omg.dds.core.DDSException	if an internal error occurred.

getPublisherQos() [2/2]

abstract PublisherQos org.omg.dds.core.QosProvider.getPublisherQos ( String  id )

abstract

Resolves the PublisherQos identified by the id from the uri the QosProvider is associated with.

Parameters

id

The fully-qualified name that identifies a QoS within the uri associated with the QosProvider or a name that identifies a QoS within the uri associated with the QosProvider instance relative to its default QoS profile. Id's starting with "::" are interpreted as fully-qualified names and all others are interpreted as names relative to the default QoS profile of the QosProvider instance. A nil id is interpreted as a non-named QoS within the default QoS profile associated with the QosProvider.

Returns

A valid PublisherQos instance, null if no PublisherQos that matches the provided id can be found within the uri associated with the QosProvider.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the QosProvider instance is not properly initialized.
org.omg.dds.core.OutOfResourcesException	if not enough memory is available to perform the operation.
org.omg.dds.core.DDSException	if an internal error occurred.

getSubscriberQos() [1/2]

abstract SubscriberQos org.omg.dds.core.QosProvider.getSubscriberQos ( )

abstract

Resolves the SubscriberQos associated with QosProvider.

Returns

A valid SubscriberQos instance, null if no SubscriberQos can be found in the associated QosProvider.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the QosProvider instance is not properly initialized.
org.omg.dds.core.OutOfResourcesException	if not enough memory is available to perform the operation.
org.omg.dds.core.DDSException	if an internal error occurred.

getSubscriberQos() [2/2]

abstract SubscriberQos org.omg.dds.core.QosProvider.getSubscriberQos ( String  id )

abstract

Resolves the SubscriberQos identified by the id from the uri the QosProvider is associated with.

Parameters

id

The fully-qualified name that identifies a QoS within the uri associated with the QosProvider or a name that identifies a QoS within the uri associated with the QosProvider instance relative to its default QoS profile. Id's starting with "::" are interpreted as fully-qualified names and all others are interpreted as names relative to the default QoS profile of the QosProvider instance. A nil id is interpreted as a non-named QoS within the default QoS profile associated with the QosProvider.

Returns

A valid SubscriberQos instance, null if no SubscriberQos that matches the provided id can be found within the uri associated with the QosProvider.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the QosProvider instance is not properly initialized.
org.omg.dds.core.OutOfResourcesException	if not enough memory is available to perform the operation.
org.omg.dds.core.DDSException	if an internal error occurred.

getTopicQos() [1/2]

abstract TopicQos org.omg.dds.core.QosProvider.getTopicQos ( )

abstract

Resolves the TopicQos associated with QosProvider.

Returns

A valid TopicQos instance, null if no TopicQos can be found in the associated QosProvider.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the QosProvider instance is not properly initialized.
org.omg.dds.core.OutOfResourcesException	if not enough memory is available to perform the operation.
org.omg.dds.core.DDSException	if an internal error occurred.

getTopicQos() [2/2]

abstract TopicQos org.omg.dds.core.QosProvider.getTopicQos ( String  id )

abstract

Resolves the TopicQos identified by the id from the uri the QosProvider is associated with.

Parameters

id

The fully-qualified name that identifies a QoS within the uri associated with the QosProvider or a name that identifies a QoS within the uri associated with the QosProvider instance relative to its default QoS profile. Id's starting with "::" are interpreted as fully-qualified names and all others are interpreted as names relative to the default QoS profile of the QosProvider instance. A nil id is interpreted as a non-named QoS within the default QoS profile associated with the QosProvider.

Returns

A valid TopicQos instance, null if no TopicQos that matches the provided id can be found within the uri associated with the QosProvider.

Exceptions

org.omg.dds.core.PreconditionNotMetException	if the QosProvider instance is not properly initialized.
org.omg.dds.core.OutOfResourcesException	if not enough memory is available to perform the operation.
org.omg.dds.core.DDSException	if an internal error occurred.

newQosProvider()

static QosProvider org.omg.dds.core.QosProvider.newQosProvider ( String  uri, String  profile, ServiceEnvironment  env  )

static

Constructs a new QosProvider based on the provided uri and profile.

Parameters

uri	A Uniform Resource Identifier (URI that points to the location where the QoS profile needs to be loaded from. Currently only URI's with a "file" scheme that point to an XML file are supported. If profiles and/or QoS settings are not uniquely identifiable by name within the resource pointed to by the uri, a random one of them will be stored.
profile	The name of the QoS profile that serves as the default QoS profile for the get*Qos operations.

Returns

A QosProvider instance that is instantiated with all profiles and/or QoS-ses loaded from the location specified by the provided uri.

Exceptions

IllegalArgumentException

If no uri is provided or the resource pointed to by uri cannot be found or the content of the resource pointed to by uri is malformed (e.g. malformed XML).

Definition at line 72 of file QosProvider.java.

---

The documentation for this class was generated from the following file:

• java5/common/java/code/org/omg/dds/core/QosProvider.java