Revision: 16317
Author: brainslog
Date: Mon Jan 10 10:44:47 2011
Log: Updating IMS User Profile Enabler.

Update Issue 2124
Removed dependency on JAXB Objects, now works with Sh-Client RA v2.2.1.FINAL
Added javadoc to Child and Parent interfaces


http://code.google.com/p/mobicents/source/detail?r=16317

Modified:
/trunk/servers/jain-slee/enablers/ims-user-profile/docs/sources/src/main/resources/en-US/Chapter-Integrating_The_Enabler.xml /trunk/servers/jain-slee/enablers/ims-user-profile/docs/sources/src/main/resources/en-US/Chapter-Using_The_Enabler.xml
 /trunk/servers/jain-slee/enablers/ims-user-profile/pom.xml
/trunk/servers/jain-slee/enablers/ims-user-profile/sbb/src/main/java/org/mobicents/slee/enabler/ims/userprofile/IMSUserProfileChild.java /trunk/servers/jain-slee/enablers/ims-user-profile/sbb/src/main/java/org/mobicents/slee/enabler/ims/userprofile/IMSUserProfileChildSbb.java /trunk/servers/jain-slee/enablers/ims-user-profile/sbb/src/main/java/org/mobicents/slee/enabler/ims/userprofile/IMSUserProfileParent.java

=======================================
--- /trunk/servers/jain-slee/enablers/ims-user-profile/docs/sources/src/main/resources/en-US/Chapter-Integrating_The_Enabler.xml Fri Jan 7 10:09:04 2011 +++ /trunk/servers/jain-slee/enablers/ims-user-profile/docs/sources/src/main/resources/en-US/Chapter-Integrating_The_Enabler.xml Mon Jan 10 10:44:47 2011
@@ -25,60 +25,58 @@
                <programlisting language="Java" role="JAVA"><![CDATA[
 package org.mobicents.slee.enabler.ims.userprofile;

-import net.java.slee.resource.diameter.sh.events.avp.userdata.ShData;
-
 public interface IMSUserProfileParent {

// Sh-Pull Operations Callbacks ---------------------------------------------

public void deliverRepositoryData(String publicIdentity, byte[][] serviceIndication,
-            long resultCode, ShData data);
+            long resultCode, String data);

public void deliverIMSPublicIdentity(String publicIdentity, byte[] msisdn,
-            int identitySet, long resultCode, ShData data);
-
- public void deliverIMSUserState(String publicIdentity, long resultCode, ShData data);
-
- public void deliverSCSCFName(String publicIdentity, long resultCode, ShData data);
+            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, ShData data);
+            long resultCode, String data);

public void deliverLocationInformation(byte[] msisdn, int requestedDomain, long resultCode,
-            ShData data);
-
- public void deliverUserState(byte[] msisdn, int requestedDomain, long resultCode, ShData data);
+            String data);
+
+ public void deliverUserState(byte[] msisdn, int requestedDomain, long resultCode, String data);

public void deliverChargingInformation(String publicIdentity, byte[] msisdn, long resultCode,
-            ShData data);
-
- public void deliverMSISDN(String publicIdentity, byte[] msisdn, long resultCode, ShData data);
-
- public void deliverPSIActivation(String publicIdentity, long resultCode, ShData data);
+            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 String updateRepositoryDataResponse(String publicIdentity, long resultCode);
-
- public String updatePSIActivationResponse(String publicIdentity, long resultCode); + public void updateRepositoryDataResponse(String publicIdentity, long resultCode);
+
+ public void updatePSIActivationResponse(String publicIdentity, long resultCode);

// Sh-Subscribe Operations Callbacks ----------------------------------------

