Class TransportConfiguration
java.lang.Object
org.apache.activemq.artemis.api.core.TransportConfiguration
- All Implemented Interfaces:
Serializable
A TransportConfiguration is used by a client to specify connections to a server and its backup if
one exists.
Typically the constructors take the class name and parameters for needed to create the connection. These will be different dependent on which connector is being used, i.e. Netty or InVM etc. For example:
HashMap<String, Object> map = new HashMap<String, Object>(); map.put("host", "localhost"); map.put("port", 61616); TransportConfiguration config = new TransportConfiguration(InVMConnectorFactory.class.getName(), map); ClientSessionFactory sf = new ClientSessionFactoryImpl(config);
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCreates a default TransportConfiguration with no configured transport.TransportConfiguration
(String className) Creates a TransportConfiguration providing the class name of theConnectorFactory
TransportConfiguration
(String className, Map<String, Object> params) Creates a TransportConfiguration providing the class name of theConnectorFactory
and any parameters needed.Creates a TransportConfiguration with a specific name providing the class name of theConnectorFactory
and any parameters needed.TransportConfiguration
(String className, Map<String, Object> params, String name, Map<String, Object> extraProps) Creates a TransportConfiguration with a specific name providing the class name of theConnectorFactory
and any parameters needed. -
Method Summary
Modifier and TypeMethodDescriptionvoid
decode
(ActiveMQBuffer buffer) Decodes this TransportConfiguration from a buffer.void
encode
(ActiveMQBuffer buffer) Encodes this TransportConfiguration into a buffer.boolean
Returns the class name of ConnectorFactory being used by this TransportConfigurationgetName()
Returns the name of this TransportConfiguration.Returns any parameters set for this TransportConfigurationint
hashCode()
boolean
isEquivalent
(TransportConfiguration otherConfig) There's a case on ClusterConnections that we need to find an equivalent Connector and we can't use a Netty Cluster Connection on an InVM ClusterConnection (inVM used on tests) for that reason I need to test if the two instances of the TransportConfiguration are equivalent while a test a connector against an acceptorboolean
newTransportConfig
(String newName) void
setFactoryClassName
(String factoryClassName) void
static String[]
splitHosts
(String commaSeparatedHosts) Utility method for splitting a comma separated list of hostsorg.apache.activemq.artemis.json.JsonObject
toJson()
toString()
static String
-
Field Details
-
NAME_PARAM
- See Also:
-
EXTRA_PROPERTY_PREFIX
- See Also:
-
-
Constructor Details
-
TransportConfiguration
public TransportConfiguration()Creates a default TransportConfiguration with no configured transport. -
TransportConfiguration
Creates a TransportConfiguration with a specific name providing the class name of theConnectorFactory
and any parameters needed.- Parameters:
className
- The class name of the ConnectorFactoryparams
- The parameters needed by the ConnectorFactoryname
- The name of this TransportConfiguration
-
TransportConfiguration
public TransportConfiguration(String className, Map<String, Object> params, String name, Map<String, Object> extraProps) Creates a TransportConfiguration with a specific name providing the class name of theConnectorFactory
and any parameters needed.- Parameters:
className
- The class name of the ConnectorFactoryparams
- The parameters needed by the ConnectorFactoryname
- The name of this TransportConfigurationextraProps
- The extra properties that specific to protocols
-
TransportConfiguration
Creates a TransportConfiguration providing the class name of theConnectorFactory
and any parameters needed.- Parameters:
className
- The class name of the ConnectorFactoryparams
- The parameters needed by the ConnectorFactory
-
TransportConfiguration
Creates a TransportConfiguration providing the class name of theConnectorFactory
- Parameters:
className
- The class name of the ConnectorFactory
-
-
Method Details
-
toJson
public org.apache.activemq.artemis.json.JsonObject toJson() -
splitHosts
Utility method for splitting a comma separated list of hosts- Parameters:
commaSeparatedHosts
- the comma separated host string- Returns:
- the hosts
-
newTransportConfig
-
getName
Returns the name of this TransportConfiguration.- Returns:
- the name
-
setName
-
getFactoryClassName
Returns the class name of ConnectorFactory being used by this TransportConfiguration- Returns:
- The factory's class name
-
getParams
Returns any parameters set for this TransportConfiguration- Returns:
- the parameters
-
getExtraParams
-
getCombinedParams
-
hashCode
public int hashCode() -
equals
-
isSameParams
-
isEquivalent
There's a case on ClusterConnections that we need to find an equivalent Connector and we can't use a Netty Cluster Connection on an InVM ClusterConnection (inVM used on tests) for that reason I need to test if the two instances of the TransportConfiguration are equivalent while a test a connector against an acceptor- Parameters:
otherConfig
-- Returns:
true
if the factory class names are equivalents
-
toString
-
toStringParameters
-
encode
Encodes this TransportConfiguration into a buffer.Note that this is only used internally ActiveMQ Artemis.
- Parameters:
buffer
- the buffer to encode into
-
decode
Decodes this TransportConfiguration from a buffer.Note this is only used internally by ActiveMQ
- Parameters:
buffer
- the buffer to decode from
-
setFactoryClassName
-