Huawei Simple Message Notification (SMN)

URI format

To send a notification.

hwcloud-smn:service[?options]

Configuring Options

Camel components are configured on two separate levels:

component level
endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

Component Options

The Huawei Simple Message Notification (SMN) component supports 2 options, which are listed below.

Name	Description	Default	Type
lazyStartProducer (producer)	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean
autowiredEnabled (advanced)	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	boolean

Name

Description

Default

Type

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

autowiredEnabled (advanced)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

boolean

Endpoint Options

The Huawei Simple Message Notification (SMN) endpoint is configured using URI syntax:

hwcloud-smn:smnService

with the following path and query parameters:

Path Parameters (1 parameters)

Name	Description	Default	Type
smnService (producer)	Required Name of SMN service to invoke.		String

Name

Description

Default

Type

smnService (producer)

Required Name of SMN service to invoke.

String

Query Parameters (14 parameters)

Name	Description	Default	Type
accessKey (producer)	Required Access key for the cloud user.		String
endpoint (producer)	Fully qualified smn service url. Carries higher precedence than region parameter based client initialization.		String
ignoreSslVerification (producer)	Ignore SSL verification.	false	boolean
messageTtl (producer)	TTL for published message.	3600	int
operation (producer)	Required Name of operation to perform.		String
projectId (producer)	Required Cloud project ID.		String
proxyHost (producer)	Proxy server ip/hostname.		String
proxyPassword (producer)	Proxy authentication password.		String
proxyPort (producer)	Proxy server port.		int
proxyUser (producer)	Proxy authentication user.		String
region (producer)	Required SMN service region. This is lower precedence than endpoint based configuration.		String
secretKey (producer)	Required Secret key for the cloud user.		String
serviceKeys (producer)	Configuration object for cloud service authentication.		ServiceKeys
lazyStartProducer (producer (advanced))	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean

Name

Description

Default

Type

accessKey (producer)

Required Access key for the cloud user.

String

endpoint (producer)

Fully qualified smn service url. Carries higher precedence than region parameter based client initialization.

String

ignoreSslVerification (producer)

Ignore SSL verification.

false

boolean

messageTtl (producer)

TTL for published message.

3600

int

operation (producer)

Required Name of operation to perform.

String

projectId (producer)

Required Cloud project ID.

String

proxyHost (producer)

Proxy server ip/hostname.

String

proxyPassword (producer)

Proxy authentication password.

String

proxyPort (producer)

Proxy server port.

int

proxyUser (producer)

Proxy authentication user.

String

region (producer)

Required SMN service region. This is lower precedence than endpoint based configuration.

String

secretKey (producer)

Required Secret key for the cloud user.

String

serviceKeys (producer)

Configuration object for cloud service authentication.

ServiceKeys

lazyStartProducer (producer (advanced))

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

Usage

Message properties evaluated by the SMN producer

Header Type Description

Header	Type	Description
`CamelHwCloudSmnSubject`	`String`	Subject tag for the outgoing notification
`CamelHwCloudSmnTopic`	`String`	Smn topic into which the message is to be posted
`CamelHwCloudSmnMessageTtl`	`Integer`	Validity of the posted notification message
`CamelHwCloudSmnTemplateTags`	`Map<String, String>`	Contains K,V pairs of tags and values when using operation `publishAsTemplatedMessage`
`CamelHwCloudSmnTemplateName`	`String`	Name of the template to use while using operation `publishAsTemplatedMessage`

CamelHwCloudSmnSubject

String

Subject tag for the outgoing notification

CamelHwCloudSmnTopic

String

Smn topic into which the message is to be posted

CamelHwCloudSmnMessageTtl

Integer

Validity of the posted notification message

CamelHwCloudSmnTemplateTags

Map<String, String>

Contains K,V pairs of tags and values when using operation publishAsTemplatedMessage

CamelHwCloudSmnTemplateName

String

Name of the template to use while using operation publishAsTemplatedMessage

Message properties set by the SMN producer

Header Type Description

Header	Type	Description
`CamelHwCloudSmnMesssageId`	`String`	Unique message id returned by Simple Message Notification server after processing the request
`CamelHwCloudSmnRequestId`	`String`	Unique request id returned by Simple Message Notification server after processing the request

CamelHwCloudSmnMesssageId

