PageRenderTime 44ms CodeModel.GetById 19ms app.highlight 18ms RepoModel.GetById 1ms app.codeStats 1ms

/protocols/ss7/map/map-api/src/main/java/org/mobicents/protocols/ss7/map/api/service/sms/MAPDialogSms.java

http://mobicents.googlecode.com/
Java | 269 lines | 44 code | 27 blank | 198 comment | 0 complexity | 1feb40a846ad5322d921c8463f4f75b3 MD5 | raw file
  1/*
  2 * JBoss, Home of Professional Open Source
  3 * Copyright 2011, Red Hat, Inc. and individual contributors
  4 * by the @authors tag. See the copyright.txt in the distribution for a
  5 * full listing of individual contributors.
  6 *
  7 * This is free software; you can redistribute it and/or modify it
  8 * under the terms of the GNU Lesser General Public License as
  9 * published by the Free Software Foundation; either version 2.1 of
 10 * the License, or (at your option) any later version.
 11 *
 12 * This software is distributed in the hope that it will be useful,
 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 15 * Lesser General Public License for more details.
 16 *
 17 * You should have received a copy of the GNU Lesser General Public
 18 * License along with this software; if not, write to the Free
 19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 21 */
 22
 23package org.mobicents.protocols.ss7.map.api.service.sms;
 24
 25import org.mobicents.protocols.ss7.map.api.MAPDialog;
 26import org.mobicents.protocols.ss7.map.api.MAPException;
 27import org.mobicents.protocols.ss7.map.api.primitives.AddressString;
 28import org.mobicents.protocols.ss7.map.api.primitives.IMSI;
 29import org.mobicents.protocols.ss7.map.api.primitives.ISDNAddressString;
 30import org.mobicents.protocols.ss7.map.api.primitives.MAPExtensionContainer;
 31
 32
 33/**
 34 * 
 35 * @author sergey vetyutnev
 36 * 
 37 */
 38public interface MAPDialogSms extends MAPDialog {
 39
 40	/**
 41<<<<<<< .mine
 42	 * Sending MAP-FORWARD-SHORT-MESSAGE request
 43	 * 
 44	 * @param sm_RP_DA
 45	 *            mandatory
 46	 * @param sm_RP_OA
 47	 *            mandatory
 48	 * @param sm_RP_UI
 49	 *            mandatory
 50	 * @param moreMessagesToSend
 51	 *            optional, default: false
 52	 * @return invokeId
 53	 * @throws MAPException
 54	 */
 55	public Long addForwardShortMessageRequest(SM_RP_DA sm_RP_DA, SM_RP_OA sm_RP_OA, SmsSignalInfo sm_RP_UI, boolean moreMessagesToSend) throws MAPException;
 56
 57	public Long addForwardShortMessageRequest(int customInvokeTimeout, SM_RP_DA sm_RP_DA, SM_RP_OA sm_RP_OA, SmsSignalInfo sm_RP_UI, boolean moreMessagesToSend)
 58			throws MAPException;
 59
 60	/**
 61	 * Sending MAP-FORWARD-SHORT-MESSAGE response
 62	 * 
 63	 * @param invokeId
 64	 * @throws MAPException
 65	 */
 66	public void addForwardShortMessageResponse(long invokeId) throws MAPException;
 67
 68	/**
 69	 * Sending MAP-MO-FORWARD-SHORT-MESSAGE request
 70	 * 
 71	 * @param sm_RP_DA
 72	 *            mandatory
 73	 * @param sm_RP_OA
 74	 *            mandatory
 75	 * @param sm_RP_UI
 76	 *            mandatory
 77	 * @param extensionContainer
 78	 *            optional
 79	 * @param imsi
 80	 *            optional
 81	 * @return invokeId
 82	 * @throws MAPException
 83	 */
 84	public Long addMoForwardShortMessageRequest(SM_RP_DA sm_RP_DA, SM_RP_OA sm_RP_OA, SmsSignalInfo sm_RP_UI, MAPExtensionContainer extensionContainer, IMSI imsi)
 85			throws MAPException;
 86
 87	public Long addMoForwardShortMessageRequest(int customInvokeTimeout, SM_RP_DA sm_RP_DA, SM_RP_OA sm_RP_OA, SmsSignalInfo sm_RP_UI,
 88			MAPExtensionContainer extensionContainer, IMSI imsi) throws MAPException;
 89
 90	/**
 91	 * Sending MAP-MO-FORWARD-SHORT-MESSAGE response
 92	 * 
 93	 * @param invokeId
 94	 * @param sm_RP_UI
 95	 *            optional
 96	 * @param extensionContainer
 97	 *            optional
 98	 * @throws MAPException
 99	 */
100	public void addMoForwardShortMessageResponse(long invokeId, SmsSignalInfo sm_RP_UI, MAPExtensionContainer extensionContainer) throws MAPException;
101
102	/**
103	 * Sending MAP-MT-FORWARD-SHORT-MESSAGE request
104	 * 
105	 * @param sm_RP_DA
106	 *            mandatory
107	 * @param sm_RP_OA
108	 *            mandatory
109	 * @param sm_RP_UI
110	 *            mandatory
111	 * @param moreMessagesToSend
112	 *            optional
113	 * @param extensionContainer
114	 *            optional
115	 * @return
116	 * @throws MAPException
117	 */
118	public Long addMtForwardShortMessageRequest(SM_RP_DA sm_RP_DA, SM_RP_OA sm_RP_OA, SmsSignalInfo sm_RP_UI, boolean moreMessagesToSend,
119			MAPExtensionContainer extensionContainer) throws MAPException;
120
121	public Long addMtForwardShortMessageRequest(int customInvokeTimeout, SM_RP_DA sm_RP_DA, SM_RP_OA sm_RP_OA, SmsSignalInfo sm_RP_UI, boolean moreMessagesToSend,
122			MAPExtensionContainer extensionContainer) throws MAPException;
123
124	/**
125	 * Sending MAP-MT-FORWARD-SHORT-MESSAGE response
126	 * 
127	 * @param invokeId
128	 * @param sm_RP_UI
129	 *            optional
130	 * @param extensionContainer
131	 *            optional
132	 * @throws MAPException
133	 */
134	public void addMtForwardShortMessageResponse(long invokeId, SmsSignalInfo sm_RP_UI, MAPExtensionContainer extensionContainer) throws MAPException;
135
136	/**
137	 * Sending MAP-SEND-ROUTING-INFO-FOR-SM request
138	 * 
139	 * @param msisdn
140	 *            mandatory
141	 * @param sm_RP_PRI
142	 *            mandatory
143	 * @param serviceCentreAddress
144	 *            mandatory
145	 * @param extensionContainer
146	 *            optional
147	 * @param gprsSupportIndicator
148	 *            optional
149	 * @param sM_RP_MTI
150	 *            optional
151	 * @param sM_RP_SMEA
152	 *            optional
153	 * @return
154	 * @throws MAPException
155	 */
156	public Long addSendRoutingInfoForSMRequest(ISDNAddressString msisdn, boolean sm_RP_PRI, AddressString serviceCentreAddress,
157			MAPExtensionContainer extensionContainer, boolean gprsSupportIndicator, SM_RP_MTI sM_RP_MTI, SM_RP_SMEA sM_RP_SMEA) throws MAPException;
158
159	public Long addSendRoutingInfoForSMRequest(int customInvokeTimeout, ISDNAddressString msisdn, boolean sm_RP_PRI, AddressString serviceCentreAddress,
160			MAPExtensionContainer extensionContainer, boolean gprsSupportIndicator, SM_RP_MTI sM_RP_MTI, SM_RP_SMEA sM_RP_SMEA) throws MAPException;
161	
162	/**
163	 * Sending MAP-SEND-ROUTING-INFO-FOR-SM response
164	 * 
165	 * @param imsi
166	 *            mandatory
167	 * @param locationInfoWithLMSI
168	 *            mandatory
169	 * @param extensionContainer
170	 *            optional
171	 * @return
172	 * @throws MAPException
173	 */
174	public void addSendRoutingInfoForSMResponse(long invokeId, IMSI imsi, LocationInfoWithLMSI locationInfoWithLMSI, MAPExtensionContainer extensionContainer)
175			throws MAPException;
176	
177	/**
178	 * Sending MAP-SEND-ROUTING-INFO-FOR-SM request
179	 * 
180	 * @param msisdn
181	 *            mandatory
182	 * @param serviceCentreAddress
183	 *            mandatory
184	 * @param sMDeliveryOutcome
185	 *            mandatory
186	 * @param sbsentSubscriberDiagnosticSM
187	 *            mandatory
188	 * @param extensionContainer
189	 *            optional
190	 * @param gprsSupportIndicator
191	 *            optional
192	 * @param deliveryOutcomeIndicator
193	 *            optional
194	 * @param additionalSMDeliveryOutcome
195	 *            optional
196	 * @param additionalAbsentSubscriberDiagnosticSM
197	 *            optional
198	 * @return
199	 * @throws MAPException
200	 */
201	public Long addReportSMDeliveryStatusRequest(ISDNAddressString msisdn, AddressString serviceCentreAddress, SMDeliveryOutcome sMDeliveryOutcome,
202			Integer absentSubscriberDiagnosticSM, MAPExtensionContainer extensionContainer, boolean gprsSupportIndicator, boolean deliveryOutcomeIndicator,
203			SMDeliveryOutcome additionalSMDeliveryOutcome, Integer additionalAbsentSubscriberDiagnosticSM) throws MAPException;
204
205	public Long addReportSMDeliveryStatusRequest(int customInvokeTimeout, ISDNAddressString msisdn, AddressString serviceCentreAddress,
206			SMDeliveryOutcome sMDeliveryOutcome, Integer absentSubscriberDiagnosticSM, MAPExtensionContainer extensionContainer, boolean gprsSupportIndicator,
207			boolean deliveryOutcomeIndicator, SMDeliveryOutcome additionalSMDeliveryOutcome, Integer additionalAbsentSubscriberDiagnosticSM)
208			throws MAPException;
209	
210	/**
211	 * Sending MAP-SEND-ROUTING-INFO-FOR-SM response
212	 * 
213	 * @param invokeId
214	 * @param storedMSISDN
215	 *            optional
216	 * @param extensionContainer
217	 *            optional
218	 * @return
219	 * @throws MAPException
220	 */
221	public void addReportSMDeliveryStatusResponse(long invokeId, ISDNAddressString storedMSISDN, MAPExtensionContainer extensionContainer) throws MAPException;
222	
223	/**
224	 * Sending MAP-INFORM-SERVICE-CENTRE request
225	 * 
226	 * @param storedMSISDN
227	 *            optional
228	 * @param mwStatus
229	 *            optional
230	 * @param extensionContainer
231	 *            optional
232	 * @param absentSubscriberDiagnosticSM
233	 *            optional
234	 * @param additionalAbsentSubscriberDiagnosticSM
235	 *            optional
236	 * @return
237	 * @throws MAPException
238	 */
239	public Long addInformServiceCentreRequest(ISDNAddressString storedMSISDN, MWStatus mwStatus, MAPExtensionContainer extensionContainer,
240			Integer absentSubscriberDiagnosticSM, Integer additionalAbsentSubscriberDiagnosticSM) throws MAPException;
241
242	public Long addInformServiceCentreRequest(int customInvokeTimeout, ISDNAddressString storedMSISDN, MWStatus mwStatus,
243			MAPExtensionContainer extensionContainer, Integer absentSubscriberDiagnosticSM, Integer additionalAbsentSubscriberDiagnosticSM) throws MAPException;
244
245	/**
246	 * Sending MAP-SEND-ROUTING-INFO-FOR-SM request
247	 * 
248	 * @param msisdn
249	 *            mandatory
250	 * @param serviceCentreAddress
251	 *            mandatory
252	 * @return
253	 * @throws MAPException
254	 */
255	public Long addAlertServiceCentreRequest(ISDNAddressString msisdn, AddressString serviceCentreAddress) throws MAPException;
256
257	public Long addAlertServiceCentreRequest(int customInvokeTimeout, ISDNAddressString msisdn, AddressString serviceCentreAddress) throws MAPException;
258
259	/**
260	 * Sending MAP-SEND-ROUTING-INFO-FOR-SM response
261	 * 
262	 * @param invokeId
263	 * @throws MAPException
264	 */
265	public void addAlertServiceCentreResponse(long invokeId) throws MAPException;
266
267}
268
269