Oracle® Communications Services Gatekeeper Patch Release Notes Release 5.0.0.1 Part Number E24004-03 |
|
|
View PDF |
This chapter describes how to use the Platform Development Studio (PDS) Eclipse wizard to create custom service interceptors.
For general information on service interceptors and on using the PDS Eclipse wizards, see Platform Development Studio Developer's Guide.
When you use the wizard to create the skeleton of an interceptor module, the wizard generates the following artifacts:
build.xml:
This is the build file used to build all the interceptor modules and to package them into a single EAR file for deployment.
build.properties
This is the properties file required by the ant process to build the module.
common.xml
This file defines the common properties used by the module, such as environment variables, WebLogic library path, and so on.
CustomizedApplicationLifecycleListener.java
This is an implementation of the WebLogic ApplicationLifecycleListener used to manage the module life cycle.
InterceptorXXX.java
This is your interceptor implementation, where XXX is the name that you assign to the interceptor in the wizard.
Make sure that Eclipse is configured to create Services Gatekeeper modules. For more information, see the discussion on configuring Eclipse in Platform Development Studio Developer's Guide.
To generate a custom interceptor module:
In Eclipse, choose New Project from the File menu.
The Select a wizard window appears.
Select the Interceptor Module item under OCSG Platform Development Studio.
Click Next.
The Generate Interceptor modules window appears.
In the Project name field, enter the name of the Eclipse project for the interceptor module.
Either enter the location of the project in the Location field or accept the default location by checking the Use default location box.
In the Package Name field, enter the package name to be used for the interceptor package.
In the Application Lifestyle Listener field enter the ApplicationLifecycleListener implementation class name. If this value is not specified in the wizard, the default value "CustomizedApplicationLifecycleListener" is used.
For information about the Application Lifestyle Listener, see the discussion of creating a custom listener in Platform Development Studio Developer's Guide and the description of the ApplicationLifecycleListener class in the WebLogic Server 10.3 API Reference.
Click the Add button to add an interceptor module.
The Add Interceptor dialog box appears. In the Add Interceptor dialog box, do the following:
In the Name field, enter the fully qualified name of the custom interceptor.
In the Point menu, choose the position element that describes the type of requests for which the interceptor is valid. Choices are MO North, MT North, MO South, and MT South.
In the Index field, enter the index in the interceptor stack at which this interceptor will be invoked relative to other interceptors within the same position element. The order is ascending. The index value must be unique within a position element.
See Chapter 8, "Interceptor Chain Customization," for information about interceptor configuration in Services Gatekeeper, including listing interceptors, to determine the correct Index value.
Click OK.
The interceptor module appears in the list of modules.
Repeat this step for every interceptor module that you want to add to the EAR file.
Click Finish to generate the custom interceptor artifacts.