mathewsreji commented on a change in pull request #4900: URL: https://github.com/apache/camel/pull/4900#discussion_r565024654
########## File path: components/camel-huaweicloud-smn/src/main/java/org/apache/camel/component/huaweicloud/smn/SimpleNotificationProducer.java ########## @@ -0,0 +1,366 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.huaweicloud.smn; + +import java.util.HashMap; + +import com.huaweicloud.sdk.core.auth.BasicCredentials; +import com.huaweicloud.sdk.core.http.HttpConfig; +import com.huaweicloud.sdk.smn.v2.SmnClient; +import com.huaweicloud.sdk.smn.v2.model.PublishMessageRequest; +import com.huaweicloud.sdk.smn.v2.model.PublishMessageRequestBody; +import com.huaweicloud.sdk.smn.v2.model.PublishMessageResponse; +import org.apache.camel.Exchange; +import org.apache.camel.component.huaweicloud.smn.constants.SmnConstants; +import org.apache.camel.component.huaweicloud.smn.constants.SmnOperations; +import org.apache.camel.component.huaweicloud.smn.constants.SmnServices; +import org.apache.camel.component.huaweicloud.smn.models.ClientConfigurations; +import org.apache.camel.support.DefaultProducer; +import org.apache.camel.util.ObjectHelper; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class SimpleNotificationProducer extends DefaultProducer { + private static final Logger LOG = LoggerFactory.getLogger(SimpleNotificationProducer.class); + private SimpleNotificationEndpoint simpleNotificationEndpoint; + private SmnClient smnClient; + private ClientConfigurations clientConfigurations; + + public SimpleNotificationProducer(SimpleNotificationEndpoint endpoint) { + super(endpoint); + this.simpleNotificationEndpoint = endpoint; + } + + public void process(Exchange exchange) throws Exception { + + /** + * the produce method is invoked when a message arrives at producer endpoint (lazy init of SmnClient on first + * message) + */ + if (this.smnClient == null) { + if (LOG.isDebugEnabled()) { + LOG.debug("Initializing the SmnClient"); + } + validateAndInitializeSmnClient(simpleNotificationEndpoint); + } + + String service = simpleNotificationEndpoint.getSmnService(); + + if (!ObjectHelper.isEmpty(service)) { + switch (service) { + case SmnServices.PUBLISH_MESSAGE: + if (LOG.isDebugEnabled()) { + LOG.debug("Using message publishing service"); + } + performPublishMessageServiceOperations(simpleNotificationEndpoint, exchange); + if (LOG.isDebugEnabled()) { + LOG.debug("Completed publishing message"); + } + break; + default: + if (LOG.isErrorEnabled()) { + LOG.error("Unsupported service name {}", service); + } + throw new UnsupportedOperationException(String.format("service %s is not a supported service", service)); + } + } else { + if (LOG.isErrorEnabled()) { + LOG.error("Service name is null/empty"); + } + throw new IllegalStateException("service name cannot be null/empty"); + } + } + + /** + * Publish message service operations + * + * @param endpoint + * @param exchange + */ + private void performPublishMessageServiceOperations(SimpleNotificationEndpoint endpoint, Exchange exchange) { + PublishMessageResponse response; + + PublishMessageRequestBody apiBody; + this.clientConfigurations = validateServiceConfigurations(endpoint, exchange); + + if (LOG.isDebugEnabled()) { + LOG.debug("Checking operation name"); + } + switch (clientConfigurations.getOperation()) { + + case SmnOperations.PUBLISH_AS_TEXT_MESSAGE: + if (LOG.isDebugEnabled()) { + LOG.debug("Publishing as text message"); + } + apiBody = new PublishMessageRequestBody() + .withMessage(exchange.getMessage().getBody(String.class)) + .withSubject(clientConfigurations.getSubject()) + .withTimeToLive(String.valueOf(clientConfigurations.getMessageTtl())); + + response = smnClient.publishMessage(new PublishMessageRequest() + .withBody(apiBody) + .withTopicUrn(clientConfigurations.getTopicUrn())); + break; + + case SmnOperations.PUBLISH_AS_TEMPLATED_MESSAGE: + if (LOG.isDebugEnabled()) { + LOG.debug("Publishing as templated message"); + } + apiBody = new PublishMessageRequestBody() + .withMessage(exchange.getMessage().getBody(String.class)) + .withSubject(clientConfigurations.getSubject()) + .withTimeToLive(String.valueOf(clientConfigurations.getMessageTtl())) + .withMessageTemplateName((String) exchange.getProperty("CamelHwCloudSmnTemplateName")) + .withTags((HashMap<String, String>) exchange.getProperty("CamelHwCloudSmnTemplateTags")) + .withTimeToLive(String.valueOf(clientConfigurations.getMessageTtl())); + + response = smnClient.publishMessage(new PublishMessageRequest() + .withBody(apiBody) + .withTopicUrn(clientConfigurations.getTopicUrn())); + break; + + default: + throw new UnsupportedOperationException( + String.format("operation %s not supported in publishMessage service", + clientConfigurations.getOperation())); + } + setResponseParameters(exchange, response); + } + + /** + * maps api response parameters as exchange property + * + * @param exchange + * @param response + */ + private void setResponseParameters(Exchange exchange, PublishMessageResponse response) { + if (response == null) { + return; // mapping is not required if response object is null + } + if (!ObjectHelper.isEmpty(response.getMessageId())) { + exchange.setProperty("CamelSmnMesssageId", response.getMessageId()); + } + if (!ObjectHelper.isEmpty(response.getRequestId())) { + exchange.setProperty("CamelSmnRequestId", response.getRequestId()); + } + } + + /** + * validation and initialization of SmnClient object + * + * @param simpleNotificationEndpoint + */ + private void validateAndInitializeSmnClient(SimpleNotificationEndpoint simpleNotificationEndpoint) { + this.clientConfigurations = new ClientConfigurations(); + + //checking for cloud SK (secret key) + if (ObjectHelper.isEmpty(simpleNotificationEndpoint.getSecretKey()) && + ObjectHelper.isEmpty(simpleNotificationEndpoint.getServiceKeys())) { + if (LOG.isErrorEnabled()) { + LOG.error("secret key (SK) not found"); + } + throw new IllegalArgumentException("authentication parameter 'secret key (SK)' not found"); + } else { + clientConfigurations.setSecretKey(simpleNotificationEndpoint.getSecretKey() != null + ? simpleNotificationEndpoint.getSecretKey() : simpleNotificationEndpoint.getServiceKeys().getSecretKey()); + } + + //checking for cloud AK (auth key) + if (ObjectHelper.isEmpty(simpleNotificationEndpoint.getAuthKey()) && + ObjectHelper.isEmpty(simpleNotificationEndpoint.getServiceKeys())) { + if (LOG.isErrorEnabled()) { + LOG.error("authentication key (AK) not found"); + } + throw new IllegalArgumentException("authentication parameter 'authentication key (AK)' not found"); + } else { + clientConfigurations.setAuthenticationkey(simpleNotificationEndpoint.getAuthKey() != null + ? simpleNotificationEndpoint.getAuthKey() + : simpleNotificationEndpoint.getServiceKeys().getAuthenticationKey()); + } + + //checking for project ID + if (ObjectHelper.isEmpty(simpleNotificationEndpoint.getProjectId())) { + if (LOG.isErrorEnabled()) { + LOG.error("Project ID not found"); + } + throw new IllegalArgumentException("project ID not found"); + } else { + clientConfigurations.setProjectId(simpleNotificationEndpoint.getProjectId()); + } + + //checking for region + String endpointUrl = SimpleNotificationUtils.resolveSmnServiceEndpoint(simpleNotificationEndpoint.getRegion()); + if (endpointUrl == null) { + if (LOG.isErrorEnabled()) { + LOG.error("Valid region not found"); + } + throw new IllegalArgumentException("enter a valid region"); + } else { + clientConfigurations.setServiceEndpoint(endpointUrl); + } + + //checking for ignore ssl verification + boolean ignoreSslVerification = simpleNotificationEndpoint.isIgnoreSslVerification(); + if (ignoreSslVerification) { + if (LOG.isWarnEnabled()) { + LOG.error("SSL verification is ignored. This is unsafe in production environment"); + } + clientConfigurations.setIgnoreSslVerification(ignoreSslVerification); + } + + //checking if http proxy authentication is used + if (simpleNotificationEndpoint.getProxyHost() != null) { + if (LOG.isDebugEnabled()) { + LOG.debug("Reading http proxy configurations"); + } + clientConfigurations.setProxyHost(simpleNotificationEndpoint.getProxyHost()); + clientConfigurations.setProxyPort(simpleNotificationEndpoint.getProxyPort()); + clientConfigurations.setProxyUser(simpleNotificationEndpoint.getProxyUser()); + clientConfigurations.setProxyPassword(simpleNotificationEndpoint.getProxyPassword()); + } + + this.smnClient = initializeClient(clientConfigurations); + } + + /** + * initialization of smn client. this is lazily initialized on the first message + * + * @param clientConfigurations + * @return + */ + private SmnClient initializeClient(ClientConfigurations clientConfigurations) { + if (LOG.isDebugEnabled()) { + LOG.debug("Initializing Smn client"); + } + HttpConfig httpConfig = null; + + if (clientConfigurations.getProxyHost() != null) { + httpConfig = HttpConfig.getDefaultHttpConfig(); + httpConfig.withProxyHost(clientConfigurations.getProxyHost()) + .withProxyPort(clientConfigurations.getProxyPort()) + .setIgnoreSSLVerification(clientConfigurations.isIgnoreSslVerification()); + + if (clientConfigurations.getProxyUser() != null) { + httpConfig.withProxyUsername(clientConfigurations.getProxyUser()); + httpConfig.withProxyPassword(clientConfigurations.getProxyPassword()); + } + } + + BasicCredentials credentials = new BasicCredentials() + .withAk(clientConfigurations.getAuthenticationkey()) + .withSk(clientConfigurations.getSecretKey()) + .withProjectId(clientConfigurations.getProjectId()); + + if (LOG.isDebugEnabled()) { + LOG.debug("Building Smn client"); + } + + // building smn client object + SmnClient smnClient = SmnClient.newBuilder() + .withCredential(credentials) + .withHttpConfig(httpConfig) + .withEndpoint(clientConfigurations.getServiceEndpoint()) + .build(); + + if (LOG.isDebugEnabled()) { + LOG.debug("Successfully initialized Smn client"); + } + return smnClient; + } + + /** + * validation of all user inputs before attempting to invoke a service operation + * + * @param simpleNotificationEndpoint + * @param exchange + * @return + */ + private ClientConfigurations validateServiceConfigurations( + SimpleNotificationEndpoint simpleNotificationEndpoint, Exchange exchange) { + + if (LOG.isDebugEnabled()) { + LOG.debug("Inspecting exchange body"); + } + // verifying if exchange has valid body content. this is mandatory for 'publish as text' operation + if (ObjectHelper.isEmpty(exchange.getMessage().getBody())) { + if (simpleNotificationEndpoint.getOperation().equals("publishAsTextMessage")) { + if (LOG.isErrorEnabled()) { + LOG.error("Found null/empty body. Cannot perform publish as text operation"); + } + throw new IllegalArgumentException("exchange body cannot be null / empty"); + } + } + + // checking for mandatory field 'operation name' + if (LOG.isDebugEnabled()) { + LOG.debug("Inspecting operation name"); + } + if (ObjectHelper.isEmpty(exchange.getProperty("CamelHwCloudOperation")) + && ObjectHelper.isEmpty(simpleNotificationEndpoint.getOperation())) { + if (LOG.isErrorEnabled()) { + LOG.error("Found null/empty operation name. Cannot proceed with Smn operations"); + } + throw new IllegalArgumentException("operation name not found"); + } else { + clientConfigurations.setOperation(exchange.getProperty("CamelHwCloudOperation") != null Review comment: Moved to SmnProperties class ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
