From 9cc97bf816e166f8d5c43d4aadee24105a9e317d Mon Sep 17 00:00:00 2001 From: Subodh Ranadive Date: Thu, 4 Mar 2021 14:53:05 +0530 Subject: feature : added support of AWS SNS messaging --- src/main/java/org/traccar/config/Keys.java | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) (limited to 'src/main/java/org/traccar/config/Keys.java') diff --git a/src/main/java/org/traccar/config/Keys.java b/src/main/java/org/traccar/config/Keys.java index 5f8b36c6d..423c6a31b 100644 --- a/src/main/java/org/traccar/config/Keys.java +++ b/src/main/java/org/traccar/config/Keys.java @@ -687,6 +687,36 @@ public final class Keys { "sms.http.template", Collections.singletonList(KeyType.GLOBAL)); + /** + * AWS Access Key with SNS permission. + */ + public static final ConfigKey AWS_ACCESS_KEY = new ConfigKey<>( + "aws.access_key", + Collections.singletonList(KeyType.GLOBAL)); + + /** + * AWS Secret Access Key with SNS permission. + */ + public static final ConfigKey AWS_SECRET_KEY = new ConfigKey<>( + "aws.secret_key", + Collections.singletonList(KeyType.GLOBAL)); + + /** + * SNS Enable switch. + * Use 'enable' to send message with SNS or 'disable' to stop using SNS + */ + public static final ConfigKey AWS_SNS_ENABLED = new ConfigKey<>( + "aws.sns_enabled", + Collections.singletonList(KeyType.GLOBAL)); + + /** + * AWS Region for SNS service. + * Make sure to use regions that are supported for messaging. + */ + public static final ConfigKey AWS_REGION = new ConfigKey<>( + "aws.region", + Collections.singletonList(KeyType.GLOBAL)); + /** * Traccar notification API key. */ -- cgit v1.2.3 From d65f6d379cbda4f9d81ffe36b141bd370085f889 Mon Sep 17 00:00:00 2001 From: Subodh Ranadive Date: Thu, 4 Mar 2021 15:15:46 +0530 Subject: linting fixed --- src/main/java/org/traccar/config/Keys.java | 6 +++--- src/main/java/org/traccar/sms/SnsSmsClient.java | 5 +++-- 2 files changed, 6 insertions(+), 5 deletions(-) (limited to 'src/main/java/org/traccar/config/Keys.java') diff --git a/src/main/java/org/traccar/config/Keys.java b/src/main/java/org/traccar/config/Keys.java index 423c6a31b..937510f10 100644 --- a/src/main/java/org/traccar/config/Keys.java +++ b/src/main/java/org/traccar/config/Keys.java @@ -691,14 +691,14 @@ public final class Keys { * AWS Access Key with SNS permission. */ public static final ConfigKey AWS_ACCESS_KEY = new ConfigKey<>( - "aws.access_key", + "aws.access", Collections.singletonList(KeyType.GLOBAL)); /** * AWS Secret Access Key with SNS permission. */ public static final ConfigKey AWS_SECRET_KEY = new ConfigKey<>( - "aws.secret_key", + "aws.secret", Collections.singletonList(KeyType.GLOBAL)); /** @@ -706,7 +706,7 @@ public final class Keys { * Use 'enable' to send message with SNS or 'disable' to stop using SNS */ public static final ConfigKey AWS_SNS_ENABLED = new ConfigKey<>( - "aws.sns_enabled", + "aws.sns.enabled", Collections.singletonList(KeyType.GLOBAL)); /** diff --git a/src/main/java/org/traccar/sms/SnsSmsClient.java b/src/main/java/org/traccar/sms/SnsSmsClient.java index cacf08811..dcfe5b536 100644 --- a/src/main/java/org/traccar/sms/SnsSmsClient.java +++ b/src/main/java/org/traccar/sms/SnsSmsClient.java @@ -17,7 +17,7 @@ import java.util.HashMap; import java.util.Map; -public class SnsSmsClient implements SmsManager{ +public class SnsSmsClient implements SmsManager { private static final Logger LOGGER = LoggerFactory.getLogger(SnsSmsClient.class); private final String access_key; @@ -57,7 +57,8 @@ public class SnsSmsClient implements SmsManager{ } @java.lang.Override - public void sendMessageSync(String destAddress, String message, boolean command) throws InterruptedException, MessageException { + public void sendMessageSync(String destAddress, String message, boolean command) + throws InterruptedException, MessageException { sendSNSMessage(message, destAddress); } -- cgit v1.2.3 From b98f3333d83795b8034257469e4f34fe46050372 Mon Sep 17 00:00:00 2001 From: Subodh Ranadive Date: Fri, 5 Mar 2021 15:31:32 +0530 Subject: Review resolution --- src/main/java/org/traccar/Context.java | 4 +- src/main/java/org/traccar/config/Keys.java | 8 ++-- src/main/java/org/traccar/sms/SnsSmsClient.java | 50 ++++++++++++++----------- 3 files changed, 34 insertions(+), 28 deletions(-) (limited to 'src/main/java/org/traccar/config/Keys.java') diff --git a/src/main/java/org/traccar/Context.java b/src/main/java/org/traccar/Context.java index 0dce70b93..40340b1f0 100644 --- a/src/main/java/org/traccar/Context.java +++ b/src/main/java/org/traccar/Context.java @@ -318,9 +318,7 @@ public final class Context { if (config.hasKey(Keys.SMS_HTTP_URL)) { smsManager = new HttpSmsClient(); - } - - if (config.hasKey(Keys.AWS_SNS_ENABLED)) { + } else if (config.hasKey(Keys.AWS_SNS_ENABLED)) { smsManager = new SnsSmsClient(); } diff --git a/src/main/java/org/traccar/config/Keys.java b/src/main/java/org/traccar/config/Keys.java index 937510f10..ac105b99c 100644 --- a/src/main/java/org/traccar/config/Keys.java +++ b/src/main/java/org/traccar/config/Keys.java @@ -691,14 +691,14 @@ public final class Keys { * AWS Access Key with SNS permission. */ public static final ConfigKey AWS_ACCESS_KEY = new ConfigKey<>( - "aws.access", + "sms.aws.access", Collections.singletonList(KeyType.GLOBAL)); /** * AWS Secret Access Key with SNS permission. */ public static final ConfigKey AWS_SECRET_KEY = new ConfigKey<>( - "aws.secret", + "sms.aws.secret", Collections.singletonList(KeyType.GLOBAL)); /** @@ -706,7 +706,7 @@ public final class Keys { * Use 'enable' to send message with SNS or 'disable' to stop using SNS */ public static final ConfigKey AWS_SNS_ENABLED = new ConfigKey<>( - "aws.sns.enabled", + "sms.sns.enabled", Collections.singletonList(KeyType.GLOBAL)); /** @@ -714,7 +714,7 @@ public final class Keys { * Make sure to use regions that are supported for messaging. */ public static final ConfigKey AWS_REGION = new ConfigKey<>( - "aws.region", + "sms.aws.region", Collections.singletonList(KeyType.GLOBAL)); /** diff --git a/src/main/java/org/traccar/sms/SnsSmsClient.java b/src/main/java/org/traccar/sms/SnsSmsClient.java index 8ac234605..f8b05b1ce 100644 --- a/src/main/java/org/traccar/sms/SnsSmsClient.java +++ b/src/main/java/org/traccar/sms/SnsSmsClient.java @@ -1,3 +1,18 @@ +/* + * Copyright 2021 Anton Tananaev (anton@traccar.org) + * + * Licensed 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.traccar.sms; import com.amazonaws.auth.AWSStaticCredentialsProvider; @@ -20,29 +35,23 @@ import java.util.Map; public class SnsSmsClient implements SmsManager { private static final Logger LOGGER = LoggerFactory.getLogger(SnsSmsClient.class); - private final String accessKey; - private final String secretKey; - private final String region; - - private final String snsStatus; private final AmazonSNS snsClient; public SnsSmsClient() { - accessKey = Context.getConfig().getString(Keys.AWS_ACCESS_KEY); - secretKey = Context.getConfig().getString(Keys.AWS_SECRET_KEY); - snsStatus = Context.getConfig().getString(Keys.AWS_SNS_ENABLED); - region = Context.getConfig().getString(Keys.AWS_REGION); - snsClient = awsSNSClient(accessKey, secretKey, region); - - if (!snsStatus.equals("true") || accessKey == null || secretKey == null || region == null) { - LOGGER.error("SNS Not Configured Properly. Please provide valid config."); + if (!Context.getConfig().getString(Keys.AWS_SNS_ENABLED).equals("true") || + Context.getConfig().getString(Keys.AWS_ACCESS_KEY) == null || + Context.getConfig().getString(Keys.AWS_SECRET_KEY) == null || + Context.getConfig().getString(Keys.AWS_REGION) == null) { + throw new RuntimeException("SNS Not Configured Properly. Please provide valid config."); } + snsClient = awsSNSClient(); } - public AmazonSNS awsSNSClient(String accessKey, String secretKey, String region) { - BasicAWSCredentials awsCreds = new BasicAWSCredentials(accessKey, secretKey); - return AmazonSNSClientBuilder.standard().withRegion(region) - .withCredentials(new AWSStaticCredentialsProvider(awsCreds)).build(); + public AmazonSNS awsSNSClient() { + BasicAWSCredentials awsCredentials = new BasicAWSCredentials(Context.getConfig().getString(Keys.AWS_ACCESS_KEY), + Context.getConfig().getString(Keys.AWS_SECRET_KEY)); + return AmazonSNSClientBuilder.standard().withRegion(Context.getConfig().getString(Keys.AWS_REGION)) + .withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); } public void sendSNSMessage(String message, String destAddress) { @@ -51,18 +60,17 @@ public class SnsSmsClient implements SmsManager { new MessageAttributeValue().withStringValue("SNS").withDataType("String")); smsAttributes.put("AWS.SNS.SMS.SMSType", new MessageAttributeValue().withStringValue("Transactional").withDataType("String")); - - PublishResult result = this.snsClient.publish(new PublishRequest().withMessage(message) + snsClient.publish(new PublishRequest().withMessage(message) .withPhoneNumber(destAddress).withMessageAttributes(smsAttributes)); } - @java.lang.Override + @Override public void sendMessageSync(String destAddress, String message, boolean command) throws InterruptedException, MessageException { sendSNSMessage(message, destAddress); } - @java.lang.Override + @Override public void sendMessageAsync(String destAddress, String message, boolean command) { sendSNSMessage(message, destAddress); } -- cgit v1.2.3 From d2dc1f983a9b5fc579b24c406587260e726dc35d Mon Sep 17 00:00:00 2001 From: Subodh Ranadive Date: Sun, 7 Mar 2021 09:58:11 +0530 Subject: Minor fixes --- src/main/java/org/traccar/Context.java | 2 +- src/main/java/org/traccar/config/Keys.java | 8 -------- src/main/java/org/traccar/sms/SnsSmsClient.java | 23 ++++++++++++----------- 3 files changed, 13 insertions(+), 20 deletions(-) (limited to 'src/main/java/org/traccar/config/Keys.java') diff --git a/src/main/java/org/traccar/Context.java b/src/main/java/org/traccar/Context.java index 40340b1f0..934006347 100644 --- a/src/main/java/org/traccar/Context.java +++ b/src/main/java/org/traccar/Context.java @@ -318,7 +318,7 @@ public final class Context { if (config.hasKey(Keys.SMS_HTTP_URL)) { smsManager = new HttpSmsClient(); - } else if (config.hasKey(Keys.AWS_SNS_ENABLED)) { + } else if (config.hasKey(Keys.AWS_REGION)) { smsManager = new SnsSmsClient(); } diff --git a/src/main/java/org/traccar/config/Keys.java b/src/main/java/org/traccar/config/Keys.java index ac105b99c..c3dce88c4 100644 --- a/src/main/java/org/traccar/config/Keys.java +++ b/src/main/java/org/traccar/config/Keys.java @@ -701,14 +701,6 @@ public final class Keys { "sms.aws.secret", Collections.singletonList(KeyType.GLOBAL)); - /** - * SNS Enable switch. - * Use 'enable' to send message with SNS or 'disable' to stop using SNS - */ - public static final ConfigKey AWS_SNS_ENABLED = new ConfigKey<>( - "sms.sns.enabled", - Collections.singletonList(KeyType.GLOBAL)); - /** * AWS Region for SNS service. * Make sure to use regions that are supported for messaging. diff --git a/src/main/java/org/traccar/sms/SnsSmsClient.java b/src/main/java/org/traccar/sms/SnsSmsClient.java index d79079f7a..81114e5f5 100644 --- a/src/main/java/org/traccar/sms/SnsSmsClient.java +++ b/src/main/java/org/traccar/sms/SnsSmsClient.java @@ -37,10 +37,9 @@ public class SnsSmsClient implements SmsManager { private final AmazonSNS snsClient; public SnsSmsClient() { - if (!Context.getConfig().getString(Keys.AWS_SNS_ENABLED).equals("true") + if (Context.getConfig().getString(Keys.AWS_REGION) == null || Context.getConfig().getString(Keys.AWS_ACCESS_KEY) == null - || Context.getConfig().getString(Keys.AWS_SECRET_KEY) == null - || Context.getConfig().getString(Keys.AWS_REGION) == null) { + || Context.getConfig().getString(Keys.AWS_SECRET_KEY) == null) { throw new RuntimeException("SNS Not Configured Properly. Please provide valid config."); } snsClient = awsSNSClient(); @@ -53,7 +52,9 @@ public class SnsSmsClient implements SmsManager { .withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); } - public void sendSNSMessage(String message, String destAddress) { + @Override + public void sendMessageSync(String destAddress, String message, boolean command) + throws InterruptedException, MessageException { Map smsAttributes = new HashMap<>(); smsAttributes.put("AWS.SNS.SMS.SenderID", new MessageAttributeValue().withStringValue("SNS").withDataType("String")); @@ -63,14 +64,14 @@ public class SnsSmsClient implements SmsManager { .withPhoneNumber(destAddress).withMessageAttributes(smsAttributes)); } - @Override - public void sendMessageSync(String destAddress, String message, boolean command) - throws InterruptedException, MessageException { - sendSNSMessage(message, destAddress); - } - @Override public void sendMessageAsync(String destAddress, String message, boolean command) { - sendSNSMessage(message, destAddress); + try { + sendMessageSync(destAddress, message, command); + } catch (InterruptedException interruptedException) { + LOGGER.warn("SMS send failed", interruptedException.getMessage()); + } catch (MessageException messageException) { + LOGGER.warn("SMS send failed", messageException.getMessage()); + } } } -- cgit v1.2.3 From 49b8cdc68d4ea2ab2e93e6d9d1622f3e828a7776 Mon Sep 17 00:00:00 2001 From: Subodh Ranadive Date: Thu, 4 Mar 2021 14:53:05 +0530 Subject: feature : added support of AWS SNS messaging --- src/main/java/org/traccar/Context.java | 2 +- src/main/java/org/traccar/config/Keys.java | 6 +++--- src/main/java/org/traccar/sms/SnsSmsClient.java | 17 +++++++++-------- 3 files changed, 13 insertions(+), 12 deletions(-) (limited to 'src/main/java/org/traccar/config/Keys.java') diff --git a/src/main/java/org/traccar/Context.java b/src/main/java/org/traccar/Context.java index 934006347..fe494dabf 100644 --- a/src/main/java/org/traccar/Context.java +++ b/src/main/java/org/traccar/Context.java @@ -318,7 +318,7 @@ public final class Context { if (config.hasKey(Keys.SMS_HTTP_URL)) { smsManager = new HttpSmsClient(); - } else if (config.hasKey(Keys.AWS_REGION)) { + } else if (config.hasKey(Keys.SMS_AWS_REGION)) { smsManager = new SnsSmsClient(); } diff --git a/src/main/java/org/traccar/config/Keys.java b/src/main/java/org/traccar/config/Keys.java index c3dce88c4..d2e5bbd99 100644 --- a/src/main/java/org/traccar/config/Keys.java +++ b/src/main/java/org/traccar/config/Keys.java @@ -690,14 +690,14 @@ public final class Keys { /** * AWS Access Key with SNS permission. */ - public static final ConfigKey AWS_ACCESS_KEY = new ConfigKey<>( + public static final ConfigKey SMS_AWS_ACCESS = new ConfigKey<>( "sms.aws.access", Collections.singletonList(KeyType.GLOBAL)); /** * AWS Secret Access Key with SNS permission. */ - public static final ConfigKey AWS_SECRET_KEY = new ConfigKey<>( + public static final ConfigKey SMS_AWS_SECRET = new ConfigKey<>( "sms.aws.secret", Collections.singletonList(KeyType.GLOBAL)); @@ -705,7 +705,7 @@ public final class Keys { * AWS Region for SNS service. * Make sure to use regions that are supported for messaging. */ - public static final ConfigKey AWS_REGION = new ConfigKey<>( + public static final ConfigKey SMS_AWS_REGION = new ConfigKey<>( "sms.aws.region", Collections.singletonList(KeyType.GLOBAL)); diff --git a/src/main/java/org/traccar/sms/SnsSmsClient.java b/src/main/java/org/traccar/sms/SnsSmsClient.java index 81114e5f5..0c2be0bd2 100644 --- a/src/main/java/org/traccar/sms/SnsSmsClient.java +++ b/src/main/java/org/traccar/sms/SnsSmsClient.java @@ -21,6 +21,7 @@ import com.amazonaws.services.sns.AmazonSNS; import com.amazonaws.services.sns.AmazonSNSClientBuilder; import com.amazonaws.services.sns.model.MessageAttributeValue; import com.amazonaws.services.sns.model.PublishRequest; + import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.traccar.Context; @@ -30,25 +31,25 @@ import org.traccar.notification.MessageException; import java.util.HashMap; import java.util.Map; - public class SnsSmsClient implements SmsManager { private static final Logger LOGGER = LoggerFactory.getLogger(SnsSmsClient.class); private final AmazonSNS snsClient; public SnsSmsClient() { - if (Context.getConfig().getString(Keys.AWS_REGION) == null - || Context.getConfig().getString(Keys.AWS_ACCESS_KEY) == null - || Context.getConfig().getString(Keys.AWS_SECRET_KEY) == null) { + if (Context.getConfig().hasKey(Keys.SMS_AWS_REGION) + && Context.getConfig().hasKey(Keys.SMS_AWS_ACCESS) + && Context.getConfig().hasKey(Keys.SMS_AWS_SECRET)) { + snsClient = awsSNSClient(); + } else { throw new RuntimeException("SNS Not Configured Properly. Please provide valid config."); } - snsClient = awsSNSClient(); } public AmazonSNS awsSNSClient() { - BasicAWSCredentials awsCredentials = new BasicAWSCredentials(Context.getConfig().getString(Keys.AWS_ACCESS_KEY), - Context.getConfig().getString(Keys.AWS_SECRET_KEY)); - return AmazonSNSClientBuilder.standard().withRegion(Context.getConfig().getString(Keys.AWS_REGION)) + BasicAWSCredentials awsCredentials = new BasicAWSCredentials(Context.getConfig().getString(Keys.SMS_AWS_ACCESS), + Context.getConfig().getString(Keys.SMS_AWS_SECRET)); + return AmazonSNSClientBuilder.standard().withRegion(Context.getConfig().getString(Keys.SMS_AWS_REGION)) .withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); } -- cgit v1.2.3 From e290a9f460b5e364aa7cf020aaadc874c5fc282a Mon Sep 17 00:00:00 2001 From: Subodh Ranadive Date: Thu, 4 Mar 2021 15:15:46 +0530 Subject: linting fixed --- src/main/java/org/traccar/config/Keys.java | 20 ++++--- src/main/java/org/traccar/sms/SnsSmsClient.java | 71 +++++++++++-------------- 2 files changed, 45 insertions(+), 46 deletions(-) (limited to 'src/main/java/org/traccar/config/Keys.java') diff --git a/src/main/java/org/traccar/config/Keys.java b/src/main/java/org/traccar/config/Keys.java index d2e5bbd99..937510f10 100644 --- a/src/main/java/org/traccar/config/Keys.java +++ b/src/main/java/org/traccar/config/Keys.java @@ -690,23 +690,31 @@ public final class Keys { /** * AWS Access Key with SNS permission. */ - public static final ConfigKey SMS_AWS_ACCESS = new ConfigKey<>( - "sms.aws.access", + public static final ConfigKey AWS_ACCESS_KEY = new ConfigKey<>( + "aws.access", Collections.singletonList(KeyType.GLOBAL)); /** * AWS Secret Access Key with SNS permission. */ - public static final ConfigKey SMS_AWS_SECRET = new ConfigKey<>( - "sms.aws.secret", + public static final ConfigKey AWS_SECRET_KEY = new ConfigKey<>( + "aws.secret", + Collections.singletonList(KeyType.GLOBAL)); + + /** + * SNS Enable switch. + * Use 'enable' to send message with SNS or 'disable' to stop using SNS + */ + public static final ConfigKey AWS_SNS_ENABLED = new ConfigKey<>( + "aws.sns.enabled", Collections.singletonList(KeyType.GLOBAL)); /** * AWS Region for SNS service. * Make sure to use regions that are supported for messaging. */ - public static final ConfigKey SMS_AWS_REGION = new ConfigKey<>( - "sms.aws.region", + public static final ConfigKey AWS_REGION = new ConfigKey<>( + "aws.region", Collections.singletonList(KeyType.GLOBAL)); /** diff --git a/src/main/java/org/traccar/sms/SnsSmsClient.java b/src/main/java/org/traccar/sms/SnsSmsClient.java index 0c2be0bd2..dcfe5b536 100644 --- a/src/main/java/org/traccar/sms/SnsSmsClient.java +++ b/src/main/java/org/traccar/sms/SnsSmsClient.java @@ -1,18 +1,3 @@ -/* - * Copyright 2021 Anton Tananaev (anton@traccar.org) - * - * Licensed 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.traccar.sms; import com.amazonaws.auth.AWSStaticCredentialsProvider; @@ -21,7 +6,7 @@ import com.amazonaws.services.sns.AmazonSNS; import com.amazonaws.services.sns.AmazonSNSClientBuilder; import com.amazonaws.services.sns.model.MessageAttributeValue; import com.amazonaws.services.sns.model.PublishRequest; - +import com.amazonaws.services.sns.model.PublishResult; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.traccar.Context; @@ -31,48 +16,54 @@ import org.traccar.notification.MessageException; import java.util.HashMap; import java.util.Map; + public class SnsSmsClient implements SmsManager { private static final Logger LOGGER = LoggerFactory.getLogger(SnsSmsClient.class); + private final String access_key; + private final String secret_key; + private final String region; + + private final String sns_status; private final AmazonSNS snsClient; public SnsSmsClient() { - if (Context.getConfig().hasKey(Keys.SMS_AWS_REGION) - && Context.getConfig().hasKey(Keys.SMS_AWS_ACCESS) - && Context.getConfig().hasKey(Keys.SMS_AWS_SECRET)) { - snsClient = awsSNSClient(); - } else { - throw new RuntimeException("SNS Not Configured Properly. Please provide valid config."); + access_key = Context.getConfig().getString(Keys.AWS_ACCESS_KEY); + secret_key = Context.getConfig().getString(Keys.AWS_SECRET_KEY); + sns_status = Context.getConfig().getString(Keys.AWS_SNS_ENABLED); + region = Context.getConfig().getString(Keys.AWS_REGION); + snsClient = awsSNSClient(access_key, secret_key, region); + + if (!sns_status.equals("true") || access_key == null || secret_key == null || region == null) { + LOGGER.error("SNS Not Configured Properly. Please provide valid config."); } } - public AmazonSNS awsSNSClient() { - BasicAWSCredentials awsCredentials = new BasicAWSCredentials(Context.getConfig().getString(Keys.SMS_AWS_ACCESS), - Context.getConfig().getString(Keys.SMS_AWS_SECRET)); - return AmazonSNSClientBuilder.standard().withRegion(Context.getConfig().getString(Keys.SMS_AWS_REGION)) - .withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); + public AmazonSNS awsSNSClient(String access_key, String secret_key, String region) { + BasicAWSCredentials awsCreds = new BasicAWSCredentials(access_key, secret_key); + return AmazonSNSClientBuilder.standard().withRegion(region) + .withCredentials(new AWSStaticCredentialsProvider(awsCreds)).build(); } - @Override - public void sendMessageSync(String destAddress, String message, boolean command) - throws InterruptedException, MessageException { + public void sendSNSMessage(String message, String destAddress) { Map smsAttributes = new HashMap<>(); smsAttributes.put("AWS.SNS.SMS.SenderID", - new MessageAttributeValue().withStringValue("SNS").withDataType("String")); + new MessageAttributeValue().withStringValue("VegitOne").withDataType("String")); smsAttributes.put("AWS.SNS.SMS.SMSType", new MessageAttributeValue().withStringValue("Transactional").withDataType("String")); - snsClient.publish(new PublishRequest().withMessage(message) + + PublishResult result = this.snsClient.publish(new PublishRequest().withMessage(message) .withPhoneNumber(destAddress).withMessageAttributes(smsAttributes)); } - @Override + @java.lang.Override + public void sendMessageSync(String destAddress, String message, boolean command) + throws InterruptedException, MessageException { + sendSNSMessage(message, destAddress); + } + + @java.lang.Override public void sendMessageAsync(String destAddress, String message, boolean command) { - try { - sendMessageSync(destAddress, message, command); - } catch (InterruptedException interruptedException) { - LOGGER.warn("SMS send failed", interruptedException.getMessage()); - } catch (MessageException messageException) { - LOGGER.warn("SMS send failed", messageException.getMessage()); - } + sendSNSMessage(message, destAddress); } } -- cgit v1.2.3 From cab0b9d1e4dab5d17259cd33fd85fa2f0462a961 Mon Sep 17 00:00:00 2001 From: Subodh Ranadive Date: Fri, 5 Mar 2021 15:31:32 +0530 Subject: Review resolution --- src/main/java/org/traccar/config/Keys.java | 20 +++---- src/main/java/org/traccar/sms/SnsSmsClient.java | 69 ++++++++++++++----------- 2 files changed, 45 insertions(+), 44 deletions(-) (limited to 'src/main/java/org/traccar/config/Keys.java') diff --git a/src/main/java/org/traccar/config/Keys.java b/src/main/java/org/traccar/config/Keys.java index 937510f10..d2e5bbd99 100644 --- a/src/main/java/org/traccar/config/Keys.java +++ b/src/main/java/org/traccar/config/Keys.java @@ -690,31 +690,23 @@ public final class Keys { /** * AWS Access Key with SNS permission. */ - public static final ConfigKey AWS_ACCESS_KEY = new ConfigKey<>( - "aws.access", + public static final ConfigKey SMS_AWS_ACCESS = new ConfigKey<>( + "sms.aws.access", Collections.singletonList(KeyType.GLOBAL)); /** * AWS Secret Access Key with SNS permission. */ - public static final ConfigKey AWS_SECRET_KEY = new ConfigKey<>( - "aws.secret", - Collections.singletonList(KeyType.GLOBAL)); - - /** - * SNS Enable switch. - * Use 'enable' to send message with SNS or 'disable' to stop using SNS - */ - public static final ConfigKey AWS_SNS_ENABLED = new ConfigKey<>( - "aws.sns.enabled", + public static final ConfigKey SMS_AWS_SECRET = new ConfigKey<>( + "sms.aws.secret", Collections.singletonList(KeyType.GLOBAL)); /** * AWS Region for SNS service. * Make sure to use regions that are supported for messaging. */ - public static final ConfigKey AWS_REGION = new ConfigKey<>( - "aws.region", + public static final ConfigKey SMS_AWS_REGION = new ConfigKey<>( + "sms.aws.region", Collections.singletonList(KeyType.GLOBAL)); /** diff --git a/src/main/java/org/traccar/sms/SnsSmsClient.java b/src/main/java/org/traccar/sms/SnsSmsClient.java index 8ac234605..0c2be0bd2 100644 --- a/src/main/java/org/traccar/sms/SnsSmsClient.java +++ b/src/main/java/org/traccar/sms/SnsSmsClient.java @@ -1,3 +1,18 @@ +/* + * Copyright 2021 Anton Tananaev (anton@traccar.org) + * + * Licensed 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.traccar.sms; import com.amazonaws.auth.AWSStaticCredentialsProvider; @@ -6,7 +21,7 @@ import com.amazonaws.services.sns.AmazonSNS; import com.amazonaws.services.sns.AmazonSNSClientBuilder; import com.amazonaws.services.sns.model.MessageAttributeValue; import com.amazonaws.services.sns.model.PublishRequest; -import com.amazonaws.services.sns.model.PublishResult; + import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.traccar.Context; @@ -16,54 +31,48 @@ import org.traccar.notification.MessageException; import java.util.HashMap; import java.util.Map; - public class SnsSmsClient implements SmsManager { private static final Logger LOGGER = LoggerFactory.getLogger(SnsSmsClient.class); - private final String accessKey; - private final String secretKey; - private final String region; - - private final String snsStatus; private final AmazonSNS snsClient; public SnsSmsClient() { - accessKey = Context.getConfig().getString(Keys.AWS_ACCESS_KEY); - secretKey = Context.getConfig().getString(Keys.AWS_SECRET_KEY); - snsStatus = Context.getConfig().getString(Keys.AWS_SNS_ENABLED); - region = Context.getConfig().getString(Keys.AWS_REGION); - snsClient = awsSNSClient(accessKey, secretKey, region); - - if (!snsStatus.equals("true") || accessKey == null || secretKey == null || region == null) { - LOGGER.error("SNS Not Configured Properly. Please provide valid config."); + if (Context.getConfig().hasKey(Keys.SMS_AWS_REGION) + && Context.getConfig().hasKey(Keys.SMS_AWS_ACCESS) + && Context.getConfig().hasKey(Keys.SMS_AWS_SECRET)) { + snsClient = awsSNSClient(); + } else { + throw new RuntimeException("SNS Not Configured Properly. Please provide valid config."); } } - public AmazonSNS awsSNSClient(String accessKey, String secretKey, String region) { - BasicAWSCredentials awsCreds = new BasicAWSCredentials(accessKey, secretKey); - return AmazonSNSClientBuilder.standard().withRegion(region) - .withCredentials(new AWSStaticCredentialsProvider(awsCreds)).build(); + public AmazonSNS awsSNSClient() { + BasicAWSCredentials awsCredentials = new BasicAWSCredentials(Context.getConfig().getString(Keys.SMS_AWS_ACCESS), + Context.getConfig().getString(Keys.SMS_AWS_SECRET)); + return AmazonSNSClientBuilder.standard().withRegion(Context.getConfig().getString(Keys.SMS_AWS_REGION)) + .withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); } - public void sendSNSMessage(String message, String destAddress) { + @Override + public void sendMessageSync(String destAddress, String message, boolean command) + throws InterruptedException, MessageException { Map smsAttributes = new HashMap<>(); smsAttributes.put("AWS.SNS.SMS.SenderID", new MessageAttributeValue().withStringValue("SNS").withDataType("String")); smsAttributes.put("AWS.SNS.SMS.SMSType", new MessageAttributeValue().withStringValue("Transactional").withDataType("String")); - - PublishResult result = this.snsClient.publish(new PublishRequest().withMessage(message) + snsClient.publish(new PublishRequest().withMessage(message) .withPhoneNumber(destAddress).withMessageAttributes(smsAttributes)); } - @java.lang.Override - public void sendMessageSync(String destAddress, String message, boolean command) - throws InterruptedException, MessageException { - sendSNSMessage(message, destAddress); - } - - @java.lang.Override + @Override public void sendMessageAsync(String destAddress, String message, boolean command) { - sendSNSMessage(message, destAddress); + try { + sendMessageSync(destAddress, message, command); + } catch (InterruptedException interruptedException) { + LOGGER.warn("SMS send failed", interruptedException.getMessage()); + } catch (MessageException messageException) { + LOGGER.warn("SMS send failed", messageException.getMessage()); + } } } -- cgit v1.2.3