Extension SDK for BEA WebLogic Network Gatekeeper

Introduction and Roadmap

Document Scope and Audience

Prerequisites

Guide to this Document

Terminology

Actors

Extending WebLogic Network Gatekeeper

Network plug-in

Traffic interfaces

Plug-in states

Suspending a plug-in

Switching plug-in

Best practises for the plug-in interfaces

Help classes for network plug-ins

Plug-in manager

Accessing the Plug-in Manager

Plug-in manager interfaces

Use cases

SC manager

Accessing the SC Manager

Interfaces

Use cases

Service capability

SESPA SC

Web Services interface implementation

Interacting with the SLEE and the SLEE Utility Services

Basic SLEE interfaces

ServiceAccessible

ServiceDeployable

ServiceDeployableExt

ServiceManageable

ServiceContext

SLEEContext

SLEE utility interfaces

Services fetched from the ServiceContext

PolicyManager

Services fetched from the SLEEContext

SLEE utility classes

Alarm

LoadEvent

SLEECyclicIDManager

SLEEDBTable

SLEECyclicIDManager

SLEEIDManager

SLEEGlobalCounterManager

SLEEGlobalCounter

SupervisedList

SupervisedListListener

OAM

Implementing OAM access control

Using the database

Using the alarm service

Using the event service

Using the charging service

Using the time service

Using the trace service

General sequence diagrams

Asynchronous application-initiated

Synchronous application-initiated

Network-triggered

Registering the listener

Handling incoming events

Frameworks

Interacting with the SLEE

Web Services framework

Retrieving the login ticket from the SOAP Header

Interworking with the stateless adapters (SLEE common loader)

Stateless adapter framework

Interworking with a WESPA SC (SLEE common loader)

Getting an ESPA session based on the loginticket

Service capability framework

Plug-in framework

High availability

Introduction

Plug-in Manager and SC Manager

SC Manager

Plug-ins using SC Manager

Incoming traffic

Outgoing traffic

SESPA and ESPA

Plug-ins that executes as a SLEE service and a web application

Introduction

Interaction between the web application part of a plug-in and the SLEE service part of a plug-in

Interface class registration

Incoming requests

Outgoing requests

Call Control

Network plug-in

Use cases

Application-initiated two-party call

Network-triggered call

Call user interaction

Network plug-in

Call user interaction interfaces

UserInteractionCallResource

IrUICallManager -deprecated-

IrUICallManagerExt

IrUI

IrUICall

IrAppUI

IrAppUICall

Use cases for Call user interaction

Application-initiated usage of a Call user interaction plug-in

SMS and MMS messaging

Network plug-in

SMS Interfaces

MMS Interfaces

Use cases for SMS

ESPA Service Capability registers SC

Application-initiated send message

Network-triggered messages

Content based charging

Network plug-in

Content based charging interfaces

ChargingResource

IrChargingSession

IrAppChargingSession

Use cases for Content based charging

Application-initiated usage of a Content based charging plug-in

Subscriber profile

Network plug-in

Subscriber profile interfaces

IrSubscriberProfileResource

IrSubscriberProfile

IrSubscriberProfileSubscriptionExt

IrAppSubscriberProfile

IrAppSubscriberProfileSubscriptionExt

Use cases for Subscriber profile

Application-initiated usage of a Subscriber profile plug-in

User Location

Network plug-in

User location interfaces

Use cases for user location

Application-initiated user location

Network-triggered user location request

Policy rules and Policy Utilities

Mapping policy request data to variables in a Policy Rule

Adding a rule to Policy Decision Point

Getting data defined in the PolicyRequest

Extending Service Level Agreements

Update SLA Schema

Load new SLA schema into the Policy Service

Update and load rule files

Update SLAs

Load new SLAs

Using a Policy Utility

Defining a Policy Utility class

Example Policy Utility

Using the Extension SDK templates

Prerequisites

Installing the Extension SDK

Installation prerequisites

Installation procedure

About WESPA, SESPA, ESPA service capability, and network plug-in software modules

About the flow descriptions

Traffic flow for application initiated requests

WESPA service capability

SESPA service capability module

ESPA service capability module

Network protocol plug-in SLEE service part

Network protocol plug-in Web Services part

Registration flow for network triggered requests

WESPA service capability

SESPA service capability module

ESPA service capability module

Network protocol plug-in

Traffic flow for network triggered requests

Web Services part of the network protocol plug-in

SLEE Service part of the network protocol plug-in

ESPA service capability module

SESPA service capability module

WESPA service capability module

Directory structure for the templates

Introduction to the network plug-in

Files for the SLEE service part of the network plug-in interfaces

my_plugin_if.idl

MyPluginOAM.idl

MyPluginContext.java

MyPluginSLEEService.java

MyPlugin_impl.java

MyMethodReqTask.java

DeliverNetworkTriggeredEventTask.java

MyPluginNetworkTriggeredEventResultListenerImpl.java

MyWPluginNetworkTriggeredEventListenerImpl.java

MyPluginOAM_impl.java

MyWPluginNetworkTriggeredEventResultListenerImpl.java

MyWPluginServlet.java

NetworkInterfaceImpl.java

NetworkTriggeredEventListenerSoapBindingImpl.java

Introduction to the ESPA service capability

Files for the ESPA service capability interfaces

MyServiceCapability_if.idl

Files for the ESPA service capability implementation

MyServiceCapabilityOAM.idl

ChargingHelper.java

DeliverNetworkTriggeredEventTask.java

MyPluginNetworkTriggeredEventListener_impl.java