String

Unique message id returned by Simple Message Notification server after processing the request

CamelHwCloudSmnRequestId

String

Unique request id returned by Simple Message Notification server after processing the request

Supported list of smn services and corresponding operations

Service Operations

Service	Operations
`publishMessageService`	publishAsTextMessage, publishAsTemplatedMessage

publishMessageService

publishAsTextMessage, publishAsTemplatedMessage

Inline Configuration of route

publishAsTextMessage

Java DSL

from("direct:triggerRoute")
.setProperty(SmnProperties.NOTIFICATION_SUBJECT, constant("Notification Subject"))
.setProperty(SmnProperties.NOTIFICATION_TOPIC_NAME,constant(testConfiguration.getProperty("topic")))
.setProperty(SmnProperties.NOTIFICATION_TTL, constant(60))
.to("hwcloud-smn:publishMessageService?operation=publishAsTextMessage&accessKey=*********&secretKey=********&projectId=9071a38e7f6a4ba7b7bcbeb7d4ea6efc&region=cn-north-4")

XML DSL

<route>
   <from uri="direct:triggerRoute" />
   <setProperty name="CamelHwCloudSmnSubject">
      <constant>this is my subjectline</constant>
   </setProperty>
   <setProperty name="CamelHwCloudSmnTopic">
      <constant>reji-test</constant>
   </setProperty>
   <setProperty name="CamelHwCloudSmnMessageTtl">
      <constant>60</constant>
   </setProperty>
   <to uri="hwcloud-smn:publishMessageService?operation=publishAsTextMessage&amp;accessKey=*********&amp;secretKey=********&amp;projectId=9071a38e7f6a4ba7b7bcbeb7d4ea6efc&amp;region=cn-north-4" />
</route>

publishAsTemplatedMessage

Java DSL

from("direct:triggerRoute")
.setProperty("CamelHwCloudSmnSubject", constant("This is my subjectline"))
.setProperty("CamelHwCloudSmnTopic", constant("reji-test"))
.setProperty("CamelHwCloudSmnMessageTtl", constant(60))
.setProperty("CamelHwCloudSmnTemplateTags", constant(tags))
.setProperty("CamelHwCloudSmnTemplateName", constant("hello-template"))
.to("hwcloud-smn:publishMessageService?operation=publishAsTemplatedMessage&accessKey=*********&secretKey=********&projectId=9071a38e7f6a4ba7b7bcbeb7d4ea6efc&region=cn-north-4")

Using ServiceKey configuration Bean

Access key and secret keys are required to authenticate against cloud smn service. You can avoid having them being exposed and scattered over in your endpoint uri by wrapping them inside a bean of class org.apache.camel.component.huaweicloud.smn.models.ServiceKeys. Add it to the registry and let camel look it up by referring the object via endpoint query parameter serviceKeys. Check the following code snippets

<bean id="myServiceKeyConfig" class="org.apache.camel.component.huaweicloud.smn.models.ServiceKeys">
   <property name="accessKey" value="your_access_key" />
   <property name="secretKey" value="your_secret_key" />
</bean>

from("direct:triggerRoute")
 .setProperty(SmnProperties.NOTIFICATION_SUBJECT, constant("Notification Subject"))
 .setProperty(SmnProperties.NOTIFICATION_TOPIC_NAME,constant(testConfiguration.getProperty("topic")))
 .setProperty(SmnProperties.NOTIFICATION_TTL, constant(60))
 .to("hwcloud-smn:publishMessageService?operation=publishAsTextMessage&projectId=9071a38e7f6a4ba7b7bcbeb7d4ea6efc&region=cn-north-4&serviceKeys=#myServiceKeyConfig")

Spring Boot Auto-Configuration

When using hwcloud-smn with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-huaweicloud-smn-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 3 options, which are listed below.

Name	Description	Default	Type
camel.component.hwcloud-smn.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.hwcloud-smn.enabled	Whether to enable auto configuration of the hwcloud-smn component. This is enabled by default.		Boolean
camel.component.hwcloud-smn.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean

Name

Description

Default

Type

camel.component.hwcloud-smn.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.hwcloud-smn.enabled

Whether to enable auto configuration of the hwcloud-smn component. This is enabled by default.

Boolean

camel.component.hwcloud-smn.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean