ParticipantConfig¶

public class ParticipantConfig¶

A class describing the configuration of Participant instances. Whenever possible, this class contains API classes instead of configuration options. Options, on the other hand, are maintained inside rsb.util.Properties instances.

Author: swrede, jmoringe, jwienke

Methods¶

copy¶

public ParticipantConfig copy()¶

Creates a deep copy of this instance. Most attributes are copied deeply.

Returns: deep copy

equals¶

public boolean equals(Object obj)¶

getEnabledTransports¶

public Set<TransportConfig> getEnabledTransports()¶

Returns the set of transport configurations which represent enabled transports.

Returns: set of transport configurations

getOrCreateTransport¶

public TransportConfig getOrCreateTransport(String transportName)¶

Returns a transport and, if necessary, creates the transport config.

Parameters: transportName – name of the transport
Returns: config for that transport

getReceivingStrategy¶

public EventReceivingStrategyFactory getReceivingStrategy()¶

Returns a factory for creating receiving strategy instances.

Returns: factory

getTransports¶

public final Map<String, TransportConfig> getTransports()¶

Returns the internal map of available transport configurations by their names.

Returns: map from transport names to their configuration objects

hasTransport¶

public boolean hasTransport(String name)¶

Indicates whether there is a configuration for a transport with the given name.

Parameters: name – name of the transport
Returns: true if a config for the transport exists, else false

hashCode¶

public int hashCode()¶

isIntrospectionEnabled¶

public boolean isIntrospectionEnabled()¶

Indicates whether introspection should be enabled for participants with this config or not.

Returns: true if participants shall be included in the introspection

setIntrospectionEnabled¶

public void setIntrospectionEnabled(boolean introspectionEnabled)¶

Sets whether introspection shall be enabled or not.

Parameters: introspectionEnabled – true for enabling

setReceivingStrategy¶

public void setReceivingStrategy(EventReceivingStrategyFactory receivingStrategy)¶

Setter method for the event receiving strategy factory to use.

Parameters: receivingStrategy – factory to use for creating receiving strategy instances.

toString¶

public String toString()¶