MyServiceCapabilityNetworkTriggeredEventResultListenerImpl.java

MyPluginListener_impl.java

MyServiceCapabilityOAM_impl.java

MyServiceCapabilityPersistentStorage.java

MyServiceCapabilityService_impl.java

NotificationHandler.java

MyServiceCapabilityManager_impl.java

MyServiceCapabilityContext.java

Policy implementation concept

Files for the Policy utility

MyPolicyUtility.java

MyPolicyUtilityOAM_impl.java

MyPolicyUtilityException.java

Introduction to the SESPA module

Files for the SESPA module interface

MyServiceCapability.java and MyESPAServiceCapabilityListener.java

MyServiceCapabilityNetworkTriggeredEventListener.java

Files for the SESPA module implementation

MyServiceCapabilityOAM.idl

MyESPAServiceCapabilityListener_impl.java

MyESPAServiceCapabilityNetworkTriggeredEventListener_impl.java

MyServiceCapabilityEventHelper.java

MyServiceCapabilityService.java

MyServiceCapabilityOAM_impl.java

MyServiceCapabilityPersistentStorage.java

MyServiceCapabilityContext.java

MyServiceCapabilityImpl.java

NotificationInfo.java and NotificationInfoId.java

Introduction to the WESPA module

Files for the WESPA module interface

MyServiceCapability.java and MyServiceCapabilityListener.java

MyServiceCapabilityException.java

MyServiceCapabilityNetworkTriggeredEventListener.java

Files for the WESPA module implementation

MyServiceCapabilityListenerImpl.java

MyServiceCapabilityNetworkTriggeredEventListenerImpl.java

MyServiceCapabilitySoapBindingImpl.java

Introduction to the test application

Files for the test application

LoginHelper.java and LoginInfo.java

MyScHelper.java

MyServiceCapabilityListenerImpl.java

TestClient.java

TraceLogService_impl.java and TraceLogService.java

WespaHelper.java

Introduction to the network simulator

Files for the network simulator application

NetworkTriggeredInterfaceHelper.java

NetworkInterfaceImpl.java

TestClient.java

TraceLogService_impl.java and TraceLogService.java

Preparing the development environment

Copy templates

Preparing the build environment

Adapting the build files for the modules

Using the templates from Eclipse

Creating an example network plug-in

General preparations for the SLEE part of the plug-in

Preparing the SLEE plug-in interface

Set up the build environment

Define the plug-in interface structure

Interfaces in the plug-in

Compilation of the SLEE plug-in interface

Preparing the SLEE plug-in implementation

Set up the build environment

Defining the plug-in OAM methods

Adapting the plug-in interface implementation

Plug-in type definition

Compilation of the SLEE plug-in implementation

Installing the SLEE plug-in

Setting up a plug-in route

General preparations for the Web Services part of the plug-in

Preparing the Web Services plug-in interface

Set up the build environment

Interfaces in the plug-in

Compilation of the Web Services part of the plug-in interface

Preparing the Web Services part of the plug-in implementation

Set up the build environment

Adapting the Web Services plug-in interface implementation

Compilation of the Web Services plug-in implementation

Installing the Web Service plug-in

Creating an example ESPA Service Capability module

General preparations

Preparing the ESPA service capability interface

Set up the build environment

Define the ESPA service capability module interface structure

Interfaces to the ESPA service capability module

Compilation of the ESPA service capability module interface

Preparing the ESPA service capability module implementation

Set up the build environment

Defining the OAM methods

ESPA service capability module plug-in listener interface implementation

ESPA service capability module service manager implementation

ESPA service capability module persistent storage

ESPA service capability module context

Implement the Policy Enforcement Point

Compilation of the ESPA service capability module implementation

Adapting the policy rules

Installing the ESPA service capability module

Update Service Level Agreements (SLAs)

Install policy rules

Creating an example Policy Utility

General preparations

Preparing the Policy utility

Set up the build environment

Defining the OAM methods

Policy utility implementation and rule files

Installing the Policy Utility

Install policy rules

Install Subscriber profile plug-in

Provision data to the database

Creating an example SESPA module

General preparations

Preparing the SESPA service capability interface

Build environment

SESPA service capability module interface structure

SESPA service capability module interfaces

SESPA service capability module interface compilation

Preparing the SESPA service capability module implementation

Set up the build environment

Defining the OAM methods

SESPA service capability module structure

SESPA service capability module listener implementation

SESPA service capability module implementation

SESPA service capability module service

Compilation of the SESPA service capability module implementation

Installing the SESPA service capability module

Creating an example WESPA module

General preparations

Preparing the WESPA service capability interface

Build environment

WESPA service capability module interface structure

WESPA service capability module interfaces

WESPA service capability module interface compilation

Preparing the WESPA service capability module implementation

Set up the build environment

WESPA service capability module structure

SESPA service capability listener implementation

WESPA service capability SOAP binding implementation

Compilation of the WESPA service capability module implementation

Installing the WESPA service capability module

Creating an example application

General preparations

Preparing the application

Adapt the application to use the example WESPA module interfaces

Compilation of the test application

Running the application

Prepare start script

Register application data

Run the application

Creating an example network simulator

General preparations

Preparing the network simulator application

Compilation of the network simulator application

Running the network simulator application

Prepare start script

Run the network simulator application

Release notes

What is the Extension SDK for Network Gatekeeper 2.1

Notes on installation

Interface changes

Documentation

Operating system and third party software versions

Operating system

Java

ORB

Ant

Known Issues