org.mobicents.csapi.jr.slee.mm.ulc
Interface IpUserLocationCamelConnection

All Superinterfaces:

IpServiceConnection

public interface IpUserLocationCamelConnection
extends IpServiceConnection

This interface is the 'service manager' interface for ULC. This interface shall be implemented by a User Location Camel SCF. The locationReportReq() method, or both the periodicLocationReportingStartReq() and periodicLocationReportingStop() methods, or both the triggeredLocationReportingStartReq() and triggeredLocationReportingStop() methods shall be implemented as a minimum requirement.

Method Summary

int	locationReportReq(TpAddress[] users) Request for mobile-related location information on one or several camel users.
int	periodicLocationReportingStartReq(TpAddress[] users, int reportingInterval) Request for periodic mobile location reports on one or several users.
void	periodicLocationReportingStop(TpMobilityStopAssignmentData stopRequest) This method stops the sending of periodic mobile location reports for one or several users.
int	triggeredLocationReportingStartReq(TpAddress[] users, TpLocationTriggerCamel trigger) Request for user location reports, containing mobile related information, when the location is changed (the report is triggered by the location change).
void	triggeredLocationReportingStop(TpMobilityStopAssignmentData stopRequest) Request that triggered mobile location reporting should stop.

Methods inherited from interface org.mobicents.csapi.jr.slee.IpServiceConnection

closeConnection

Method Detail

locationReportReq

int locationReportReq(TpAddress[] users)
                      throws TpCommonExceptions,
                             P_UNKNOWN_SUBSCRIBER,
                             P_APPLICATION_NOT_ACTIVATED,
                             P_INFORMATION_NOT_AVAILABLE,
                             javax.slee.resource.ResourceException

Request for mobile-related location information on one or several camel users.

Parameters:

users - Specifies the user(s) for which the location shall be reported.

Returns:

assignmentId Specifies the assignment ID of the location-report request.

Throws:

TpCommonExceptions

P_UNKNOWN_SUBSCRIBER

P_APPLICATION_NOT_ACTIVATED

P_INFORMATION_NOT_AVAILABLE

javax.slee.resource.ResourceException

periodicLocationReportingStartReq

int periodicLocationReportingStartReq(TpAddress[] users,
                                      int reportingInterval)
                                      throws TpCommonExceptions,
                                             P_INVALID_REPORTING_INTERVAL,
                                             P_UNKNOWN_SUBSCRIBER,
                                             P_APPLICATION_NOT_ACTIVATED,
                                             P_INFORMATION_NOT_AVAILABLE,
                                             javax.slee.resource.ResourceException

Request for periodic mobile location reports on one or several users.

Parameters:

users - Specifies the user(s) for which the location shall be reported.

reportingInterval - Specifies the requested interval in seconds between the reports.

Returns:

assignmentId Specifies the assignment ID of the periodic location-reporting request.

Throws:

TpCommonExceptions

P_INVALID_REPORTING_INTERVAL

P_UNKNOWN_SUBSCRIBER

P_APPLICATION_NOT_ACTIVATED

P_INFORMATION_NOT_AVAILABLE

javax.slee.resource.ResourceException

periodicLocationReportingStop

void periodicLocationReportingStop(TpMobilityStopAssignmentData stopRequest)
                                   throws TpCommonExceptions,
                                          P_INVALID_ASSIGNMENT_ID,
                                          javax.slee.resource.ResourceException

This method stops the sending of periodic mobile location reports for one or several users.

Parameters:

stopRequest - Specifies how the assignment shall be stopped, i.e. if whole or just parts of the assignment should be stopped.

Throws:

TpCommonExceptions

P_INVALID_ASSIGNMENT_ID

javax.slee.resource.ResourceException

triggeredLocationReportingStartReq

int triggeredLocationReportingStartReq(TpAddress[] users,
                                       TpLocationTriggerCamel trigger)
                                       throws TpCommonExceptions,
                                              P_UNKNOWN_SUBSCRIBER,
                                              P_APPLICATION_NOT_ACTIVATED,
                                              P_INFORMATION_NOT_AVAILABLE,
                                              javax.slee.resource.ResourceException

Request for user location reports, containing mobile related information, when the location is changed (the report is triggered by the location change).

Parameters:

users - Specifies the user(s) for which the location shall be reported.

trigger - Specifies the trigger conditions.

Returns:

assignmentId Specifies the assignment ID of the triggered location-reporting request.

Throws:

TpCommonExceptions

P_UNKNOWN_SUBSCRIBER

P_APPLICATION_NOT_ACTIVATED

P_INFORMATION_NOT_AVAILABLE

javax.slee.resource.ResourceException

triggeredLocationReportingStop

void triggeredLocationReportingStop(TpMobilityStopAssignmentData stopRequest)
                                    throws TpCommonExceptions,
                                           P_INVALID_ASSIGNMENT_ID,
                                           javax.slee.resource.ResourceException

Request that triggered mobile location reporting should stop.

Parameters:

stopRequest - Specifies how the assignment shall be stopped, i.e. if whole or just parts of the assignment should be stopped.

Throws:

TpCommonExceptions

P_INVALID_ASSIGNMENT_ID

javax.slee.resource.ResourceException