001 /**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017 package org.apache.camel.component.smpp;
018
019 import java.io.UnsupportedEncodingException;
020 import java.util.Date;
021
022 import org.apache.camel.Exchange;
023 import org.apache.camel.Message;
024 import org.jsmpp.bean.AlertNotification;
025 import org.jsmpp.bean.Command;
026 import org.jsmpp.bean.DeliverSm;
027 import org.jsmpp.bean.DeliveryReceipt;
028 import org.jsmpp.bean.SubmitSm;
029 import org.jsmpp.util.AbsoluteTimeFormatter;
030 import org.jsmpp.util.TimeFormatter;
031
032 /**
033 * A Strategy used to convert between a Camel {@link Exchange} and
034 * {@link SmppMessage} to and from a SMPP {@link Command}
035 *
036 * @version $Revision: 889123 $
037 * @author muellerc
038 */
039 public class SmppBinding {
040
041 public static final String SEQUENCE_NUMBER = "CamelSmppSequenceNumber";
042 public static final String SUBMITTED = "CamelSmppSubmitted";
043 public static final String SUBMIT_DATE = "CamelSmppSubmitDate";
044 public static final String ERROR = "CamelSmppError";
045 public static final String DONE_DATE = "CamelSmppDoneDate";
046 public static final String DELIVERED = "CamelSmppDelivered";
047 public static final String COMMAND_ID = "CamelSmppCommandId";
048 public static final String COMMAND_STATUS = "CamelSmppCommandStatus";
049 public static final String ID = "CamelSmppId";
050 public static final String REPLACE_IF_PRESENT_FLAG = "CamelSmppReplaceIfPresentFlag";
051 public static final String VALIDITY_PERIOD = "CamelSmppValidityPeriod";
052 public static final String SCHEDULE_DELIVERY_TIME = "CamelSmppScheduleDeliveryTime";
053 public static final String PRIORITY_FLAG = "CamelSmppPriorityFlag";
054 public static final String PROTOCOL_ID = "CamelSmppProtocolId";
055 public static final String REGISTERED_DELIVERY = "CamelSmppRegisteredDelivery";
056 public static final String SERVICE_TYPE = "CamelSmppServiceType";
057 public static final String SOURCE_ADDR_NPI = "CamelSmppSourceAddrNpi";
058 public static final String SOURCE_ADDR_TON = "CamelSmppSourceAddrTon";
059 public static final String SOURCE_ADDR = "CamelSmppSourceAddr";
060 public static final String DEST_ADDR_NPI = "CamelSmppDestAddrNpi";
061 public static final String DEST_ADDR_TON = "CamelSmppDestAddrTon";
062 public static final String DEST_ADDR = "CamelSmppDestAddr";
063 public static final String ESME_ADDR_NPI = "CamelSmppEsmeAddrNpi";
064 public static final String ESME_ADDR_TON = "CamelSmppEsmeAddrTon";
065 public static final String ESME_ADDR = "CamelSmppEsmeAddr";
066
067 private static TimeFormatter timeFormatter = new AbsoluteTimeFormatter();
068
069 private SmppConfiguration configuration;
070
071 public SmppBinding() {
072 this.configuration = new SmppConfiguration();
073 }
074
075 public SmppBinding(SmppConfiguration configuration) {
076 this.configuration = configuration;
077 }
078
079 /**
080 * Create the SubmitSm object from the inbound exchange
081 *
082 * @throws UnsupportedEncodingException if the encoding is not supported
083 */
084 public SubmitSm createSubmitSm(Exchange exchange) throws UnsupportedEncodingException {
085 Message in = exchange.getIn();
086
087 SubmitSm submitSm = new SubmitSm();
088 submitSm.setShortMessage(exchange.getIn().getBody(String.class).getBytes(configuration.getEncoding()));
089
090 if (in.getHeaders().containsKey(DEST_ADDR)) {
091 submitSm.setDestAddress((String) in.getHeader(DEST_ADDR));
092 } else {
093 submitSm.setDestAddress(configuration.getDestAddr());
094 }
095
096 if (in.getHeaders().containsKey(DEST_ADDR_TON)) {
097 submitSm.setDestAddrTon((Byte) in.getHeader(DEST_ADDR_TON));
098 } else {
099 submitSm.setDestAddrTon(configuration.getDestAddrTon());
100 }
101
102 if (in.getHeaders().containsKey(DEST_ADDR_NPI)) {
103 submitSm.setDestAddrNpi((Byte) in.getHeader(DEST_ADDR_NPI));
104 } else {
105 submitSm.setDestAddrNpi(configuration.getDestAddrNpi());
106 }
107
108 if (in.getHeaders().containsKey(SOURCE_ADDR)) {
109 submitSm.setSourceAddr((String) in.getHeader(SOURCE_ADDR));
110 } else {
111 submitSm.setSourceAddr(configuration.getSourceAddr());
112 }
113
114 if (in.getHeaders().containsKey(SOURCE_ADDR_TON)) {
115 submitSm.setSourceAddrTon((Byte) in.getHeader(SOURCE_ADDR_TON));
116 } else {
117 submitSm.setSourceAddrTon(configuration.getSourceAddrTon());
118 }
119
120 if (in.getHeaders().containsKey(SOURCE_ADDR_NPI)) {
121 submitSm.setSourceAddrNpi((Byte) in.getHeader(SOURCE_ADDR_NPI));
122 } else {
123 submitSm.setSourceAddrNpi(configuration.getDestAddrNpi());
124 }
125
126 if (in.getHeaders().containsKey(SERVICE_TYPE)) {
127 submitSm.setServiceType((String) in.getHeader(SERVICE_TYPE));
128 } else {
129 submitSm.setServiceType(configuration.getServiceType());
130 }
131
132 if (in.getHeaders().containsKey(REGISTERED_DELIVERY)) {
133 submitSm.setRegisteredDelivery((Byte) in.getHeader(REGISTERED_DELIVERY));
134 } else {
135 submitSm.setRegisteredDelivery(configuration.getRegisteredDelivery());
136 }
137
138 if (in.getHeaders().containsKey(PROTOCOL_ID)) {
139 submitSm.setProtocolId((Byte) in.getHeader(PROTOCOL_ID));
140 } else {
141 submitSm.setProtocolId(configuration.getProtocolId());
142 }
143
144 if (in.getHeaders().containsKey(PRIORITY_FLAG)) {
145 submitSm.setPriorityFlag((Byte) in.getHeader(PRIORITY_FLAG));
146 } else {
147 submitSm.setPriorityFlag(configuration.getPriorityFlag());
148 }
149
150 if (in.getHeaders().containsKey(SCHEDULE_DELIVERY_TIME)) {
151 submitSm.setScheduleDeliveryTime(timeFormatter.format((Date) in.getHeader(SCHEDULE_DELIVERY_TIME)));
152 } else {
153 submitSm.setScheduleDeliveryTime(timeFormatter.format(getCurrentDate()));
154 }
155
156 if (in.getHeaders().containsKey(VALIDITY_PERIOD)) {
157 submitSm.setValidityPeriod(timeFormatter.format((Date) in.getHeader(VALIDITY_PERIOD)));
158 }
159
160 if (in.getHeaders().containsKey(REPLACE_IF_PRESENT_FLAG)) {
161 submitSm.setReplaceIfPresent((Byte) in.getHeader(REPLACE_IF_PRESENT_FLAG));
162 } else {
163 submitSm.setReplaceIfPresent(configuration.getReplaceIfPresentFlag());
164 }
165
166 return submitSm;
167 }
168
169 /**
170 * Create a new SmppMessage from the inbound alert notification
171 */
172 public SmppMessage createSmppMessage(AlertNotification alertNotification) {
173 SmppMessage smppMessage = new SmppMessage(alertNotification, configuration);
174
175 smppMessage.setHeader(SEQUENCE_NUMBER, alertNotification.getSequenceNumber());
176 smppMessage.setHeader(COMMAND_ID, alertNotification.getCommandId());
177 smppMessage.setHeader(COMMAND_STATUS, alertNotification.getCommandStatus());
178 smppMessage.setHeader(SOURCE_ADDR, alertNotification.getSourceAddr());
179 smppMessage.setHeader(SOURCE_ADDR_NPI, alertNotification.getSourceAddrNpi());
180 smppMessage.setHeader(SOURCE_ADDR_TON, alertNotification.getSourceAddrNpi());
181 smppMessage.setHeader(ESME_ADDR, alertNotification.getEsmeAddr());
182 smppMessage.setHeader(ESME_ADDR_NPI, alertNotification.getEsmeAddrNpi());
183 smppMessage.setHeader(ESME_ADDR_TON, alertNotification.getEsmeAddrNpi());
184
185 return smppMessage;
186 }
187
188 /**
189 * Create a new SmppMessage from the inbound deliver sm or deliver receipt
190 */
191 public SmppMessage createSmppMessage(DeliverSm deliverSm) throws Exception {
192 SmppMessage smppMessage = new SmppMessage(deliverSm, configuration);
193
194 if (deliverSm.isSmscDeliveryReceipt()) {
195 DeliveryReceipt smscDeliveryReceipt = deliverSm.getShortMessageAsDeliveryReceipt();
196 smppMessage.setBody(smscDeliveryReceipt.getText());
197
198 smppMessage.setHeader(ID, smscDeliveryReceipt.getId());
199 smppMessage.setHeader(DELIVERED, smscDeliveryReceipt.getDelivered());
200 smppMessage.setHeader(DONE_DATE, smscDeliveryReceipt.getDoneDate());
201 if (!"000".equals(smscDeliveryReceipt.getError())) {
202 smppMessage.setHeader(ERROR, smscDeliveryReceipt.getError());
203 }
204 smppMessage.setHeader(SUBMIT_DATE, smscDeliveryReceipt.getSubmitDate());
205 smppMessage.setHeader(SUBMITTED, smscDeliveryReceipt.getSubmitted());
206 } else {
207 smppMessage.setBody(String.valueOf(new String(deliverSm.getShortMessage(),
208 configuration.getEncoding())));
209
210 smppMessage.setHeader(SEQUENCE_NUMBER, deliverSm.getSequenceNumber());
211 smppMessage.setHeader(COMMAND_ID, deliverSm.getCommandId());
212 smppMessage.setHeader(SOURCE_ADDR, deliverSm.getSourceAddr());
213 smppMessage.setHeader(DEST_ADDR, deliverSm.getDestAddress());
214 smppMessage.setHeader(SCHEDULE_DELIVERY_TIME, deliverSm.getScheduleDeliveryTime());
215 smppMessage.setHeader(VALIDITY_PERIOD, deliverSm.getValidityPeriod());
216 }
217
218 return smppMessage;
219 }
220
221 /**
222 * Returns the current date. Externalized for better test support.
223 *
224 * @return the current date
225 */
226 Date getCurrentDate() {
227 return new Date();
228 }
229
230 /**
231 * Returns the smpp configuration
232 *
233 * @return the configuration
234 */
235 public SmppConfiguration getConfiguration() {
236 return configuration;
237 }
238
239 /**
240 * Set the smpp configuration.
241 *
242 * @param configuration smppConfiguration
243 */
244 public void setConfiguration(SmppConfiguration configuration) {
245 this.configuration = configuration;
246 }
247 }