DefaultCloudhopperConfigurer.java

1 
package fr.sii.ogham.sms.builder.cloudhopper;
2
3 
import static fr.sii.ogham.core.builder.configuration.MayOverride.overrideIfNotSet;
4 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_AUTO_DATA_CODING_SCHEME_ENABLED;
5 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_AUTO_GUESS_ENABLED;
6 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_BIND_TIMEOUT;
7 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_BIND_TYPE;
8 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_CHARSET;
9 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_CLOUDHOPPER_CONFIGURER_PRIORITY;
10 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_CONNECT_MAX_RETRIES;
11 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_CONNECT_RETRY_DELAY;
12 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_CONNECT_TIMEOUT;
13 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_ENQUIRE_LINK_INTERVAL;
14 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_ENQUIRE_LINK_RESPONSE_TIMEOUT;
15 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_ENQUIRE_LINK_REUSE_RESPONSE_TIMEOUT;
16 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_GSM7BIT_PACKED_ENCODING_PRIORITY;
17 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_GSM8_ENCODING_PRIORITY;
18 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_INTERFACE_VERSION;
19 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_KEEP_ALIVE_CONNECT_AT_STARTUP;
20 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_KEEP_ALIVE_ENABLED;
21 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_KEEP_ALIVE_MAX_CONSECUTIVE_TIMEOUTS;
22 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_LAST_INTERACTION_EXPIRATION_DELAY;
23 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_LATIN1_ENCODING_PRIORITY;
24 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_REQUEST_EXPIRY_TIMEOUT;
25 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_RESPONSE_TIMEOUT;
26 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_REUSE_SESSION_ENABLED;
27 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_SMPP_PORT;
28 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_SPLIT_ENABLED;
29 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_UCS2_ENCODING_PRIORITY;
30 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_UNBIND_TIMEOUT;
31 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_USE_SHORT_MESSAGE;
32 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_USE_TLV_MESSAGE_PAYLOAD;
33 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_WINDOW_MONITOR_INTERVAL;
34 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_WINDOW_SIZE;
35 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_WINDOW_WAIT_TIMEOUT;
36 
import static fr.sii.ogham.sms.CloudhopperConstants.DEFAULT_WRITE_TIMEOUT;
37 
import static fr.sii.ogham.sms.builder.cloudhopper.CloudhopperRetryablePredicates.canResendMessage;
38 
import static fr.sii.ogham.sms.builder.cloudhopper.CloudhopperRetryablePredicates.canRetryConnecting;
39
40 
import fr.sii.ogham.core.exception.configurer.ConfigureException;
41 
import fr.sii.ogham.core.exception.configurer.MissingImplementationException;
42 
import org.slf4j.Logger;
43 
import org.slf4j.LoggerFactory;
44
45 
import fr.sii.ogham.core.builder.MessagingBuilder;
46 
import fr.sii.ogham.core.builder.configurer.ConfigurerFor;
47 
import fr.sii.ogham.core.builder.configurer.MessagingConfigurer;
48 
import fr.sii.ogham.core.builder.context.BuildContext;
49 
import fr.sii.ogham.core.util.ClasspathUtils;
50 
import fr.sii.ogham.sms.splitter.GsmMessageSplitter;
51
52 
/**
53 
 * Default configurer for Cloudhoppder that is automatically applied every time
54 
 * a {@link MessagingBuilder} instance is created through
55 
 * {@link MessagingBuilder#standard()}.
56 
 *
57 
 * <p>
58 
 * The configurer has a priority of 40000 in order to be applied after
59 
 * templating configurers.
60 
 * </p>
61 
 *
62 
 * This configurer is applied only if {@code com.cloudhopper.smpp.SmppClient} is
63 
 * present in the classpath. If not present, Cloudhopper implementation is not
64 
 * registered at all.
65 
 *
66 
 * <p>
67 
 * This configurer inherits environment configuration (see
68 
 * {@link BuildContext}).
69 
 * </p>
70 
 *
71 
 * <p>
72 
 * This configurer applies the following configuration:
73 
 * <ul>
74 
 * <li>Configures SMPP protocol:
75 
 * <ul>
76 
 * <li>It uses one of "ogham.sms.cloudhopper.host" or "ogham.sms.smpp.host"
77 
 * property if defined for SMPP server host address (IP or hostname)</li>
78 
 * <li>It uses one of "ogham.sms.cloudhopper.port" or "ogham.sms.smpp.port"
79 
 * property if defined for SMPP server port. Default port is 25</li>
80 
 * <li>It uses "ogham.sms.cloudhopper.interface-version" property if defined for
81 
 * the version of the protocol. Default is "3.4"</li>
82 
 * </ul>
83 
 * </li>
84 
 * <li>Configures authentication:
85 
 * <ul>
86 
 * <li>It uses one of "ogham.sms.cloudhopper.system-id" or
87 
 * "ogham.sms.smpp.system-id" property if defined for to identify an ESME (
88 
 * External Short Message Entity) or an SMSC (Short Message Service Centre) at
89 
 * bind time</li>
90 
 * <li>It uses one of "ogham.sms.cloudhopper.password" or
91 
 * "ogham.sms.smpp.password" property if defined for an optional password</li>
92 
 * </ul>
93 
 * </li>
94 
 * <li>Configures text message encoding:
95 
 * <ul>
96 
 * <li>It enables <a href="https://en.wikipedia.org/wiki/GSM_03.38">GSM
97 
 * 03.38</a> encoding support. It automatically guess the supported encoding in
98 
 * order to use the minimum octets for the text message:
99 
 * <ul>
100 
 * <li>It can encode using GSM 7-bit default alphabet if the message contains
101 
 * only characters defined in the table. Message is packed so the message can
102 
 * have a maximum length of 160 characters instead of 140.<br>
103 
 * It uses one of "ogham.sms.cloudhopper.encoder.gsm7bit-packed.priority" or
104 
 * "ogham.sms.encoder.gsm7bit-packed.priority" to set priority of GSM 7-bit
105 
 * encoding.<br>
106 
 * Default priority is set to 0 (disabled by default because most of providers
107 
 * don't support it).</li>
108 
 * <li>It encodes using GSM 8-bit data encoding if the message contains only
109 
 * characters that can be encoded on one octet.<br>
110 
 * It uses one of "ogham.sms.cloudhopper.encoder.gsm8bit.priority" or
111 
 * "ogham.sms.encoder.gsm8bit.priority" to set priority of GSM 8-bit
112 
 * encoding.<br>
113 
 * Default priority is set to 99000.</li>
114 
 * <li>It encodes using UCS-2 encoding if the message contains special
115 
 * characters (Unicode characters) that can't be encoded on one octet. Each
116 
 * character is encoded on two octets.<br>
117 
 * It uses one of "ogham.sms.cloudhopper.encoder.ucs2.priority" or
118 
 * "ogham.sms.encoder.ucs2.priority" to set priority of GSM 8-bit encoding.<br>
119 
 * Default priority is set to 98000.</li>
120 
 * </ul>
121 
 * </li>
122 
 * <li>If for any reason the message can't be encoded with standard encoding or
123 
 * auto-guess is disabled, the default behavior is used:
124 
 * <ul>
125 
 * <li>It uses "ogham.sms.cloudhopper.encoder.default-charset" property to
126 
 * encode messages using "GSM" (8-bit) charset</li>
127 
 * </ul>
128 
 * </li>
129 
 * </ul>
130 
 * </li>
131 
 * <li>Configures message splitting:
132 
 * <ul>
133 
 * <li>Uses {@link GsmMessageSplitter} to split messages according to encoding:
134 
 * <ul>
135 
 * <li>If message is encoded using GSM 7-bit alphabet (7 bits per character),
136 
 * one message of 160 characters can fit in a single segment of 140 octets (160
137 
 * characters * 7 / 8). If the message is over 160 characters, the message is
138 
 * split in 140 octet segments including a 6 octet header meaning that each
139 
 * segment can transport 153 characters ((140 - 6) * 8 / 7) and a partial
140 
 * character (remaining octet).</li>
141 
 * <li>If message is encoded using GSM 8-bit alphabet (1 octet per character),
142 
 * one message of 140 characters can fit in a single segment of 140 octets. If
143 
 * the message is over 140 characters, the message is split in 140 octet
144 
 * segments including a 6 octet header meaning that each segment can transport
145 
 * 134 characters (140 - 6).</li>
146 
 * <li>If message is encoded using UCS-2 alphabet (2 octets per character), one
147 
 * message of 70 characters can fit in a single segment of 140 octets (70
148 
 * characters * 2). If the message is over 70 characters, the message is split
149 
 * in 140 octet segments including a 6 octet header meaning that each segment
150 
 * can transport 67 characters ((140 - 6) / 2).</li>
151 
 * </ul>
152 
 * </li>
153 
 * </ul>
154 
 * </li>
155 
 * <li>Configures session management:
156 
 * <ul>
157 
 * <li>Timeouts through properties</li>
158 
 * <li>The window management through properties</li>
159 
 * <li>The connection retry handling through properties</li>
160 
 * </ul>
161 
 * </li>
162 
 * </ul>
163 
 *
164 
 * @author Aurélien Baudet
165 
 *
166 
 */