- public String subscribeRepositoryDataResponse(String publicIdentity, byte[][] serviceIndication, + public void subscribeRepositoryDataResponse(String publicIdentity, byte[][] serviceIndication,
             long resultCode);

- public String subscribeIMSUserStateResponse(String publicIdentity, long resultCode);
-
- public String subscribeSCSCFNameResponse(String publicIdentity, long resultCode);
-
- public String subscribeInitialFilterCriteriaResponse(String publicIdentity, String serverName, + public void subscribeIMSUserStateResponse(String publicIdentity, long resultCode);
+
+ public void subscribeSCSCFNameResponse(String publicIdentity, long resultCode);
+
+ public void subscribeInitialFilterCriteriaResponse(String publicIdentity, String serverName,
             long resultCode);

- public String subscribePSIActivationResponse(String publicIdentity, long resultCode); + public void subscribePSIActivationResponse(String publicIdentity, long resultCode);

// Sh-Notify Operations Callbacks -------------------------------------------

- public void receivedProfileUpdate(String userIdentity, byte[] msisdn, ShData data, + public void receivedProfileUpdate(String userIdentity, byte[] msisdn, String data,
             String originRealm, String originHost);

 }
@@ -88,70 +86,70 @@
                <variablelist>

                        <varlistentry>
- <term>The <literal>deliverRepositoryData(String, byte[][], long, ShData)</literal> method:</term> + <term>The <literal>deliverRepositoryData(String, byte[][], long, String)</literal> method:</term>
                                <listitem>
<para>Callback from the Enabler providing the response for a request for the "Repository Data" data type.</para>
                                </listitem>
                        </varlistentry>

                        <varlistentry>
- <term>The <literal>deliverIMSPublicIdentity(String, byte[], int, long, ShData)</literal> method:</term> + <term>The <literal>deliverIMSPublicIdentity(String, byte[], int, long, String)</literal> method:</term>
                                <listitem>
<para>Callback from the Enabler providing the response for a request for the "IMS Public Identity" data type.</para>
                                </listitem>
                        </varlistentry>

             <varlistentry>
- <term>The <literal>deliverIMSUserState(String, long, ShData)</literal> method:</term> + <term>The <literal>deliverIMSUserState(String, long, String)</literal> method:</term>
                 <listitem>
<para>Callback from the Enabler providing the response for a request for the "IMS User State" data type.</para>
                 </listitem>
             </varlistentry>

             <varlistentry>
- <term>The <literal>deliverSCSCFName(String, long, ShData)</literal> method:</term> + <term>The <literal>deliverSCSCFName(String, long, String)</literal> method:</term>
                 <listitem>
<para>Callback from the Enabler providing the response for a request for the "S-CSCF Name" data type.</para>
                 </listitem>
             </varlistentry>

             <varlistentry>
- <term>The <literal>deliverInitialFilterCriteria(String, String, long, ShData)</literal> method:</term> + <term>The <literal>deliverInitialFilterCriteria(String, String, long, String)</literal> method:</term>
                 <listitem>
<para>Callback from the Enabler providing the response for a request for the "Initial Filter Criteria" data type.</para>
                 </listitem>
             </varlistentry>

             <varlistentry>
- <term>The <literal>deliverLocationInformation(byte[], int, long, ShData)</literal> method:</term> + <term>The <literal>deliverLocationInformation(byte[], int, long, String)</literal> method:</term>
                 <listitem>
<para>Callback from the Enabler providing the response for a request for the "Location Information" data type.</para>
                 </listitem>
             </varlistentry>

             <varlistentry>
- <term>The <literal>deliverUserState(byte[], int, long, ShData)</literal> method:</term> + <term>The <literal>deliverUserState(byte[], int, long, String)</literal> method:</term>
                 <listitem>
<para>Callback from the Enabler providing the response for a request for the "User State" data type.</para>
                 </listitem>
             </varlistentry>

             <varlistentry>
- <term>The <literal>deliverChargingInformation(String, byte[], long, ShData)</literal> method:</term> + <term>The <literal>deliverChargingInformation(String, byte[], long, String)</literal> method:</term>
                 <listitem>
<para>Callback from the Enabler providing the response for a request for the "Charging Information" data type.</para>
                 </listitem>
             </varlistentry>

             <varlistentry>
- <term>The <literal>deliverMSISDN(String, byte[], long, ShData)</literal> method:</term> + <term>The <literal>deliverMSISDN(String, byte[], long, String)</literal> method:</term>
                 <listitem>
<para>Callback from the Enabler providing the response for a request for the "MSISDN" data type.</para>
                 </listitem>
             </varlistentry>

             <varlistentry>
- <term>The <literal>deliverPSIActivation(String, long, ShData)</literal> method:</term> + <term>The <literal>deliverPSIActivation(String, long, String)</literal> method:</term>
                 <listitem>
<para>Callback from the Enabler providing the response for a request for the "PSI Activation" data type.</para>
                 </listitem>
@@ -207,7 +205,7 @@
             </varlistentry>

             <varlistentry>
- <term>The <literal>receivedProfileUpdate(String, byte[], ShData, String, String)</literal> method:</term> + <term>The <literal>receivedProfileUpdate(String, byte[], String, String, String)</literal> method:</term>
                 <listitem>
<para>Callback from the Enabler providing a received Profile Update for a subscribed profile, for any data type.</para>
                 </listitem>
=======================================
--- /trunk/servers/jain-slee/enablers/ims-user-profile/docs/sources/src/main/resources/en-US/Chapter-Using_The_Enabler.xml Fri Jan 7 10:09:04 2011 +++ /trunk/servers/jain-slee/enablers/ims-user-profile/docs/sources/src/main/resources/en-US/Chapter-Using_The_Enabler.xml Mon Jan 10 10:44:47 2011
@@ -21,14 +21,10 @@

 import java.io.IOException;

-import net.java.slee.resource.diameter.sh.events.avp.userdata.ShData;
-
 public interface IMSUserProfileChild {

   public void setParentSbb(IMSUserProfileParentSbbLocalObject parentSbb);

-  public UserDataObjectFactory getUserDataObjectFactory();
-
// Sh-Pull Operations -------------------------------------------------------

public String getRepositoryData(String publicIdentity, byte[][] serviceIndications,
@@ -63,10 +59,10 @@

// Sh-Update Operations -----------------------------------------------------

- public String updateRepositoryData(String publicIdentity, ShData data, String destinationRealm, + public String updateRepositoryData(String publicIdentity, String data, String destinationRealm,
             String destinationHost) throws IOException;

- public String updatePSIActivation(String publicIdentity, ShData data, String destinationRealm, + public String updatePSIActivation(String publicIdentity, String data, String destinationRealm,
             String destinationHost) throws IOException;

// Sh-Subscribe Operations --------------------------------------------------
@@ -101,13 +97,6 @@
                 </listitem>
             </varlistentry>

-            <varlistentry>
- <term>The <literal>getUserDataObjectFactory()</literal> method:</term>
-                <listitem>
- <para>Returns the UserDataObjectFactory to allow to create ShData objects to be passed while updating profiles.</para>
-                </listitem>
-            </varlistentry>
-
             <varlistentry>
<term>The <literal>getRepositoryData(String, byte[][], String, String)</literal> method:</term>
                 <listitem>
@@ -179,14 +168,14 @@
             </varlistentry>

             <varlistentry>
- <term>The <literal>org.mobicents.slee.enabler.ims.userprofile.IMSUserProfileChild.updateRepositoryData(String, ShData, String, String)</literal> method:</term> + <term>The <literal>org.mobicents.slee.enabler.ims.userprofile.IMSUserProfileChild.updateRepositoryData(String, String, String, String)</literal> method:</term>
                 <listitem>
<para>Updates the "Repository Data" data type from the HSS, for the specified Public Identity. Response is provided through parent's callback updateRepositoryDataResponse(...).</para>
                 </listitem>
             </varlistentry>

             <varlistentry>
- <term>The <literal>org.mobicents.slee.enabler.ims.userprofile.IMSUserProfileChild.updatePSIActivation(String, ShData, String, String)</literal> method:</term> + <term>The <literal>org.mobicents.slee.enabler.ims.userprofile.IMSUserProfileChild.updatePSIActivation(String, String, String, String)</literal> method:</term>
                 <listitem>
<para>Updates the "PSI Activation" data type from the HSS, for the specified Public Identity. Response is provided through parent's callback updatePSIActivationResponse(...).</para>
                 </listitem>
=======================================
--- /trunk/servers/jain-slee/enablers/ims-user-profile/pom.xml Thu Jan 6 13:29:47 2011 +++ /trunk/servers/jain-slee/enablers/ims-user-profile/pom.xml Mon Jan 10 10:44:47 2011
@@ -23,7 +23,7 @@
                        <dependency>
                                
<groupId>org.mobicents.servers.diameter.resources</groupId>
                                <artifactId>sh-client-ratype</artifactId>
-                               <version>3.0.0-SNAPSHOT</version>
+                               <version>2.2.1.FINAL</version>
                        </dependency>
                </dependencies>
        </dependencyManagement>
=======================================
--- /trunk/servers/jain-slee/enablers/ims-user-profile/sbb/src/main/java/org/mobicents/slee/enabler/ims/userprofile/IMSUserProfileChild.java Fri Jan 7 13:41:23 2011 +++ /trunk/servers/jain-slee/enablers/ims-user-profile/sbb/src/main/java/org/mobicents/slee/enabler/ims/userprofile/IMSUserProfileChild.java Mon Jan 10 10:44:47 2011
@@ -24,10 +24,6 @@

 import java.io.IOException;

-import net.java.slee.resource.diameter.sh.events.avp.userdata.ShData;
-import net.java.slee.resource.diameter.sh.events.avp.userdata.UserDataObjectFactory;
-
-
 /**
  *
  * @author <a href=mailto:[email protected]> Alexandre Mendonca </a>
@@ -41,81 +37,232 @@
    */
public void setParentSbbCMP(IMSUserProfileParentSbbLocalObject parentSbb);

-  public UserDataObjectFactory getUserDataObjectFactory();
+ // Sh-Pull Operations -------------------------------------------------------

   /**
-   * Data Ref. - XML tag - Defined in - Access key
-   * Operations
+ * Sends an User-Data-Request for Repository Data, using the following access key: + * IMS Public User Identity or Public Service Identity + Data-Reference + Service-Indication
    *
- * 0 - RepositoryData - 7.6.1 - IMS Public User Identity or Public Service Identity + Data-Reference + Service-Indication
-   * Sh-Pull, Sh-Update, Sh-Subs-Notif
-   *
- * 10 - IMSPublicIdentity - 7.6.2 - IMS Public User Identity or Public Service Identity or MSISDN + Data-Reference + Identity-Set
-   * Sh-Pull
-   *
-   * 11 - IMSUserState - 7.6.3 - IMS Public User Identity + Data-Reference
-   * Sh-Pull, Sh-Subs-Notif
-   *
- * 12 - S-CSCFName - 7.6.4 - IMS Public User Identity or Public Service Identity + Data-Reference
-   * Sh-Pull, Sh-Subs-Notif
-   *
- * 13 - InitialFilterCriteria - 7.6.5 - IMS Public User Identity or Public Service Identity + Data-Reference + Server-Name
-   * Sh-Pull, Sh-Subs-Notif
-   *
- * 14 - LocationInformation - 7.6.6 - MSISDN + Data-Reference+ Requested-Domain
-   * Sh-Pull
-   *
-   * 15 - UserState - 7.6.7 - MSISDN + Data-Reference+ Requested-Domain
-   * Sh-Pull
-   *
- * 16 - Charging information - 7.6.8 - IMS Public User Identity or Public Service Identity or MSISDN + Data-Reference
-   * Sh-Pull
-   *
- * 17 - MSISDN - 7.6.9 - IMS Public User Identity or MSISDN + Data-Reference
-   * Sh-Pull
-   *
-   * 18 - PSIActivation - 7.6.10 - Public Service Identity + Data-Reference
-   * Sh-Pull, Sh-Update, Sh-Subs-Notif
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value
+   * @param serviceIndications the Service-Indication(s) value(s)
+ * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
    */
-
- // Sh-Pull Operations -------------------------------------------------------
-
- public String getRepositoryData(String publicIdentity, byte[][] serviceIndication, String destinationRealm, String destinationHost) throws IOException;
-
+ public String getRepositoryData(String publicIdentity, byte[][] serviceIndications, String destinationRealm, String destinationHost) throws IOException;
+
+  /**
+ * Sends an User-Data-Request for IMS Public Identity, using the following access key: + * IMS Public User Identity or Public Service Identity or MSISDN + Data-Reference + Identity-Set
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value (if any)
+   * @param msisdn the MSISDN value (if any)
+ * @param identitySet the Identity-Set value identifying which identities to retrieve, from the following values: + * ALL_IDENTITIES (0), REGISTERED_IDENTITIES (1), IMPLICIT_IDENTITIES (2) + * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
public String getIMSPublicIdentity(String publicIdentity, byte[] msisdn, int identitySet, String destinationRealm, String destinationHost) throws IOException;

+  /**
+ * Sends an User-Data-Request for IMS User State, using the following access key:
+   * IMS Public User Identity + Data-Reference
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value + * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
public String getIMSUserState(String publicIdentity, String destinationRealm, String destinationHost) throws IOException;

+  /**
+ * Sends an User-Data-Request for S-CSCFName, using the following access key:
+   * IMS Public User Identity or Public Service Identity + Data-Reference
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value + * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
public String getSCSCFName(String publicIdentity, String destinationRealm, String destinationHost) throws IOException;

+  /**
+ * Sends an User-Data-Request for Initial Filter Criteria, using the following access key: + * IMS Public User Identity or Public Service Identity + Data-Reference + Server-Name
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value
+   * @param serverName the Server-Name value, a SIP URI identifying the AS
+ * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
public String getInitialFilterCriteria(String publicIdentity, String serverName, String destinationRealm, String destinationHost) throws IOException;

+  /**
+ * Sends an User-Data-Request for Location Information, using the following access key:
+   * MSISDN + Data-Reference+ Requested-Domain
+   *
+   * @param msisdn the MSISDN value
+ * @param requestedDomain the Requested-Domain value indicating the access domain for which the data is requested: CS-Domain (0), PS-Domain (1) + * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
public String getLocationInformation(byte[] msisdn, int requestedDomain, String destinationRealm, String destinationHost) throws IOException;

+  /**
+ * Sends an User-Data-Request for User State, using the following access key:
+   * MSISDN + Data-Reference+ Requested-Domain
+   *
+   * @param msisdn the MSISDN value
+ * @param requestedDomain the Requested-Domain value indicating the access domain for which the data is requested: CS-Domain (0), PS-Domain (1) + * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
public String getUserState(byte[] msisdn, int requestedDomain, String destinationRealm, String destinationHost) throws IOException;

+  /**
+ * Sends an User-Data-Request for Charging Information, using the following access key: + * IMS Public User Identity or Public Service Identity or MSISDN + Data-Reference
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value (if any)
+   * @param msisdn the MSISDN value (if any)
+ * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
public String getChargingInformation(String publicIdentity, byte[] msisdn, String destinationRealm, String destinationHost) throws IOException;

+  /**
+   * Sends an User-Data-Request for MSISDN, using the following access key:
+   * IMS Public User Identity or MSISDN + Data-Reference
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value (if any)
+   * @param msisdn the MSISDN value (if any)
+ * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
public String getMSISDN(String publicIdentity, byte[] msisdn, String destinationRealm, String destinationHost) throws IOException;

+  /**
+ * Sends an User-Data-Request for PSI Activation, using the following access key:
+   * Public Service Identity + Data-Reference
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value + * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
public String getPSIActivation(String publicIdentity, String destinationRealm, String destinationHost) throws IOException;

// Sh-Update Operations -----------------------------------------------------

- public String updateRepositoryData(String publicIdentity, ShData data, String destinationRealm, String destinationHost) throws IOException;
-
- public String updatePSIActivation(String publicIdentity, ShData data, String destinationRealm, String destinationHost) throws IOException;
+  /**
+ * Sends a Profile-Update-Request for Repository Data, using the following access key:
+   * IMS Public User Identity or Public Service Identity + Data-Reference
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value
+   * @param data a String with the XML for the data to be updated
+ * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
+ public String updateRepositoryData(String publicIdentity, String data, String destinationRealm, String destinationHost) throws IOException;
+
+  /**
+ * Sends a Profile-Update-Request for PSI Activation, using the following access key:
+   * IMS Public User Identity or Public Service Identity + Data-Reference
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value
+   * @param data a String with the XML for the data to be updated
+ * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
+ public String updatePSIActivation(String publicIdentity, String data, String destinationRealm, String destinationHost) throws IOException;

// Sh-Subscribe Operations --------------------------------------------------

- public String subscribeRepositoryData(String publicIdentity, byte[][] serviceIndication, int subscriptionRequestType, String destinationRealm, String destinationHost) throws IOException;
-
+  /**
+ * Sends a Subscribe-Notifications-Request for Repository Data, using the following access key: + * IMS Public User Identity or Public Service Identity + Data-Reference + Service-Indication
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value
+   * @param serviceIndications the Service-Indication(s) value(s)
+ * @param subscriptionRequestType the Subscription-Request-Type value indicating whether to SUBSCRIBE (0) or UNSUBSCRIBE (1) to profile + * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
+ public String subscribeRepositoryData(String publicIdentity, byte[][] serviceIndications, int subscriptionRequestType, String destinationRealm, String destinationHost) throws IOException;
+
+  /**
+ * Sends a Subscribe-Notifications-Request for Repository Data, using the following access key:
+   * IMS Public User Identity + Data-Reference
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value + * @param subscriptionRequestType the Subscription-Request-Type value indicating whether to SUBSCRIBE (0) or UNSUBSCRIBE (1) to profile + * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
public String subscribeIMSUserState(String publicIdentity, int subscriptionRequestType, String destinationRealm, String destinationHost) throws IOException;

+  /**
+ * Sends a Subscribe-Notifications-Request for S-CSCF Name, using the following access key:
+   * IMS Public User Identity or Public Service Identity + Data-Reference
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value + * @param subscriptionRequestType the Subscription-Request-Type value indicating whether to SUBSCRIBE (0) or UNSUBSCRIBE (1) to profile + * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
public String subscribeSCSCFName(String publicIdentity, int subscriptionRequestType, String destinationRealm, String destinationHost) throws IOException;

+  /**
+ * Sends a Subscribe-Notifications-Request for Initial Filter Criteria, using the following access key: + * IMS Public User Identity or Public Service Identity + Data-Reference + Server-Name
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value
+   * @param serverName the Server-Name value, a SIP URI identifying the AS
+ * @param subscriptionRequestType the Subscription-Request-Type value indicating whether to SUBSCRIBE (0) or UNSUBSCRIBE (1) to profile + * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
public String subscribeInitialFilterCriteria(String publicIdentity, String serverName, int subscriptionRequestType, String destinationRealm, String destinationHost) throws IOException;

+  /**
+ * Sends a Subscribe-Notifications-Request for PSI Activation, using the following access key:
+   * Public Service Identity + Data-Reference
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value + * @param subscriptionRequestType the Subscription-Request-Type value indicating whether to SUBSCRIBE (0) or UNSUBSCRIBE (1) to profile + * @param destinationRealm the Diameter realm to which the request is to be sent to + * @param destinationHost (optional parameter) the Diameter host (in the specified realm) to which the request is to be sent to + * @return a String representing the sent request Session-Id for possible matching
+   * @throws IOException
+   */
public String subscribePSIActivation(String publicIdentity, int subscriptionRequestType, String destinationRealm, String destinationHost) throws IOException;

 }
=======================================
--- /trunk/servers/jain-slee/enablers/ims-user-profile/sbb/src/main/java/org/mobicents/slee/enabler/ims/userprofile/IMSUserProfileChildSbb.java Sun Jan 9 18:02:57 2011 +++ /trunk/servers/jain-slee/enablers/ims-user-profile/sbb/src/main/java/org/mobicents/slee/enabler/ims/userprofile/IMSUserProfileChildSbb.java Mon Jan 10 10:44:47 2011
@@ -34,9 +34,6 @@
 import javax.slee.SbbContext;
 import javax.slee.facilities.Tracer;

-import org.mobicents.slee.resource.diameter.sh.events.avp.userdata.ObjectFactory; -import org.mobicents.slee.resource.diameter.sh.events.avp.userdata.UserDataObjectFactoryImpl;
-
 import net.java.slee.resource.diameter.base.events.avp.DiameterIdentity;
 import net.java.slee.resource.diameter.sh.DiameterShAvpFactory;
 import net.java.slee.resource.diameter.sh.client.ShClientActivity;
@@ -57,8 +54,6 @@
 import net.java.slee.resource.diameter.sh.events.avp.RequestedDomainType;
 import net.java.slee.resource.diameter.sh.events.avp.SubsReqType;
 import net.java.slee.resource.diameter.sh.events.avp.UserIdentityAvp;
-import net.java.slee.resource.diameter.sh.events.avp.userdata.ShData;
-import net.java.slee.resource.diameter.sh.events.avp.userdata.UserDataObjectFactory;

 /**
  * IMS User Profile SLEE Enabler.
@@ -80,10 +75,6 @@
public abstract RequestMappingACI asSbbActivityContextInterface(ActivityContextInterface aci);

// -- SBB LOCAL OBJECT METHODS ----------------------------------------------
-
-  public UserDataObjectFactory getUserDataObjectFactory() {
-    return new UserDataObjectFactoryImpl(new ObjectFactory());
-  }

public String getRepositoryData(String publicIdentity, byte[][] serviceIndications, String destinationRealm, String destinationHost) throws IOException { UserIdentityAvp publicIdentityAvp = createUserIdentityAvp(publicIdentity, null);
@@ -300,15 +291,10 @@
     return activity.getSessionId();
   }

- public String updateRepositoryData(String publicIdentity, ShData data, String destinationRealm, String destinationHost) throws IOException { + public String updateRepositoryData(String publicIdentity, String data, String destinationRealm, String destinationHost) throws IOException { UserIdentityAvp publicIdentityAvp = createUserIdentityAvp(publicIdentity, null);

- // Constructor does not allow to use ShData directly, using empty and filling separately - ProfileUpdateRequest pur = diameterShClientMessageFactory.createProfileUpdateRequest();
-
-    pur.setUserIdentity(publicIdentityAvp);
-    pur.setDataReference(DataReferenceType.REPOSITORY_DATA);
-    pur.setUserDataObject(data);
+ ProfileUpdateRequest pur = diameterShClientMessageFactory.createProfileUpdateRequest(publicIdentityAvp, DataReferenceType.REPOSITORY_DATA, data.getBytes());

     // Set destination -- Realm is mandatory, host is optional
     pur.setDestinationRealm(new DiameterIdentity(destinationRealm));
@@ -326,15 +312,10 @@
     return activity.getSessionId();
   }

- public String updatePSIActivation(String publicIdentity, ShData data, String destinationRealm, String destinationHost) throws IOException { + public String updatePSIActivation(String publicIdentity, String data, String destinationRealm, String destinationHost) throws IOException { UserIdentityAvp publicIdentityAvp = createUserIdentityAvp(publicIdentity, null);

- // Constructor does not allow to use ShData directly, using empty and filling separately - ProfileUpdateRequest pur = diameterShClientMessageFactory.createProfileUpdateRequest();
-
-    pur.setUserIdentity(publicIdentityAvp);
-    pur.setDataReference(DataReferenceType.PSI_ACTIVATION);
-    pur.setUserDataObject(data);
+ ProfileUpdateRequest pur = diameterShClientMessageFactory.createProfileUpdateRequest(publicIdentityAvp, DataReferenceType.PSI_ACTIVATION, data.getBytes());

     // Set destination -- Realm is mandatory, host is optional
     pur.setDestinationRealm(new DiameterIdentity(destinationRealm));
@@ -607,16 +588,7 @@

     // Retrieve useful data from request
     String [] userIdentityValues = getUserIdentityValues(event);
-
-    ShData data = null;
-
-    try {
-      data = event.getUserDataObject();
-    }
-    catch (Exception e) {
- tracer.severe("Unable to extract User-Data from Push-Notification-Request.", e);
-      return;
-    }
+    String data = event.getUserData();

     // Deliver to parent
getParentSbbCMP().receivedProfileUpdate(userIdentityValues[0], userIdentityValues[1].getBytes(), data, event.getOriginRealm().toString(), event.getOriginHost().toString());
@@ -626,18 +598,9 @@
     UserDataRequest udr = (UserDataRequest) aci.getRequest();

     aci.detach(sbbContext.getSbbLocalObject());
-
-    ShData data = null;
-
-    try {
-      data = event.getUserDataObject();
-    }
-    catch (Exception e) {
- tracer.severe("Unable to extract User-Data from User-Data-Answer.", e);
-      return;
-    }

     String [] userIdentityValues = getUserIdentityValues(udr);
+    String data = event.getUserData();
     long resultCode = event.getResultCode();

     // only one data ref should be present.. but at least one must!
=======================================
--- /trunk/servers/jain-slee/enablers/ims-user-profile/sbb/src/main/java/org/mobicents/slee/enabler/ims/userprofile/IMSUserProfileParent.java Fri Jan 7 10:09:04 2011 +++ /trunk/servers/jain-slee/enablers/ims-user-profile/sbb/src/main/java/org/mobicents/slee/enabler/ims/userprofile/IMSUserProfileParent.java Mon Jan 10 10:44:47 2011
@@ -22,8 +22,6 @@
  */
 package org.mobicents.slee.enabler.ims.userprofile;

-import net.java.slee.resource.diameter.sh.events.avp.userdata.ShData;
-
 /**
  *
  * @author <a href=mailto:[email protected]> Alexandre Mendonca </a>
@@ -32,46 +30,182 @@

// Sh-Pull Operations Callbacks ---------------------------------------------

- public void deliverRepositoryData(String publicIdentity, byte[][] serviceIndication, long resultCode, ShData data);
-
- public void deliverIMSPublicIdentity(String publicIdentity, byte[] msisdn, int identitySet, long resultCode, ShData data);
-
- public void deliverIMSUserState(String publicIdentity, long resultCode, ShData data);
-
- public void deliverSCSCFName(String publicIdentity, long resultCode, ShData data);
-
- public void deliverInitialFilterCriteria(String publicIdentity, String serverName, long resultCode, ShData data);
-
- public void deliverLocationInformation(byte[] msisdn, int requestedDomain, long resultCode, ShData data);
-
- public void deliverUserState(byte[] msisdn, int requestedDomain, long resultCode, ShData data);
-
- public void deliverChargingInformation(String publicIdentity, byte[] msisdn, long resultCode, ShData data);
-
- public void deliverMSISDN(String publicIdentity, byte[] msisdn, long resultCode, ShData data);
-
- public void deliverPSIActivation(String publicIdentity, long resultCode, ShData data);
+  /**
+ * Callback method to deliver the Repository Data data requested in getRepositoryData(..)
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value from the original request + * @param serviceIndications the Service-Indication(s) value(s) from the original request
+   * @param resultCode the Diameter Result-Code received in the answer
+   * @param data a String containing the XML for the received data
+   */
+ public void deliverRepositoryData(String publicIdentity, byte[][] serviceIndications, long resultCode, String data);
+
+  /**
+ * Callback method to deliver the IMS Public Identity data requested in getIMSPublicIdentity(..)
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value from the original request (if any)
+   * @param msisdn the MSISDN value from the original request (if any)
+ * @param identitySet the Identity-Set value, identifying which identities to retrieve, from the original request
+   * @param resultCode the Diameter Result-Code received in the answer
+   * @param data a String containing the XML for the received data
+   */
+ public void deliverIMSPublicIdentity(String publicIdentity, byte[] msisdn, int identitySet, long resultCode, String data);
+
+  /**
+ * Callback method to deliver the IMS User State data requested in getIMSUserState(..)
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value from the original request
+   * @param resultCode the Diameter Result-Code received in the answer
+   * @param data a String containing the XML for the received data
+   */
+ public void deliverIMSUserState(String publicIdentity, long resultCode, String data);
+
+  /**
+ * Callback method to deliver the S-CSCF Name data requested in getSCSCFName(..)
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value from the original request
+   * @param resultCode the Diameter Result-Code received in the answer
+   * @param data a String containing the XML for the received data
+   */
+ public void deliverSCSCFName(String publicIdentity, long resultCode, String data);
+
+  /**
+ * Callback method to deliver the Initial Filter Criteria data requested in getInitialFilterCriteria(..)
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value from the original request + * @param serverName the Server-Name value, a SIP URI identifying the AS, from the original request
+   * @param resultCode the Diameter Result-Code received in the answer
+   * @param data a String containing the XML for the received data
+   */
+ public void deliverInitialFilterCriteria(String publicIdentity, String serverName, long resultCode, String data);
+
+  /**
+ * Callback method to deliver the Location Information data requested in getLocationInformation(..)
+   *
+   * @param msisdn the MSISDN value from the original request
+ * @param requestedDomain the Requested-Domain value, indicating the access domain for which the data was requested, from the original request
+   * @param resultCode the Diameter Result-Code received in the answer
+   * @param data a String containing the XML for the received data
+   */
+ public void deliverLocationInformation(byte[] msisdn, int requestedDomain, long resultCode, String data);
+
+  /**
+ * Callback method to deliver the User State data requested in getUserState(..)
+   *
+   * @param msisdn the MSISDN value from the original request
+ * @param requestedDomain the Requested-Domain value, indicating the access domain for which the data was requested, from the original request
+   * @param resultCode the Diameter Result-Code received in the answer
+   * @param data a String containing the XML for the received data
+   */
+ public void deliverUserState(byte[] msisdn, int requestedDomain, long resultCode, String data);
+
+  /**
+ * Callback method to deliver the Charging Information data requested in getChargingInformation(..)
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value from the original request (if any)
+   * @param msisdn the MSISDN value from the original request (if any)
+   * @param resultCode the Diameter Result-Code received in the answer
+   * @param data a String containing the XML for the received data
+   */
+ public void deliverChargingInformation(String publicIdentity, byte[] msisdn, long resultCode, String data);
+
+  /**
+   * Callback method to deliver the MSISDN data requested in getMSISDN(..)
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value from the original request (if any)
+   * @param msisdn the MSISDN value from the original request (if any)
+   * @param resultCode the Diameter Result-Code received in the answer
+   * @param data a String containing the XML for the received data
+   */
+ public void deliverMSISDN(String publicIdentity, byte[] msisdn, long resultCode, String data);
+
+  /**
+ * Callback method to deliver the PSI Activation data requested in getPSIActivation(..)
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value from the original request
+   * @param resultCode the Diameter Result-Code received in the answer
+   * @param data a String containing the XML for the received data
+   */
+ public void deliverPSIActivation(String publicIdentity, long resultCode, String data);

// Sh-Update Operations Callbacks -------------------------------------------

- public String updateRepositoryDataResponse(String publicIdentity, long resultCode);
-
- public String updatePSIActivationResponse(String publicIdentity, long resultCode);
+  /**
+ * Callback method to deliver the result of the profile update for Repository Data made through updateRepositoryData(..)
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value from the original request
+   * @param resultCode the Diameter Result-Code received in the answer
+   */
+ public void updateRepositoryDataResponse(String publicIdentity, long resultCode);
+
+  /**
+ * Callback method to deliver the result of the profile update for PSI Activation made through updatePSIActivation(..)
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value from the original request
+   * @param resultCode the Diameter Result-Code received in the answer
+   */
+ public void updatePSIActivationResponse(String publicIdentity, long resultCode);

// Sh-Subscribe Operations Callbacks ----------------------------------------

- public String subscribeRepositoryDataResponse(String publicIdentity, byte[][] serviceIndications, int subscriptionRequestType, long resultCode);
-
- public String subscribeIMSUserStateResponse(String publicIdentity, int subscriptionRequestType, long resultCode);
-
- public String subscribeSCSCFNameResponse(String publicIdentity, int subscriptionRequestType, long resultCode);
-
- public String subscribeInitialFilterCriteriaResponse(String publicIdentity, String serverName, int subscriptionRequestType, long resultCode);
-
- public String subscribePSIActivationResponse(String publicIdentity, int subscriptionRequestType, long resultCode);
+  /**
+ * Callback method to deliver the result of the profile subscription for Repository Data made through subscribeRepositoryData(..)
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value from the original request + * @param serviceIndications the Service-Indication(s) value(s) from the original request + * @param subscriptionRequestType the Subscription-Request-Type value, indicating whether to SUBSCRIBE (0) or UNSUBSCRIBE (1) to profile, from the original request
+   * @param resultCode the Diameter Result-Code received in the answer
+   */
+ public void subscribeRepositoryDataResponse(String publicIdentity, byte[][] serviceIndications, int subscriptionRequestType, long resultCode);
+
+  /**
+ * Callback method to deliver the result of the profile subscription for IMS User State made through subscribeIMSUserState(..)
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value from the original request + * @param subscriptionRequestType the Subscription-Request-Type value, indicating whether to SUBSCRIBE (0) or UNSUBSCRIBE (1) to profile, from the original request
+   * @param resultCode the Diameter Result-Code received in the answer
+   */
+ public void subscribeIMSUserStateResponse(String publicIdentity, int subscriptionRequestType, long resultCode);
+
+  /**
+ * Callback method to deliver the result of the profile subscription for S-CSCF Name made through subscribeSCSCFName(..)
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value from the original request + * @param subscriptionRequestType the Subscription-Request-Type value, indicating whether to SUBSCRIBE (0) or UNSUBSCRIBE (1) to profile, from the original request
+   * @param resultCode the Diameter Result-Code received in the answer
+   */
+ public void subscribeSCSCFNameResponse(String publicIdentity, int subscriptionRequestType, long resultCode);
+
+  /**
+ * Callback method to deliver the result of the profile subscription for Initial Filter Criteria made through subscribeInitialFilterCriteria(..)
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value from the original request + * @param serverName the Server-Name value, a SIP URI identifying the AS, from the original request + * @param subscriptionRequestType the Subscription-Request-Type value, indicating whether to SUBSCRIBE (0) or UNSUBSCRIBE (1) to profile, from the original request
+   * @param resultCode the Diameter Result-Code received in the answer
+   */
+ public void subscribeInitialFilterCriteriaResponse(String publicIdentity, String serverName, int subscriptionRequestType, long resultCode);
+
+  /**
+ * Callback method to deliver the result of the profile subscription for PSI Activation made through subscribePSIActivation(..)
+   *
+ * @param publicIdentity the IMS Public User Identity or Public Service Identity value from the original request + * @param subscriptionRequestType the Subscription-Request-Type value, indicating whether to SUBSCRIBE (0) or UNSUBSCRIBE (1) to profile, from the original request
+   * @param resultCode the Diameter Result-Code received in the answer
+   */
+ public void subscribePSIActivationResponse(String publicIdentity, int subscriptionRequestType, long resultCode);

// Sh-Notify Operations Callbacks -------------------------------------------

- public void receivedProfileUpdate(String userIdentity, byte[] msisdn, ShData data, String originRealm, String originHost);
+  /**
+   * Callback method to deliver a received update of a profile subscription
+   *
+ * @param userIdentity the IMS Public User Identity or Public Service Identity value for the received update (if any)
+   * @param msisdn the MSISDN value for the received update (if any)
+   * @param data a String containing the XML for the updated data
+ * @param originRealm the Diameter realm from where this update was originated + * @param originHost the Diameter host from where this update was originated
+   */
+ public void receivedProfileUpdate(String userIdentity, byte[] msisdn, String data, String originRealm, String originHost);

 }

Reply via email to