This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information.
In PDF and paper editions, this manual uses typefaces drawn from the Liberation Fonts set. The Liberation Fonts set is also used in HTML editions if the set is installed on your system. If not, alternative but equivalent typefaces are displayed. Note: Red Hat Enterprise Linux 5 and later includes the Liberation Fonts set by default.
Four typographic conventions are used to call attention to specific words and phrases. These conventions, and the circumstances they apply to, are as follows.
Mono-spaced Bold
Used to highlight system input, including shell commands, file names and paths. Also used to highlight key caps and key-combinations. For example:
To see the contents of the file
my_next_bestselling_novel
in your current working directory, enter thecat my_next_bestselling_novel
command at the shell prompt and press Enter to execute the command.
The above includes a file name, a shell command and a key cap, all presented in Mono-spaced Bold and all distinguishable thanks to context.
Key-combinations can be distinguished from key caps by the hyphen connecting each part of a key-combination. For example:
Press Enter to execute the command.
Press Ctrl+Alt+F1 to switch to the first virtual terminal. Press Ctrl+Alt+F7 to return to your X-Windows session.
The first sentence highlights the particular key cap to press. The second highlights two sets of three key caps, each set pressed simultaneously.
If source code is discussed, class names, methods, functions, variable names and returned values mentioned within a paragraph will be presented as above, in Mono-spaced Bold
. For example:
File-related classes include
filesystem
for file systems,file
for files, anddir
for directories. Each class has its own associated set of permissions.
Proportional Bold
This denotes words or phrases encountered on a system, including application names; dialogue box text; labelled buttons; check-box and radio button labels; menu titles and sub-menu titles. For example:
Choose Mouse Preferences. In the Buttons tab, click the Left-handed mouse check box and click to switch the primary mouse button from the left to the right (making the mouse suitable for use in the left hand).
from the main menu bar to launchTo insert a special character into a gedit file, choose from the main menu bar. Next, choose from the Character Map menu bar, type the name of the character in the Search field and click . The character you sought will be highlighted in the Character Table. Double-click this highlighted character to place it in the Text to copy field and then click the button. Now switch back to your document and choose from the gedit menu bar.
The above text includes application names; system-wide menu names and items; application-specific menu names; and buttons and text found within a GUI interface, all presented in Proportional Bold and all distinguishable by context.
Note the
shorthand used to indicate traversal through a menu and its sub-menus. This is to avoid the difficult-to-follow 'Select from the sub-menu in the menu of the main menu bar' approach.
or Mono-spaced Bold Italic
Proportional Bold Italic
Whether Mono-spaced Bold or Proportional Bold, the addition of Italics indicates replaceable or variable text. Italics denotes text you do not input literally or displayed text that changes depending on circumstance. For example:
To connect to a remote machine using ssh, type
ssh
at a shell prompt. If the remote machine isusername
@domain.name
example.com
and your username on that machine is john, typessh john@example.com
.The
mount -o remount
command remounts the named file system. For example, to remount thefile-system
/home
file system, the command ismount -o remount /home
.To see the version of a currently installed package, use the
rpm -q
command. It will return a result as follows:package
.
package-version-release
Note the words in bold italics above username, domain.name, file-system, package, version and release. Each word is a placeholder, either for text you enter when issuing a command or for text displayed by the system.
Aside from standard usage for presenting the title of a work, italics denotes the first use of a new and important term. For example:
When the Apache HTTP Server accepts requests, it dispatches child processes or threads to handle them. This group of child processes or threads is known as a server-pool. Under Apache HTTP Server 2.0, the responsibility for creating and maintaining these server-pools has been abstracted to a group of modules called Multi-Processing Modules (MPMs). Unlike other modules, only one module from the MPM group can be loaded by the Apache HTTP Server.
Two, commonly multi-line, data types are set off visually from the surrounding text.
Output sent to a terminal is set in Mono-spaced Roman
and presented thus:
books Desktop documentation drafts mss photos stuff svn books_tests Desktop1 downloads images notes scripts svgs
Source-code listings are also set in Mono-spaced Roman
but are presented and highlighted as follows:
package org.jboss.book.jca.ex1; import javax.naming.InitialContext; public class ExClient { public static void main(String args[]) throws Exception { InitialContext iniCtx = new InitialContext(); Object ref = iniCtx.lookup("EchoBean"); EchoHome home = (EchoHome) ref; Echo echo = home.create(); System.out.println("Created Echo"); System.out.println("Echo.echo('Hello') = " + echo.echo("Hello")); } }
Finally, we use three visual styles to draw attention to information that might otherwise be overlooked.
A note is a tip or shortcut or alternative approach to the task at hand. Ignoring a note should have no negative consequences, but you might miss out on a trick that makes your life easier.
Important boxes detail things that are easily missed: configuration changes that only apply to the current session, or services that need restarting before an update will apply. Ignoring Important boxes won't cause data loss but may cause irritation and frustration.
A Warning should not be ignored. Ignoring warnings will most likely cause data loss.
If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in the the Issue Tracker, against the product Mobicents JAIN SLEE HSS Client Enabler, or contact the authors.
When submitting a bug report, be sure to mention the manual's identifier: JAIN_SLEE_ENABLER_HSSClient_User_Guide
If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.
The JAIN SLEE HSS Client Enabler allows JAIN SLEE Applications to interact with a Home Subscriber Server (HSS), hiding the network protocol complexity. The Enabler consists in an SBB which can be used in child relations, with a simple asynchronous interface.
The HSS is the master user database used in a IP Multimedia Subsystem (IMS) environment. It contains the subscription-related information to support the network entities actually handling calls/sessions. As an example, the HSS provides support to the call control servers in order to complete the routing/roaming procedures by solving authentication, authorisation, naming/addressing resolution, location dependencies, etc.
Ensure that the following requirements have been met before continuing with the install.
The Enabler doesn't change the Mobicents JAIN SLEE Hardware Requirements, refer to Mobicents JAIN SLEE documentation for more information.
This section provides instructions on how to obtain and build the HSS Client Enabler from source code.
Downloading the source code
Subversion is used to manage its source code. Instructions for using Subversion, including install, can be found at http://svnbook.red-bean.com
Use SVN to checkout a specific release source, the base URL is http://mobicents.googlecode.com/svn/tags/servers/jain-slee/2.x.y/enablers/hss-client, then add the specific release version, lets consider 1.0.0.FINAL.
[usr]$ svn co http://mobicents.googlecode.com/svn/tags/servers/jain-slee/2.x.y/enablers/hss-client/1.0.0.FINAL slee-enabler-hss-client-1.0.0.FINAL
Building the source code
Maven 2.0.9 (or higher) is used to build the release. Instructions for using Maven2, including install, can be found at http://maven.apache.org
Use Maven to build the deployable unit binary.
[usr]$ cd slee-enabler-hss-client-1.0.0.FINAL [usr]$ mvn install
Once the process finishes you should have the deployable-unit
jar file in the target
directory, if Mobicents JAIN SLEE is installed and environment variable JBOSS_HOME is pointing to its underlying JBoss Application Server directory, then the deployable unit jar will also be deployed in the container.
This procedure does not install the Enabler's dependencies
Similar process as for Section 2.2.1, “Release Source Code Building”, the only change is the SVN source code URL, which is http://mobicents.googlecode.com/svn/trunk/servers/jain-slee/enablers/hss-client.
To install the Enabler simply execute provided ant script build.xml
default target:
[usr]$ ant
The script will copy the Enabler's deployable unit jar to the default
Mobicents JAIN SLEE server profile deploy directory, to deploy to another server profile use the argument -Dnode=
.
This procedure also installs the Enabler's dependencies.
To uninstall the Enabler simply execute provided ant script build.xml
undeploy
target:
[usr]$ ant undeploy-all
The script will delete the Enabler's deployable unit jar from the default
Mobicents JAIN SLEE server profile deploy directory, to undeploy from another server profile use the argument -Dnode=
.
This procedure also uninstalls the Enabler's dependencies.
This chapter explains how to setup a JAIN SLEE Service Sbb to use the Enabler.
In short terms, a Service's Sbb will define the Enabler's Sbb as a child, and to achieve that it will need to setup the XML Descriptor, Abstract Class and SbbLocalObject interface.
The Service's Sbb will be referred as the Parent Sbb in the following sections.
The Mobicents JAIN SLEE HSS Client Enabler Sbb provides asynchronous callbacks to the Parent's Sbb, and that can only be achieved if the Parent's SbbLocalObject extends a specific Java interface, deployed also by the Enabler,. The Enabler uses the Parent's SbbLocalObject when a callback to the Parent's Sbb is needed.
The SbbLocalObject which must be used or extended by the Parent's Sbb is named org.mobicents.slee.enabler.hssclient.HSSClientParentSbbLocalObject
, which extends the org.mobicents.slee.SbbLocalObjectExt
and org.mobicents.slee.enabler.hssclient.HSSClientParent
interfaces, the latter declares the callbacks which must be implemented in the Parent's Sbb Abstract Class:
package org.mobicents.slee.enabler.hssclient;
public interface HSSClientParent {
// Sh-Pull Operations Callbacks ---------------------------------------------
public void deliverRepositoryData(String publicIdentity, byte[][] serviceIndication,
long resultCode, String data);
public void deliverIMSPublicIdentity(String publicIdentity, byte[] msisdn,
int identitySet, long resultCode, String data);
public void deliverIMSUserState(String publicIdentity, long resultCode, String data);
public void deliverSCSCFName(String publicIdentity, long resultCode, String data);
public void deliverInitialFilterCriteria(String publicIdentity, String serverName,
long resultCode, String data);
public void deliverLocationInformation(byte[] msisdn, int requestedDomain, long resultCode,
String data);
public void deliverUserState(byte[] msisdn, int requestedDomain, long resultCode, String data);
public void deliverChargingInformation(String publicIdentity, byte[] msisdn, long resultCode,
String data);
public void deliverMSISDN(String publicIdentity, byte[] msisdn, long resultCode, String data);
public void deliverPSIActivation(String publicIdentity, long resultCode, String data);
// Sh-Update Operations Callbacks -------------------------------------------
public void updateRepositoryDataResponse(String publicIdentity, long resultCode);
public void updatePSIActivationResponse(String publicIdentity, long resultCode);
// Sh-Subscribe Operations Callbacks ----------------------------------------
public void subscribeRepositoryDataResponse(String publicIdentity, byte[][] serviceIndication,
long resultCode);
public void subscribeIMSUserStateResponse(String publicIdentity, long resultCode);
public void subscribeSCSCFNameResponse(String publicIdentity, long resultCode);
public void subscribeInitialFilterCriteriaResponse(String publicIdentity, String serverName,
long resultCode);
public void subscribePSIActivationResponse(String publicIdentity, long resultCode);
// Sh-Notify Operations Callbacks -------------------------------------------
public void receivedProfileUpdate(String userIdentity, byte[] msisdn, String data,
String originRealm, String originHost);
}
deliverRepositoryData(String, byte[][], long, String)
method:Callback from the Enabler providing the response for a request for the "Repository Data" data type.
deliverIMSPublicIdentity(String, byte[], int, long, String)
method:Callback from the Enabler providing the response for a request for the "IMS Public Identity" data type.
deliverIMSUserState(String, long, String)
method:Callback from the Enabler providing the response for a request for the "IMS User State" data type.
deliverSCSCFName(String, long, String)
method:Callback from the Enabler providing the response for a request for the "S-CSCF Name" data type.
deliverInitialFilterCriteria(String, String, long, String)
method:Callback from the Enabler providing the response for a request for the "Initial Filter Criteria" data type.
deliverLocationInformation(byte[], int, long, String)
method:Callback from the Enabler providing the response for a request for the "Location Information" data type.
deliverUserState(byte[], int, long, String)
method:Callback from the Enabler providing the response for a request for the "User State" data type.
deliverChargingInformation(String, byte[], long, String)
method:Callback from the Enabler providing the response for a request for the "Charging Information" data type.
deliverMSISDN(String, byte[], long, String)
method:Callback from the Enabler providing the response for a request for the "MSISDN" data type.
deliverPSIActivation(String, long, String)
method:Callback from the Enabler providing the response for a request for the "PSI Activation" data type.
updateRepositoryDataResponse(String, long)
method:Callback from the Enabler providing the response for a request to update the "Repository Data" data type.
updatePSIActivationResponse(String, long)
method:Callback from the Enabler providing the response for a request to update the "PSI Activation" data type.
subscribeRepositoryDataResponse(String, byte[][], int, long)
method:Callback from the Enabler providing the response for a request to subscribe/unsubscribe to the "Repository Data" data type.
subscribeIMSUserStateResponse(String, int, long)
method:Callback from the Enabler providing the response for a request to subscribe/unsubscribe to the "User State" data type.
subscribeSCSCFNameResponse(String, int, long)
method:Callback from the Enabler providing the response for a request to subscribe/unsubscribe to the "S-CSCF Name" data type.
subscribeInitialFilterCriteriaResponse(String, String, int, long)
method:Callback from the Enabler providing the response for a request to subscribe/unsubscribe to the "Initial Filter Criteria" data type.
subscribePSIActivationResponse(String, int, long)
method:Callback from the Enabler providing the response for a request to subscribe/unsubscribe to the "PSI Activation" data type.
receivedProfileUpdate(String, byte[], String, String, String)
method:Callback from the Enabler providing a received Profile Update for a subscribed profile, for any data type.
The Parent Sbb Abstract Class must implement the callbacks on it's SbbLocalObject, that is, must implement the org.mobicents.slee.enabler.hssclient.HSSClientParent
interface discussed in last section.
The Enabler's Sbb is a Child Sbb, and JAIN SLEE 1.1 Child Relations requires an abstract method in the Sbb Abstract Class, to retrieve the javax.slee.ChildRelation
object, which is used to create or access specific Child Sbbs. This method should be:
public abstract ChildRelationExt getHSSClientChildRelation();
The Parent's Sbb must define a reference to the Enabler's Child Sbb, declare which is the method name to get the related ChildRelation object, and also ensure the SbbLocalObject interface is defined correctly.
A reference to the Enabler's Child Sbb is defined right after the Parent's Sbb Vendor ID element, using the following XML element:
<sbb-ref>
<sbb-name>HSSClientChildSbb</sbb-name>
<sbb-vendor>org.mobicents</sbb-vendor>
<sbb-version>1.0</sbb-version>
<sbb-alias>hssClientChildSbb</sbb-alias>
</sbb-ref>
The method name to get the Enabler's ChildRelation object must be defined after the CMP Fields (if any), this XML element links the sbb-alias previously defined with the abstract method declared in the Parent's Sbb Abstract Class:
<get-child-relation-method>
<sbb-alias-ref>hssClientChildSbb</sbb-alias-ref>
<get-child-relation-method-name>getHSSClientChildRelation</get-child-relation-method-name>
<default-priority>0</default-priority>
</get-child-relation-method>
Finally, after the sbb-abstract-class
element the Parent's SbbLocalObject interface name is defined:
<sbb-local-interface>
<sbb-local-interface-name>...</sbb-local-interface-name>
</sbb-local-interface>
In the last chapter we integrated the Enabler in the JAIN SLEE Service's Sbb, the Parent Sbb, in this chapter it is explained how to use the Enabler's Sbb, the Child Sbb.
The Mobicents JAIN SLEE HSS Client Enabler Sbb, the Child Sbb, implements the org.mobicents.slee.enabler.hssclient.HSSClientChildSbbLocalObject
, which extends the org.mobicents.slee.SbbLocalObjectExt
and org.mobicents.slee.enabler.hssclient.HSSClientChild
interfaces, the latter declares the methods which can be used to interact with the HSS:
package org.mobicents.slee.enabler.hssclient;
import java.io.IOException;
public interface HSSClientChild {
// Sh-Pull Operations -------------------------------------------------------
public String getRepositoryData(String publicIdentity, byte[][] serviceIndications,
String destinationRealm, String destinationHost) throws IOException;
public String getIMSPublicIdentity(String publicIdentity, byte[] msisdn, int identitySet,
String destinationRealm, String destinationHost) throws IOException;
public String getIMSUserState(String publicIdentity, String destinationRealm,
String destinationHost) throws IOException;
public String getSCSCFName(String publicIdentity, String destinationRealm, String destinationHost)
throws IOException;
public String getInitialFilterCriteria(String publicIdentity, String serverName,
String destinationRealm, String destinationHost) throws IOException;
public String getLocationInformation(byte[] msisdn, int requestedDomain, String destinationRealm,
String destinationHost) throws IOException;
public String getUserState(byte[] msisdn, int requestedDomain, String destinationRealm,
String destinationHost) throws IOException;
public String getChargingInformation(String publicIdentity, byte[] msisdn, String destinationRealm,
String destinationHost) throws IOException;
public String getMSISDN(String publicIdentity, byte[] msisdn, String destinationRealm,
String destinationHost) throws IOException;
public String getPSIActivation(String publicIdentity, String destinationRealm,
String destinationHost) throws IOException;
// Sh-Update Operations -----------------------------------------------------
public String updateRepositoryData(String publicIdentity, String data, String destinationRealm,
String destinationHost) throws IOException;
public String updatePSIActivation(String publicIdentity, String data, String destinationRealm,
String destinationHost) throws IOException;
// Sh-Subscribe Operations --------------------------------------------------
public String subscribeRepositoryData(String publicIdentity, byte[][] serviceIndications,
int subscriptionRequestType, String destinationRealm, String destinationHost)
throws IOException;
public String subscribeIMSUserState(String publicIdentity, int subscriptionRequestType,
String destinationRealm, String destinationHost) throws IOException;
public String subscribeSCSCFName(String publicIdentity, int subscriptionRequestType,
String destinationRealm, String destinationHost) throws IOException;
public String subscribeInitialFilterCriteria(String publicIdentity, String serverName,
int subscriptionRequestType, String destinationRealm, String destinationHost)
throws IOException;
public String subscribePSIActivation(String publicIdentity, int subscriptionRequestType,
String destinationRealm, String destinationHost) throws IOException;
}
getRepositoryData(String, byte[][], String, String)
method:Retrieves the "Repository Data" data type from the HSS, for the specified Public Identity and Service Indication(s). Response is provided through parent's callback deliverRepositoryData(...).
getIMSPublicIdentity(String, byte[], int, String, String)
method:Retrieves the "IMS Public Identity" data type from the HSS, for the specified Public Identity or MSISDN, and Identity Set. Response is provided through parent's callback deliverIMSPublicIdentity(...).
getIMSUserState(String, String, String)
method:Retrieves the "IMS User State" data type from the HSS, for the specified Public Identity. Response is provided through parent's callback deliverIMSUserState(...).
org.mobicents.slee.enabler.hssclient.HSSClientChild.getSCSCFName(String, String, String)
method:Retrieves the "S-CSCF Name" data type from the HSS, for the specified Public Identity. Response is provided through parent's callback deliverSCSCFName(...).
org.mobicents.slee.enabler.hssclient.HSSClientChild.getInitialFilterCriteria(String, String, String, String)
method:Retrieves the "Initial Filter Criteria" data type from the HSS, for the specified Public Identity and Server Name. Response is provided through parent's callback deliverInitialFilterCriteria(...).
org.mobicents.slee.enabler.hssclient.HSSClientChild.getLocationInformation(byte[], int, String, String)
method:Retrieves the "Location Information" data type from the HSS, for the specified MSISDN and Requested Domain. Response is provided through parent's callback deliverLocationInformation(...).
org.mobicents.slee.enabler.hssclient.HSSClientChild.getUserState(byte[], int, String, String)
method:Retrieves the "User State" data type from the HSS, for the specified MSISDN and Requested Domain. Response is provided through parent's callback deliverUserState(...).
org.mobicents.slee.enabler.hssclient.HSSClientChild.getChargingInformation(String, byte[], String, String)
method:Retrieves the "Charging Information" data type from the HSS, for the specified Public Identity or MSISDN. Response is provided through parent's callback deliverChargingInformation(...).
org.mobicents.slee.enabler.hssclient.HSSClientChild.getMSISDN(String, byte[], String, String)
method:Retrieves the "MSISDN" data type from the HSS, for the specified Public Identity or MSISDN. Response is provided through parent's callback deliverMSISDN(...).
org.mobicents.slee.enabler.hssclient.HSSClientChild.getPSIActivation(String, String, String)
method:Retrieves the "PSI Activation" data type from the HSS, for the specified Public Identity. Response is provided through parent's callback deliverPSIActivation(...).
org.mobicents.slee.enabler.hssclient.HSSClientChild.updateRepositoryData(String, String, String, String)
method:Updates the "Repository Data" data type from the HSS, for the specified Public Identity. Response is provided through parent's callback updateRepositoryDataResponse(...).
org.mobicents.slee.enabler.hssclient.HSSClientChild.updatePSIActivation(String, String, String, String)
method:Updates the "PSI Activation" data type from the HSS, for the specified Public Identity. Response is provided through parent's callback updatePSIActivationResponse(...).
org.mobicents.slee.enabler.hssclient.HSSClientChild.subscribeRepositoryData(String, byte[][], int, String, String)
method:Subscribes/Unsubcribes (depending on Subscription-Request-Type value) to the "Repository Data" data type from the HSS, for the specified Public Identity and Service Indication(s). Response is provided through parent's callback subscribeRepositoryDataResponse(...).
org.mobicents.slee.enabler.hssclient.HSSClientChild.subscribeIMSUserState(String, int, String, String)
method:Subscribes/Unsubcribes (depending on Subscription-Request-Type value) to the "IMS User State" data type from the HSS, for the specified Public Identity. Response is provided through parent's callback subscribeIMSUserStateResponse(...).
org.mobicents.slee.enabler.hssclient.HSSClientChild.subscribeSCSCFName(String, int, String, String)
method:Subscribes/Unsubcribes (depending on Subscription-Request-Type value) to the "S-CSCF Name" data type from the HSS, for the specified Public Identity. Response is provided through parent's callback subscribeSCSCFNameResponse(...).
org.mobicents.slee.enabler.hssclient.HSSClientChild.subscribeInitialFilterCriteria(String, String, int, String, String)
method:Subscribes/Unsubcribes (depending on Subscription-Request-Type value) to the "Initial Filter Criteria" data type from the HSS, for the specified Public Identity and Server Name. Response is provided through parent's callback subscribeInitialFilterCriteriaResponse(...).
org.mobicents.slee.enabler.hssclient.HSSClientChild.subsribePSIActivation(String, int, String, String)
method:Subscribes/Unsubcribes (depending on Subscription-Request-Type value) to the "PSIActivation" data type from the HSS, for the specified Public Identity and Service Indication(s). Response is provided through parent's callback subsribePSIActivationResponse(...).
The Child Relation in the Parent Sbb Abstract Class is used to create and retrieve a Child Sbb:
HSSClientChildSbbLocalObject sbb = null;
// creation
try {
sbb = (HSSClientChildSbbLocalObject) getHSSClientChildRelation().create(childName);
}
catch (Exception e) {
tracer.severe("Failed to create child sbb", e);
}
// retrieval
try {
sbb = (HSSClientChildSbbLocalObject) getHSSClientChildRelation().get(childName);
}
catch (Exception e) {
tracer.severe("Failed to retrieve child sbb", e);
}
Spaces where introduced in log4j category name to properly render page. Please remove them when using copy/paste.
The JAIN SLEE HSS Client Enabler uses a single JAIN SLEE 1.1 Tracer, named HSSClientChildSbb
.
The related log4j category is
javax.slee.SbbNotification[service=ServiceID[name=
ServiceX,vendor=VendorY,version=VersionZ],
sbb=SbbID[name=HSSClientChildSbb,vendor=org.mobicents,version=1.0]]
.
Where ServiceX
, VendorY
and VersionZ
need to be replaced by the identifiers of the Service using the Enabler.
Revision History | |||
---|---|---|---|
Revision 1.0 | Thu Jan 06 2011 | ||
|