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

Class HTTPPush

java.lang.Object

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

All Implemented Interfaces:

HTTPPushMBean

public class HTTPPush
extends Object
implements HTTPPushMBean

Author:

baranowb

Constructor Summary

Constructors

Constructor and Description
HTTPPush()

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() USER Abort the underlying MAP Dialog
protected void	addStatusEntry(String entry)
void	close() Close the underlying MAP Dialog.
protected void	establishSession()
String	getIsdn() Get the MSISDN where USSD request is to be pushed
protected org.mobicents.protocols.ss7.map.api.primitives.ISDNAddressString	getISDNAddressString()
protected long	getNewID()
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
protected org.mobicents.protocols.ss7.map.api.primitives.USSDString	getUSSDString(String msg)
protected void	handleResponse(org.apache.http.HttpResponse response) Handle response, this checks for choice and sends NTFY if required
void	reset() Reset( remove local dialog ) in case something goes wrong
protected org.apache.http.HttpResponse	send(byte[] serialized)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTTPPush

public HTTPPush()

Method Detail

setTargetUri

public void setTargetUri(String uri)

Description copied from interface: HTTPPushMBean

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

Specified by:

setTargetUri in interface HTTPPushMBean

getTargetUri

public String getTargetUri()

Description copied from interface: HTTPPushMBean

Get the URI pointing to USSD Gateway for push

Specified by:

getTargetUri in interface HTTPPushMBean

Returns:

getIsdn

public String getIsdn()

Description copied from interface: HTTPPushMBean

Get the MSISDN where USSD request is to be pushed

Specified by:

getIsdn in interface HTTPPushMBean

Returns:

setIsdn

public void setIsdn(String isdn)

Description copied from interface: HTTPPushMBean

Set the MSISDN where USSD Push is to be sent

Specified by:

setIsdn in interface HTTPPushMBean

reset

public void reset()

Description copied from interface: HTTPPushMBean

Reset( remove local dialog ) in case something goes wrong

Specified by:

reset in interface HTTPPushMBean

sendRequest

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

Description copied from interface: HTTPPushMBean

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

Specified by:

sendRequest in interface HTTPPushMBean

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

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

Description copied from interface: HTTPPushMBean

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

Specified by:

sendNotify in interface HTTPPushMBean

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

getStatus

public String getStatus()

Description copied from interface: HTTPPushMBean

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

Specified by:

getStatus in interface HTTPPushMBean

Returns:

abort

public void abort()
           throws Exception

Description copied from interface: HTTPPushMBean

USER Abort the underlying MAP Dialog

Specified by:

abort in interface HTTPPushMBean

Throws:

Exception

close

public void close()
           throws Exception

Description copied from interface: HTTPPushMBean

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

Specified by:

close in interface HTTPPushMBean

Throws:

Exception

getNewID

protected long getNewID()

getUSSDString

protected org.mobicents.protocols.ss7.map.api.primitives.USSDString getUSSDString(String msg)
                                                                           throws org.mobicents.protocols.ss7.map.api.MAPException

Throws:

org.mobicents.protocols.ss7.map.api.MAPException

getISDNAddressString

protected org.mobicents.protocols.ss7.map.api.primitives.ISDNAddressString getISDNAddressString()

addStatusEntry

protected void addStatusEntry(String entry)

establishSession

protected void establishSession()

send

protected org.apache.http.HttpResponse send(byte[] serialized)
                                     throws Exception

Parameters:

serialized -

Returns:

Throws:

Exception

handleResponse

protected void handleResponse(org.apache.http.HttpResponse response)
                       throws Exception

Handle response, this checks for choice and sends NTFY if required

Parameters:

response -

Throws:

Exception