[[hwcloud-smn-component]]
= Huawei Cloud Simple Message Notification (SMN) Component
:docTitle: Huawei Cloud 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
: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.

[source,java]
------------------------
hwcloud-smn:service[?options]
------------------------


== Options

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



[width="100%",cols="2,5,^1,2",options="header"]
|===
| 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
|===
// component options: END

// endpoint options: START
The Huawei Cloud Simple Message Notification (SMN) endpoint is configured using URI syntax:

----
hwcloud-smn:smnService
----

with the following path and query parameters:

=== Path Parameters (1 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *smnService* | *Required* Name of SMN service to invoke |  | String
|===


=== Query Parameters (14 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *authKey* (producer) | *Required* Authentication 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
| *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
| *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
|===
// 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&authKey=*********&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;authKey=*********&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&authKey=*********&secretKey=********&projectId=9071a38e7f6a4ba7b7bcbeb7d4ea6efc&region=cn-north-4")
--------------------------------------------------------------------------------

== Using ServiceKey configuration Bean
Authentication 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="authenticationKey" value="your_auth_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[]
