Package com.smartgridready.driver.api.messaging.model

Class MessagingInterfaceDescription

java.lang.Object

com.smartgridready.driver.api.messaging.model.MessagingInterfaceDescription

public class MessagingInterfaceDescription
extends java.lang.Object

Implements a messaging interface description.

Constructor Summary

Constructors

Constructor	Description
MessagingInterfaceDescription(MessagingPlatformType messagingPlatformType, java.util.List<MessageBroker> messageBrokerList, MessageBrokerAuthentication messageBrokerAuthentication, java.lang.String clientId)	Construct.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getClientId()	Gets the messaging client identifier.
MessageBrokerAuthentication	getMessageBrokerAuthentication()	Gets the message broker authentication configuration.
java.util.List<MessageBroker>	getMessageBrokerList()	Gets the list of configured message brokers.
MessagingPlatformType	getMessagingPlatformType()	Gets the messaging platform type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessagingInterfaceDescription

public MessagingInterfaceDescription(MessagingPlatformType messagingPlatformType,
                                     java.util.List<MessageBroker> messageBrokerList,
                                     MessageBrokerAuthentication messageBrokerAuthentication,
                                     java.lang.String clientId)

Construct.

Parameters:

messagingPlatformType - the messaging platform type

messageBrokerList - a list of message brokers to connect to

messageBrokerAuthentication - the message broker authentication configuration

clientId - the messaging client identifier

Method Detail

getMessagingPlatformType

public MessagingPlatformType getMessagingPlatformType()

Gets the messaging platform type.

Returns:

a platform type

getMessageBrokerList

public java.util.List<MessageBroker> getMessageBrokerList()

Gets the list of configured message brokers.

Returns:

a list of message broker configurations

getMessageBrokerAuthentication

public MessageBrokerAuthentication getMessageBrokerAuthentication()

Gets the message broker authentication configuration.

Returns:

an authentication configuration

getClientId

public java.lang.String getClientId()

Gets the messaging client identifier.

Returns:

a string