org.mobicents.csapi.jr.slee.mm.ul
Interface IpUserLocationConnection

All Superinterfaces:

IpServiceConnection

All Known Subinterfaces:

IpTriggeredUserLocationConnection

public interface IpUserLocationConnection
extends IpServiceConnection

This interface is the 'service manager' interface for the User Location Service. The user location interface provides the management functions to the user location service. The application programmer can use this interface to obtain the geographical location of users. This interface, or IpTriggeredUserLocation, shall be implemented by a User Location SCF as a minimum requirement. The locationReportReq() method, or the extendedLocationReportReq() method, or both the periodicLocationReportingStartReq() and periodicLocationReportingStop() methods shall be implemented as a minimum requirement, if this interface is implemented.

Method Summary

int	extendedLocationReportReq(TpAddress[] users, TpLocationRequest request) Advanced request of report on the location for one or several users.
int	locationReportReq(TpAddress[] users) Request of a report on the location for one or several users.
int	periodicLocationReportingStartReq(TpAddress[] users, TpLocationRequest request, int reportingInterval) Request of periodic reports on the location for one or several users.
void	periodicLocationReportingStop(TpMobilityStopAssignmentData stopRequest) Termination of periodic reports on the location for one or several users.

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

closeConnection

Method Detail

locationReportReq

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

Request of a report on the location for one or several 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_APPLICATION_NOT_ACTIVATED

P_INFORMATION_NOT_AVAILABLE

javax.slee.resource.ResourceException

extendedLocationReportReq

int extendedLocationReportReq(TpAddress[] users,
                              TpLocationRequest request)
                              throws TpCommonExceptions,
                                     P_APPLICATION_NOT_ACTIVATED,
                                     P_REQUESTED_ACCURACY_CANNOT_BE_DELIVERED,
                                     P_REQUESTED_RESPONSE_TIME_CANNOT_BE_DELIVERED,
                                     P_INFORMATION_NOT_AVAILABLE,
                                     javax.slee.resource.ResourceException

Advanced request of report on the location for one or several users.

Parameters:

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

request - Specifies among others the requested location type, accuracy, response time and priority.

Returns:

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

Throws:

TpCommonExceptions

P_APPLICATION_NOT_ACTIVATED

P_REQUESTED_ACCURACY_CANNOT_BE_DELIVERED

P_REQUESTED_RESPONSE_TIME_CANNOT_BE_DELIVERED

P_INFORMATION_NOT_AVAILABLE

javax.slee.resource.ResourceException

periodicLocationReportingStartReq

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

Request of periodic reports on the location for one or several users.

Parameters:

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

request - Specifies among others the requested location type, accuracy, response time and priority.

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_REQUESTED_ACCURACY_CANNOT_BE_DELIVERED

P_REQUESTED_RESPONSE_TIME_CANNOT_BE_DELIVERED

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

Termination of periodic reports on the location 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