org.mobicents.applications.ussd.examples.http.push

Interface HTTPPushMBean

All Known Implementing Classes:

HTTPPush

public interface HTTPPushMBean

Simple MBean interface. This MBean is front end of simple example for ussd push via HTTP.

Author:

baranowb, Amit Bhayani

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() USER Abort the underlying MAP Dialog
void	close() Close the underlying MAP Dialog.
String	getIsdn() Get the MSISDN where USSD request is to be pushed
String	getStatus() Return current status of service - what has been sent, what has been received etc.
String	getTargetUri() Get the URI pointing to USSD Gateway for push
void	reset() Reset( remove local dialog ) in case something goes wrong
void	sendNotify(String ussdRequest, boolean emptyDialogHandshake, int invokeTimeout, String userData) Starts dialog if not already started.
void	sendRequest(String ussdRequest, boolean emptyDialogHandshake, int invokeTimeout, String userData) Starts dialog if not already started.
void	setIsdn(String isdn) Set the MSISDN where USSD Push is to be sent
void	setTargetUri(String uri) The URI where HTTP Post request is to be submitted.

Method Detail

setTargetUri

void setTargetUri(String uri)

The URI where HTTP Post request is to be submitted. This should point the USSD Gateway. Basically http://USSD-IP:8080/mobicents

Parameters:

uri -

getTargetUri

String getTargetUri()

Get the URI pointing to USSD Gateway for push

Returns:

setIsdn

void setIsdn(String isdn)

Set the MSISDN where USSD Push is to be sent

Parameters:

isdn -

getIsdn

String getIsdn()

Get the MSISDN where USSD request is to be pushed

Returns:

reset

void reset()

Reset( remove local dialog ) in case something goes wrong

sendRequest

void sendRequest(String ussdRequest,
               boolean emptyDialogHandshake,
               int invokeTimeout,
               String userData)
                 throws Exception

Starts dialog if not already started. Sends Unstructured Request. It can be sent multiple times in the same dialog

Parameters:

ussdRequest - The actual USSD String request

emptyDialogHandshake - If true, USSD Gateway will first establish Dialog by doing handshake before sending USSD request. If false the USSD request will be added in Dialog begin message

invokeTimeout - Time in milliseconds USSD gateway will wait for user to respond, if user doesn't respond back within specified time, USSD Gateway will abort the dialog and send back Abort error to HTTP App

userData - User Data to be sent with every request to USSD Gateway which will be returned back with response from USSD Gw. This is just in case if application wants to keep some data at Dialog level, for example MSISDN

Throws:

Exception

sendNotify

void sendNotify(String ussdRequest,
              boolean emptyDialogHandshake,
              int invokeTimeout,
              String userData)
                throws Exception

Starts dialog if not already started. Sends Notify Request. It can be sent multiple times in the same dialog

Parameters:

ussdRequest - The actual USSD String request

emptyDialogHandshake - If true, USSD Gateway will first establish Dialog by doing handshake before sending USSD request. If false the USSD request will be added in Dialog begin message

invokeTimeout - Time in milliseconds USSD gateway will wait for user to respond, if user doesn't respond back within specified time, USSD Gateway will abort the dialog and send back Abort error to HTTP App

userData - User Data to be sent with every request to USSD Gateway which will be returned back with response from USSD Gw. This is just in case if application wants to keep some data at Dialog level, for example MSISDN

Throws:

Exception

abort

void abort()
           throws Exception

USER Abort the underlying MAP Dialog

Throws:

Exception

close

void close()
           throws Exception

Close the underlying MAP Dialog. This will send TCAP End to peer

Throws:

Exeption

Exception

getStatus

String getStatus()

Return current status of service - what has been sent, what has been received etc.

Returns: