Class QEsbProviderMetaData

java.lang.Object
com.kingsrook.qqq.esb.model.QEsbProviderMetaData
All Implemented Interfaces:
MetaDataProducerOutput, QMetaDataObject, TopLevelMetaDataInterface, Serializable
public class QEsbProviderMetaData extends Object implements TopLevelMetaDataInterface
Meta-data for a message broker that ESB destinations live on. url is the Artemis URL (e.g., tcp://host:61616), or, for RabbitMQ, the AMQP URI (including host, port, and vhost). The optional management fields enable queue depth, consumer counts, and queue management actions. url, username, password, and the management fields may be given as ${env.X} (etc.) variables - they are interpreted when the instance is enriched. A variable that isn't set leaves its field null, and logs a warning that names the provider and field (never a value). url can itself carry credentials (e.g., an AMQP URI with user:pass@), so don't serialize these objects or echo url to users; build a view of just the fields that are safe to show instead. A top-level meta-data object: adding it to an instance puts it in that instance's EsbInstanceMetaData.
See Also:

  • Constructor Details

    • QEsbProviderMetaData

      public QEsbProviderMetaData()

  • Method Details

    • addSelfToInstance

      public void addSelfToInstance(QInstance qInstance)
      Description copied from interface: MetaDataProducerOutput
      call the appropriate methods on a QInstance to add ourselves to it.
      Specified by:
      addSelfToInstance in interface MetaDataProducerOutput
      Specified by:
      addSelfToInstance in interface TopLevelMetaDataInterface

    • interpretVariables

      public void interpretVariables(QMetaDataVariableInterpreter interpreter)
      Interpret variables (e.g., ${env.BROKER_PASSWORD}) in the connection fields.

    • getName

      public String getName()
      Getter for name
      Specified by:
      getName in interface TopLevelMetaDataInterface

    • setName

      public void setName(String name)
      Setter for name

    • withName

      public QEsbProviderMetaData withName(String name)
      Fluent setter for name

    • getType

      public EsbProviderType getType()
      Getter for type

    • setType

      public void setType(EsbProviderType type)
      Setter for type

    • withType

      public QEsbProviderMetaData withType(EsbProviderType type)
      Fluent setter for type

    • getUrl

      public String getUrl()
      Getter for url

    • setUrl

      public void setUrl(String url)
      Setter for url

    • withUrl

      public QEsbProviderMetaData withUrl(String url)
      Fluent setter for url

    • getUsername

      public String getUsername()
      Getter for username

    • setUsername

      public void setUsername(String username)
      Setter for username

    • withUsername

      public QEsbProviderMetaData withUsername(String username)
      Fluent setter for username

    • getPassword

      public String getPassword()
      Getter for password - never serialized.

    • setPassword

      public void setPassword(String password)
      Setter for password

    • withPassword

      public QEsbProviderMetaData withPassword(String password)
      Fluent setter for password

    • getManagementUrl

      public String getManagementUrl()
      Getter for managementUrl

    • setManagementUrl

      public void setManagementUrl(String managementUrl)
      Setter for managementUrl

    • withManagementUrl

      public QEsbProviderMetaData withManagementUrl(String managementUrl)
      Fluent setter for managementUrl

    • getManagementUsername

      public String getManagementUsername()
      Getter for managementUsername

    • setManagementUsername

      public void setManagementUsername(String managementUsername)
      Setter for managementUsername

    • withManagementUsername

      public QEsbProviderMetaData withManagementUsername(String managementUsername)
      Fluent setter for managementUsername

    • getManagementPassword

      public String getManagementPassword()
      Getter for managementPassword - never serialized.

    • setManagementPassword

      public void setManagementPassword(String managementPassword)
      Setter for managementPassword

    • withManagementPassword

      public QEsbProviderMetaData withManagementPassword(String managementPassword)
      Fluent setter for managementPassword