= Huawei Simple Message Notification (SMN) Component
:doctitle: Huawei Simple Message Notification (SMN)
:shortname: hwcloud-smn
:artifactid: camel-huaweicloud-smn
:description: To broadcast messages and connect cloud services through notifications on Huawei Cloud
:since: 3.8
:supportlevel: Stable
:tabs-sync-option:
:component-header: Only producer is supported
//Manually maintained attributes
:group: Huawei Cloud
:camel-spring-boot-name: huaweicloud-smn

*Since Camel {since}*

*{component-header}*

Huawei Cloud Simple Message Notification (SMN) component allows you to integrate with https://www.huaweicloud.com/intl/en-us/product/smn.html[SMN] provided by Huawei Cloud.

Maven users will need to add the following dependency to their `pom.xml`
for this component:

[source,xml]
------------------------------------------------------------
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-huaweicloud-smn</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>
------------------------------------------------------------

== URI format

To send a notification.

------------------------
hwcloud-smn:service[?options]
------------------------


// component-configure options: START

// component-configure options: END

// component options: START
include::partial$component-configure-options.adoc[]
include::partial$component-endpoint-options.adoc[]
// component options: END

// endpoint options: START

// endpoint options: END


== Usage

=== Message properties evaluated by the SMN producer

[width="100%",cols="10%,10%,80%",options="header",]
|=======================================================================
|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`


|=======================================================================

=== Message properties set by the SMN producer

[width="100%",cols="10%,10%,80%",options="header",]
|=======================================================================
|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

|=======================================================================


=== Supported list of smn services and corresponding operations

[width="100%",cols="50%,50%",options="header",]
|=======================================================================
|Service |Operations

|`publishMessageService` | publishAsTextMessage, publishAsTemplatedMessage|
|=======================================================================


=== Inline Configuration of route

==== publishAsTextMessage
Java DSL
[source,java]
--------------------------------------------------------------------------------
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
[source,xml]
--------------------------------------------------------------------------------
<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
[source,java]
--------------------------------------------------------------------------------
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

[source,xml]
----
<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>
----
[source,java]
--------------------------------------------------------------------------------
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")
--------------------------------------------------------------------------------


include::spring-boot:partial$starter.adoc[]
