# SDK User Guide

# Oracle Communications Services Gatekeeper SDK

## Introduction to the Oracle Communications Services Gatekeeper SDK

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

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

The following sections provide an overview of the Oracle Communications Services Gatekeeper SDK:

- What the Oracle Communications Services Gatekeeper Simulator Provides
- What the Oracle Communications Services Gatekeeper SDK Comprises
- Test Flow
- Supported Configurations

## What the Oracle Communications Services Gatekeeper Simulator Provides

The Oracle Communications Services Gatekeeper Simulator offers the following capabilities:

### Supported interfaces

- Extended Web Services Access
- Extended Web Services Session Manager

Note: | It is also possible to use the Simulator in “sessionless” mode. See the “Interacting with Oracle Communications Services Gatekeeper” chapter in the Application Development Guide for more information on session and sessionless modes.

- Parlay X 2.1 Short Messaging
- Parlay X 2.1 Multimedia Messaging
- Parlay X 2.1 Terminal Location
- Extended Web Services WAP Push

### Supported message types

- SMS
- MMS

- Text: plain text, HTML, and WML text only messages.
- Graphics: gif, wbmp, tiff, png, and jpeg graphic files.
- Applications: multipart, multipart-mixed, and SMIL.

- WAP Push

### 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 Oracle Communications Services 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 Oracle Communications Services Gatekeeper.
- All call back functionality from Oracle Communications Services 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 Oracle Communications Services Gatekeeper SDK Comprises

The Oracle Communications Services Gatekeeper SDK is built up of these main parts:

- A simulator, including application-facing telecom interfaces
- A simulator GUI
- Workshop Controls for telecom Web Services

### The Oracle Communications Services Gatekeeper Simulator

The Oracle Communications Services Gatekeeper Simulator simulates a subset of the functionality of Oracle Communications Services Gatekeeper. From an application point-of-view, the Simulator acts as a Oracle Communications Services 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 Oracle Communications Services Gatekeeper Simulator Application-Facing Interfaces

The Oracle Communications Services Gatekeeper Simulator exposes a subset of the interfaces and methods that Oracle Communications Services 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. This version of Oracle Communications Services Gatekeeper Simulator 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 Oracle Communications Services Gatekeeper.

### The Oracle Communications Services Gatekeeper Simulator GUI

The Oracle Communications Services 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 Oracle Communications Services 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 Oracle Communications Services 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 Oracle Communications Services 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 Oracle Communications Services 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 Oracle Communications Services Gatekeeper application test flow, from the application developers’ functional test to deployment in a live network. An application developer can perform functional tests using Oracle Communications Services 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 Oracle Communications Services Gatekeeper Simulator and Oracle Communications Services Gatekeeper is shown in Figure 2-5.

.

Figure 2-5 Oracle Communications Services Gatekeeper SDK in relation to Oracle Communications Services Gatekeeper

In the first stage of testing, the Web Services endpoints are provided by Oracle Communications Services Gatekeeper Simulator. In production, the application uses endpoints provided by Oracle Communications Services Gatekeeper.

## Supported Configurations

The Oracle Communications Services Gatekeeper SDK and Simulator runs on WebLogic Server. It is supported on the following platforms:

#### Microsoft Windows XP SP2 on x86

Table 2-1 Requirements
Operating System Version and Patches | Windows XP Service Pack 2 and later Service Packs
Chip Architecture and Minimum Processor Speed | x86 and compatible chip architectures (1.3 GHz)
RAM | 1 GB minimum, 2 GB recommended

#### Red Hat Enterprise Linux 4.0 on x86

Table 2-2 Requirements
Operating System Version and Patches | Red Hat Enterprise Linux 4.0-1 AS, ES, WS Kernel 2.6.9-11.ELsmp #1 SMP x86_32 GNU/Linux with glibc 2.3.4-2.9 and later updates and errata levels
Chip Architecture and Minimum Processor Speed | x86 (400 MHz)
RAM | 1 GB minimum, 2 GB recommended
Additional | Must support X11