167 
public final class DefaultCloudhopperConfigurer {
168 
	private static final Logger LOG = LoggerFactory.getLogger(DefaultCloudhopperConfigurer.class);
169
170 
	@ConfigurerFor(targetedBuilder = "standard", priority = DEFAULT_CLOUDHOPPER_CONFIGURER_PRIORITY)
171 
	public static class CloudhopperConfigurer implements MessagingConfigurer {
172 
		@Override
173 
		public void configure(MessagingBuilder msgBuilder) throws ConfigureException {
174 1 1. configure : removed call to fr/sii/ogham/sms/builder/cloudhopper/DefaultCloudhopperConfigurer$CloudhopperConfigurer::checkCanUseCloudhopper → RUN_ERROR
 
			checkCanUseCloudhopper();
175
176 
			// add additional checks to indicate that a message should not be
177 
			// retried in some circumstances
178 
			msgBuilder.sms().autoRetry().retryable(canResendMessage()::and);
179 
			// configure message sender
180 
			CloudhopperBuilder builder = msgBuilder.sms().sender(CloudhopperBuilder.class);
181 
			// @formatter:off
182 
			builder
183 
				.systemId().properties("${ogham.sms.cloudhopper.system-id}", "${ogham.sms.smpp.system-id}").and()
184 
				.password().properties("${ogham.sms.cloudhopper.password}", "${ogham.sms.smpp.password}").and()
185 
				.host().properties("${ogham.sms.cloudhopper.host}", "${ogham.sms.smpp.host}").and()
186 
				.port().properties("${ogham.sms.cloudhopper.port}", "${ogham.sms.smpp.port}").defaultValue(overrideIfNotSet(DEFAULT_SMPP_PORT)).and()
187 
				.bindType().properties("${ogham.sms.cloudhopper.bind-type}", "${ogham.sms.smpp.bind-type}").defaultValue(overrideIfNotSet(DEFAULT_BIND_TYPE)).and()
188 
				.systemType().properties("${ogham.sms.cloudhopper.system-type}", "${ogham.sms.smpp.system-type}").and()
189 
				.interfaceVersion().properties("${ogham.sms.cloudhopper.interface-version}").defaultValue(overrideIfNotSet(DEFAULT_INTERFACE_VERSION)).and()
190 
				.userData()
191 
					.useShortMessage().properties("${ogham.sms.cloudhopper.user-data.use-short-message}", "${ogham.sms.smpp.user-data.use-short-message}").defaultValue(overrideIfNotSet(DEFAULT_USE_SHORT_MESSAGE)).and()
192 
					.useTlvMessagePayload().properties("${ogham.sms.cloudhopper.user-data.use-tlv-message-payload}", "${ogham.sms.smpp.user-data.use-tlv-message-payload}").defaultValue(overrideIfNotSet(DEFAULT_USE_TLV_MESSAGE_PAYLOAD)).and()
193 
					.and()
194 
				.encoder()
195 
					// packed algorithm disabled by default because it is not supported by most of providers
196 
					.gsm7bitPacked().properties("${ogham.sms.cloudhopper.encoder.gsm7bit-packed.priority}", "${ogham.sms.smpp.encoder.gsm7bit-packed.priority}").defaultValue(overrideIfNotSet(DEFAULT_GSM7BIT_PACKED_ENCODING_PRIORITY)).and()
197 
					.gsm8bit().properties("${ogham.sms.cloudhopper.encoder.gsm8bit.priority}", "${ogham.sms.smpp.encoder.gsm8bit.priority}").defaultValue(overrideIfNotSet(DEFAULT_GSM8_ENCODING_PRIORITY)).and()
198 
					.latin1().properties("${ogham.sms.cloudhopper.encoder.latin1.priority}", "${ogham.sms.smpp.encoder.latin1.priority}").defaultValue(overrideIfNotSet(DEFAULT_LATIN1_ENCODING_PRIORITY)).and()
199 
					.ucs2().properties("${ogham.sms.cloudhopper.encoder.ucs2.priority}", "${ogham.sms.smpp.encoder.ucs2.priority}").defaultValue(overrideIfNotSet(DEFAULT_UCS2_ENCODING_PRIORITY)).and()
200 
					.autoGuess().properties("${ogham.sms.cloudhopper.encoder.auto-guess.enable}", "${ogham.sms.smpp.encoder.auto-guess.enable}").defaultValue(overrideIfNotSet(DEFAULT_AUTO_GUESS_ENABLED)).and()
201 
					.fallback().properties("${ogham.sms.cloudhopper.encoder.default-charset}", "${ogham.sms.smpp.encoder.default-charset}").defaultValue(overrideIfNotSet(DEFAULT_CHARSET)).and()
202 
					.and()
203 
				.splitter()
204 
					.enable().properties("${ogham.sms.cloudhopper.split.enable}", "${ogham.sms.smpp.split.enable}", "${ogham.sms.split.enable}").defaultValue(overrideIfNotSet(DEFAULT_SPLIT_ENABLED)).and()
205 
					.referenceNumber()
206 
						.random()
207 
						.and()
208 
					.and()
209 
				.dataCodingScheme()
210 
					.auto().properties("${ogham.sms.cloudhopper.data-coding-scheme.auto.enable}", "${ogham.sms.smpp.data-coding-scheme.auto.enable}").defaultValue(overrideIfNotSet(DEFAULT_AUTO_DATA_CODING_SCHEME_ENABLED)).and()
211 
					.value().properties("${ogham.sms.cloudhopper.data-coding-scheme.value}", "${ogham.sms.smpp.data-coding-scheme.value}").and()
212 
					.and()
213 
				.session()
214 
					.sessionName().properties("${ogham.sms.cloudhopper.session.name}").and()
215 
					.bindTimeout().properties("${ogham.sms.cloudhopper.session.bind-timeout}").defaultValue(overrideIfNotSet(DEFAULT_BIND_TIMEOUT)).and()
216 
					.connectTimeout().properties("${ogham.sms.cloudhopper.session.connect-timeout}").defaultValue(overrideIfNotSet(DEFAULT_CONNECT_TIMEOUT)).and()
217 
					.requestExpiryTimeout().properties("${ogham.sms.cloudhopper.session.request-expiry-timeout}").defaultValue(overrideIfNotSet(DEFAULT_REQUEST_EXPIRY_TIMEOUT)).and()
218 
					.windowMonitorInterval().properties("${ogham.sms.cloudhopper.session.window-monitor-interval}").defaultValue(overrideIfNotSet(DEFAULT_WINDOW_MONITOR_INTERVAL)).and()
219 
					.windowSize().properties("${ogham.sms.cloudhopper.session.window-size}").defaultValue(overrideIfNotSet(DEFAULT_WINDOW_SIZE)).and()
220 
					.windowWait().properties("${ogham.sms.cloudhopper.session.window-wait-timeout}").defaultValue(overrideIfNotSet(DEFAULT_WINDOW_WAIT_TIMEOUT)).and()
221 
					.writeTimeout().properties("${ogham.sms.cloudhopper.session.write-timeout}").defaultValue(overrideIfNotSet(DEFAULT_WRITE_TIMEOUT)).and()
222 
					.responseTimeout().properties("${ogham.sms.cloudhopper.session.response-timeout}").defaultValue(overrideIfNotSet(DEFAULT_RESPONSE_TIMEOUT)).and()
223 
					.unbindTimeout().properties("${ogham.sms.cloudhopper.session.unbind-timeout}").defaultValue(overrideIfNotSet(DEFAULT_UNBIND_TIMEOUT)).and()
224 
					.reuseSession()
225 
						.enable().properties("${ogham.sms.cloudhopper.session.reuse-session.enable}").defaultValue(overrideIfNotSet(DEFAULT_REUSE_SESSION_ENABLED)).and()
226 
						.lastInteractionExpiration().properties("${ogham.sms.cloudhopper.session.reuse-session.last-interaction-expiration-delay}").defaultValue(overrideIfNotSet(DEFAULT_LAST_INTERACTION_EXPIRATION_DELAY)).and()
227 
						.responseTimeout().properties("${ogham.sms.cloudhopper.session.reuse-session.response-timeout}").defaultValue(overrideIfNotSet(DEFAULT_ENQUIRE_LINK_REUSE_RESPONSE_TIMEOUT)).and()
228 
						.and()
229 
					.keepAlive()
230 
						.enable().properties("${ogham.sms.cloudhopper.session.keep-alive.enable}").defaultValue(overrideIfNotSet(DEFAULT_KEEP_ALIVE_ENABLED)).and()
231 
						.interval().properties("${ogham.sms.cloudhopper.session.keep-alive.request-interval}").defaultValue(overrideIfNotSet(DEFAULT_ENQUIRE_LINK_INTERVAL)).and()
232 
						.responseTimeout().properties("${ogham.sms.cloudhopper.session.keep-alive.response-timeout}").defaultValue(overrideIfNotSet(DEFAULT_ENQUIRE_LINK_RESPONSE_TIMEOUT)).and()
233 
						.connectAtStartup().properties("${ogham.sms.cloudhopper.session.keep-alive.connect-at-startup}").defaultValue(overrideIfNotSet(DEFAULT_KEEP_ALIVE_CONNECT_AT_STARTUP)).and()
234 
						.maxConsecutiveTimeouts().properties("${ogham.sms.cloudhopper.session.keep-alive.max-consecutive-timeouts}").defaultValue(overrideIfNotSet(DEFAULT_KEEP_ALIVE_MAX_CONSECUTIVE_TIMEOUTS)).and()
235 
						.and()
236 
					.connectRetry()
237 
						.retryable(canRetryConnecting())
238 
						.fixedDelay()
239 
							.maxRetries().properties("${ogham.sms.cloudhopper.session.connect-retry.max-attempts}").defaultValue(overrideIfNotSet(DEFAULT_CONNECT_MAX_RETRIES)).and()
240 
							.delay().properties("${ogham.sms.cloudhopper.session.connect-retry.delay-between-attempts}").defaultValue(overrideIfNotSet(DEFAULT_CONNECT_RETRY_DELAY)).and()
241 
							.and()
242 
						.exponentialDelay()
243 
							.maxRetries().properties("${ogham.sms.cloudhopper.session.connect-retry.max-attempts}").defaultValue(overrideIfNotSet(DEFAULT_CONNECT_MAX_RETRIES)).and()
244 
							.initialDelay().properties("${ogham.sms.cloudhopper.session.connect-retry.exponential-initial-delay}").and()
245 
							.and()
246 
						.perExecutionDelay()
247 
							.maxRetries().properties("${ogham.sms.cloudhopper.session.connect-retry.max-attempts}").defaultValue(overrideIfNotSet(DEFAULT_CONNECT_MAX_RETRIES)).and()
248 
							.delays().properties("${ogham.sms.cloudhopper.session.connect-retry.per-execution-delays}").and()
249 
							.and()
250 
						.fixedInterval()
251 
							.maxRetries().properties("${ogham.sms.cloudhopper.session.connect-retry.max-attempts}").defaultValue(overrideIfNotSet(DEFAULT_CONNECT_MAX_RETRIES)).and()
252 
							.interval().properties("${ogham.sms.cloudhopper.session.connect-retry.execution-interval}");
253 
			// @formatter:on
254 
		}
255
256 
		private static void checkCanUseCloudhopper() throws ConfigureException {
257 1 1. checkCanUseCloudhopper : negated conditional → RUN_ERROR
 
			if (!isCloudhopperPresent()) {
258 
				throw new MissingImplementationException("Can't send SMS through Cloudhopper because Cloudhopper implementation is not present in the classpath", "com.cloudhopper.smpp.SmppClient");
259 
			}
260 
		}
261
262 
		private static boolean isCloudhopperPresent() {
263 2 1. isCloudhopperPresent : replaced boolean return with false for fr/sii/ogham/sms/builder/cloudhopper/DefaultCloudhopperConfigurer$CloudhopperConfigurer::isCloudhopperPresent → RUN_ERROR
2. isCloudhopperPresent : replaced boolean return with true for fr/sii/ogham/sms/builder/cloudhopper/DefaultCloudhopperConfigurer$CloudhopperConfigurer::isCloudhopperPresent → RUN_ERROR
 
			return ClasspathUtils.exists("com.cloudhopper.smpp.SmppClient");
264 
		}
265 
	}
266
267 
	private DefaultCloudhopperConfigurer() {
268 
		super();
269 
	}
270 
}

Mutations

174

1.1
Location : configure
Killed by : removed call to fr/sii/ogham/sms/builder/cloudhopper/DefaultCloudhopperConfigurer$CloudhopperConfigurer::checkCanUseCloudhopper → RUN_ERROR
257

1.1
Location : checkCanUseCloudhopper
Killed by : negated conditional → RUN_ERROR
263

1.1
Location : isCloudhopperPresent
Killed by : replaced boolean return with false for fr/sii/ogham/sms/builder/cloudhopper/DefaultCloudhopperConfigurer$CloudhopperConfigurer::isCloudhopperPresent → RUN_ERROR

2.2
Location : isCloudhopperPresent
Killed by : replaced boolean return with true for fr/sii/ogham/sms/builder/cloudhopper/DefaultCloudhopperConfigurer$CloudhopperConfigurer::isCloudhopperPresent → RUN_ERROR

Active mutators

Tests examined


Report generated by PIT 1.13.1