SDK User Guide

Network Gatekeeper SDK

Introduction to the Network Gatekeeper SDK

The BEA WebLogic Network Gatekeeper SDK provides a simulator for Network Gatekeeper and an interactive, graphical test environment for developers who are creating applications to interact with WebLogic Network Gatekeeper. The current version of the Network Gatekeeper Simulator supports the Parlay X 2.1 Short Messaging, Multimedia Messaging, Terminal Location interfaces, and the Extended Web Services WAP Push interfaces.

The Network Gatekeeper SDK is used for functional testing. Because it simulates a WebLogic Network Gatekeeper, it is not necessary to have an active instance of a WebLogic Network Gatekeeper when developing and performing functional tests of applications.

The following sections provide an overview of the Network Gatekeeper SDK:

Supported Network Simulation

Network triggered events

Network triggered events, such as messages sent from a mobile phone to an application, can be simulated, using the Network Gatekeeper Simulator GUI.

The following events are supported:

Receive SMSes

Receive MMSes

Periodic Terminal Location notifications

Application triggered requests

Application triggered requests, such as messages sent from the application to a mobile phone in the network, can be simulated, including:

All request functionality from the application to WebLogic Network Gatekeeper.

All call back functionality from WebLogic Network Gatekeeper to the application.

Other tasks

Adding and deleting mobile phones

Setting the geographical position of a mobile phone

Adding application accounts for application login

Provisioning of off-line notifications

What the Network Gatekeeper SDK Comprises

The Network Gatekeeper SDK is built up of these main parts:

A simulator, including application-facing telecom interfaces

A simulator GUI

The Network Gatekeeper Simulator

The Network Gatekeeper Simulator simulates a subset of the functionality of Network Gatekeeper. From an application point-of-view, the Simulator acts as a Network Gatekeeper that has connectivity to the telecom network. The Simulator provides an abstracted high-level simulation of the underlying network, with mobile terminals that can send and receive messages.

The Network Gatekeeper Simulator exposes a subset of the interfaces and methods that Network Gatekeeper exposes:

Parlay X 2.1 Interface SendSms:

sendSms

sendSmsLogo (only a binary representation of the logo is sent.)

sendSmsRingtone (only a binary representation of the ringtone is sent.)

getSmsDeliveryStatus

Parlay X 2.1 Interface SmsNotification:

notifySmsReception

notifySmsDeliveryReceipt

Parlay X 2.1 Interface ReceiveSms:

getReceivedSms

Parlay X 2.1 Interface SmsNotificationManager:

startSmsNotification

stopSmsNotification

Parlay X 2.1 Interface SendMessage:

sendMessage

getMessageDeliveryStatus

Parlay X 2.1 Interface ReceiveMessage:

getReceivedMessages

getMessage

Parlay X 2.1 Interface MessageNotification:

notifyMessageReception

notifyMessageDeliveryReceipt

Parlay X 2.1 Interface MessageNotificationManager:

startMessageNotification

stopMessageNotification

Parlay X 2.1 Interface TerminalLocation:

getLocation

getTerminalDistance

getLocationForGroup

Parlay X 2.1 Interface TerminalLocationNotificationManager:

startPeriodicNotification

endNotification

Parlay X 2.1 Interface TerminalLocationNotification:

locationNotification

locationError

locationEnd

Extended Web Services WAP Push Interface PushMessage:

sendPushMessage

Extended Web Services WAP Push Interface PushMessageNotification:

resultNotificationMessage

Session Manager Service, Interface Session Manager

getSession

destroySession

refreshSession

getSessionRemainingLifeTime

changeApplicationPassword

Access Service, Interface Access:

Deprecated interface. Network Gatekeeper Simulator 3.0 is backward compatible with Network Gatekeeper 2.2 Access service for authentication and session management. New applications should use the Session Manager Service instead.

applicationLogin

applicationLogout

changeApplicationPassword

getLoginTicketRemainingLifeTime

refreshLoginTicket

When an application uses these interfaces, the simulator provides the same behavior as a Network Gatekeeper.

The Network Gatekeeper Simulator GUI

The Network Gatekeeper Simulator GUI is based on a map. The map can be changed to fit different locations. The GUI is used to add mobile telephony terminals (mobile telephones).

Figure 2-1 Network Gatekeeper Simulator GUI

These terminals are given a subscription number. Once the terminal is defined, it can be moved to different locations on the map.

Figure 2-2 Telephone (terminal) icon

The terminals on the GUI can send and receive messages. When a message has arrived at the telephone, an envelope is displayed beside the telephone icon.

Figure 2-3 Telephone (terminal) icon with message

Using mobile terminals

The mobile terminals created in the Network Gatekeeper Simulator GUI can:

Show the ID of the phone

Indicate when messages have arrived

Be moved using click and drag

Receive and display SMSes.

Receive and display PAP messages.

Receive and display MMSes of the following types:

Text: plain text, HTML, and WML text only messages.

Graphics: gif, wbmp, tiff, png, and jpeg graphic files.

Applications: multipart, multipart-mixed.

Send SMSes.

Send MMSes of the following types:

Text: plain text, HTML, and WML text only messages.

Graphics: gif, wbmp, tiff, png, and jpeg graphic files.

Applications: multipart, multipart-mixed, and SMIL.

Note:

SMSes and MMSes cannot be sent directly from a terminal to another. When sending a message, the message can be received by an application, but it cannot be sent directly to another phone.

Using the map

The Network Gatekeeper Simulator GUI can:

Load new images as maps from any URL, stored locally or on the Internet.

Set the geographical coordinates of the map.

Display the coordinates of a selected phone.

Display several maps simultaneously.

Using utilities

The Network Gatekeeper Simulator GUI can:

Save a configuration - the map including coordinates - to file.

Load a configuration from file.

Test Flow

Figure 2-4 shows the complete WebLogic Network Gatekeeper application test flow, from the application developers' functional test to deployment in a live network. An application developer can perform functional tests using Network Gatekeeper Simulator. The other tests in the flow must be performed in cooperation with a network operator.

Figure 2-4 Application test flow

An overview of the relationship between Network Gatekeeper Simulator and WebLogic Network Gatekeeper is shown in Figure 2-5.