org.mobicents.gmlc.slee.mlp

Class MLPResponse

java.lang.Object

org.mobicents.gmlc.slee.mlp.MLPResponse

public class MLPResponse
extends Object

Created by angrygreenfrogs on 3/24/2015. This is a helper for generating MLP XML responses to send to a MLP client. It uses the JiBX generated XML bound classes in org.oma.protocols.mlp It exists to generates consistent XML output using the JiBX marshaller It supports generating a result only for a single MSISDN that has a single Point (X/Y - lat/lon) result In the future, it will likely be replaced by a more complex structure for handling the full variety of MLP results, but I wanted to keep it simple and clear for the first version.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MLPResponse.MLPResultType

Constructor Summary

Constructors

Constructor and Description
MLPResponse(javax.slee.facilities.Tracer logger)

Method Summary

Methods

Modifier and Type	Method and Description
String	getPositionErrorResponseXML(String msid, MLPResponse.MLPResultType mlpClientErrorType, String mlpClientErrorMessage) Generate a MLP error response for a position
static String	getResultCodeForType(MLPResponse.MLPResultType t) Get the MLP result code as per OMA MLP section 5.4.1
static String	getResultStringForType(MLPResponse.MLPResultType t) Get the MLP result string as per OMA MLP section 5.4.1
String	getSinglePositionSuccessXML(String x, String y, String radius, String msid) Use JiBX marshalling to generate the MLP XML result data for a single successful position look-up
String	getSystemErrorResponseXML(MLPResponse.MLPResultType mlpClientErrorType, String mlpClientErrorMessage) Generate a MLP system error response
static boolean	isSystemError(MLPResponse.MLPResultType t) Is this error type a system error?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MLPResponse

public MLPResponse(javax.slee.facilities.Tracer logger)

Method Detail

getResultCodeForType

public static String getResultCodeForType(MLPResponse.MLPResultType t)

Get the MLP result code as per OMA MLP section 5.4.1

Parameters:

t - MLPResultType internal enum value for use in the MLP classes

Returns:

MLP result code to return to the client

getResultStringForType

public static String getResultStringForType(MLPResponse.MLPResultType t)

Get the MLP result string as per OMA MLP section 5.4.1

Parameters:

t - MLPResultType internal enum value for use in the MLP classes

Returns:

MLP result string to return to the client

isSystemError

public static boolean isSystemError(MLPResponse.MLPResultType t)

Is this error type a system error?

Parameters:

t - MLPResultType internal enum value for use in the MLP classes

Returns:

boolean true if it is a system error

getSinglePositionSuccessXML

public String getSinglePositionSuccessXML(String x,
                                 String y,
                                 String radius,
                                 String msid)

Use JiBX marshalling to generate the MLP XML result data for a single successful position look-up

Parameters:

x - X coordinate in WGS84 DMS format

y - Y coordinate in WGS84 DMS format

radius - Position radius in meters (e.g. 5000 for 5km of accuracy)

msid - Location for MSISDN

Returns:

String XML result to return to client Example usage: svcResultXml = MLPResponse.getSinglePositionSuccessXML("27 28 25.00S", "153 01 43.00E", "+1000", "20140507082957", "61307341370"); Example result based on above usage: 61307341370 20140507082957 27 28 25.00S 153 01 43.00E

getSystemErrorResponseXML

public String getSystemErrorResponseXML(MLPResponse.MLPResultType mlpClientErrorType,
                               String mlpClientErrorMessage)

Generate a MLP system error response

Parameters:

mlpClientErrorType - Error type to return to client

mlpClientErrorMessage - Error message to send to client

Returns:

String XML result to return to client

getPositionErrorResponseXML

public String getPositionErrorResponseXML(String msid,
                                 MLPResponse.MLPResultType mlpClientErrorType,
                                 String mlpClientErrorMessage)

Generate a MLP error response for a position

Parameters:

msid - Device MSISDN

mlpClientErrorType - Error type to return to client

mlpClientErrorMessage - Error message to send to client

Returns:

String XML result to return to client