TransportConfig¶

public class TransportConfig¶

Represents the configuration of a single transport.

Author: swrede, jmoringe

Constructors¶

TransportConfig¶

public TransportConfig(String name, boolean enabled, Properties options)¶

Creates a new instance.

Parameters

name – name of the transport
enabled – should this transport be enabled in participants or not?
options – transport-specific options

TransportConfig¶

public TransportConfig(String name, boolean enabled, Properties options, ConverterRepository<?> converters)¶

Creates a new instance.

Parameters

name – name of the transport
enabled – should this transport be enabled in participants or not?
options – transport-specific options
converters – the converter selection strategy to use for the transport. null indicates to use the system-wide configuration.

TransportConfig¶

public TransportConfig(String name)¶

Creates a new instance. The transport will be disabled and options will be empty

Parameters: name – name of the transport

Methods¶

copy¶

public TransportConfig copy()¶

Creates a new instance as a copy of this one in the sense of a deep copy apart from the converters.

Returns: deep copy

equals¶

public boolean equals(Object obj)¶

getConverters¶

public ConverterRepository<?> getConverters()¶

Returns the desired converter repository for the transport.

Returns: converter repository to use or null in case the system-wide default shall be used.

getConverters¶

public ConverterRepository<?> getConverters(ConverterRepository<?> defaultInst)¶

Returns the desired converter repository for the transport or the provided default in case no desired instance is is specified.

Parameters: defaultInst – instance to return in case no converter repository was specified inside this config
Returns: converter repository to use or null in case event the given default instance was null.

getName¶

public String getName()¶

Returns the name of the transport.

Returns: name string

getOptions¶

public Properties getOptions()¶

Returns the transport-specific options.

Returns: options specifically for the transport with a common prefix

hashCode¶

public int hashCode()¶

isEnabled¶

public boolean isEnabled()¶

Indicates whether the transport shall be enabled in participants or not.

Returns: true if transport shall be enabled, else false

setConverters¶

public void setConverters(ConverterRepository<?> converters)¶

Sets the converter repository to be used for this transport.

Parameters: converters – converters to use or null to indicate use of system-wide converters

setEnabled¶

public void setEnabled(boolean enabled)¶

Sets whether the transport shall be enabled in participants.

Parameters: enabled – true to enable the transport, else false

setOptions¶

public void setOptions(Properties options)¶

Sets the transport-specific options.

Parameters: options – options specifically for this transport

toString¶

public String toString()¶