Skip navigation links

Oracle Communications Services Gatekeeper OAM Java API Reference
6.0

E55516-02


com.bea.wlcp.wlng.plugin.terminallocation.mlp.management
Interface TerminalLocationMLPMBean


public interface TerminalLocationMLPMBean

MBean interface for the TL MLP traffic path.


Field Summary
static String characterEncoding
          Indicates the type of Unicode character encoding accepted by the MLP node.
static int cleanupInterval
          Specifies the time interval at which periodic notification expiration checks are performed.
static boolean decimalDegreesToDMSH
          Tells whether conversion from decimal format -> DMSH (Degrees Minutes Seconds Hemisphere) is needed or not for coordinates x and y.
static int maxDuration
          Specifies the maximum duration for a periodic location request.
static boolean mlpAltitudeSupported
          Specifies if the MLP server supports altitude requests.
static boolean mlpLocationEstimates
          Specifies if the MLP server is allowed to estimate locations.
static String mlpPushAddr
          Specifies the callback URL to which the MLP server delivers location reports, periodic or triggered.
static String mlpRequestType
          Specifies which type of location request to use towards the MLP server.
static String mlpServerUrl
          The MLP server URL.
static String mlpSrsName
          MLP Spatial Reference System (SRS) name.
static String mlpVersionSupported
          MLP version supported.
static String msidType
          MSID type of identifier for mobile subscriber.
static String password
          Specifies the password used when Services Gatekeeper connects to the MLP server.
static String requestor
          Specifies the requestor ID.
static int requestTimeout
          The MLP request time out in seconds.
static String serviceId
          Specifies the Services Gatekeeper service ID.
static boolean useInterval
          When enabled this flag indicates that the interval element will be used when sending a TLRR.
static String username
          Specifies the Services Gatekeeper user ID used for connecting to the MLP server.
static boolean xmlDoctypeTagUsage
          Specifies if the XML tag !DOCTYPE should be included in requests towards the MLP node.

 

Method Summary
 String getCharacterEncoding()
           
 int getCleanupInterval()
           
 boolean getDecimalDegreesToDMSH()
           
 int getMaxDuration()
           
 boolean getMlpAltitudeSupported()
           
 boolean getMlpLocationEstimates()
           
 String getMlpPushAddr()
           
 String getMlpRequestType()
           
 String getMlpServerUrl()
           
 String getMlpSrsName()
           
 String getMlpVersionSupported()
           
 String getMsidType()
           
 String getPassword()
           
 String getRequestor()
           
 int getRequestTimeout()
           
 String getServiceId()
           
 boolean getUseInterval()
           
 String getUsername()
           
 boolean getXmlDoctypeTagUsage()
           
 void setCharacterEncoding(String encoding)
           
 void setCleanupInterval(int interval)
           
 void setDecimalDegreesToDMSH(boolean decimalDegToDMSH)
           
 void setMaxDuration(int duration)
           
 void setMlpAltitudeSupported(boolean supported)
           
 void setMlpLocationEstimates(boolean locationEstimates)
           
 void setMlpPushAddr(String mlpPushAddr)
           
 void setMlpRequestType(String requestType)
           
 void setMlpServerUrl(String mlpServerUrl)
           
 void setMlpSrsName(String srsName)
           
 void setMlpVersionSupported(String version)
           
 void setMsidType(String type)
           
 void setPassword(String password)
           
 void setRequestor(String requestor)
           
 void setRequestTimeout(int requestTimeout)
           
 void setServiceId(String serviceId)
           
 void setUseInterval(boolean useInterval)
           
 void setUsername(String username)
           
 void setXmlDoctypeTagUsage(boolean usage)
           

 

Field Detail

characterEncoding

public static final String characterEncoding
Indicates the type of Unicode character encoding accepted by the MLP node. The values are not case sensitive. A typical value is UTF-8.

Scope: Cluster


cleanupInterval

public static final int cleanupInterval
Specifies the time interval at which periodic notification expiration checks are performed. This is a shared value. Format: int [0-3600].

Scope: Cluster

See Also:
Constant Field Values

decimalDegreesToDMSH

public static final boolean decimalDegreesToDMSH
Tells whether conversion from decimal format -> DMSH (Degrees Minutes Seconds Hemisphere) is needed or not for coordinates x and y. This is a shared value. Format: Boolean [true | false], not case sensitive. All strings other than true are treated as false.

Scope: Cluster

See Also:
Constant Field Values

maxDuration

public static final int maxDuration
Specifies the maximum duration for a periodic location request. Rejects startPeriodicNotification and startGeographicalNotification requests on the TerminalLocationNotificationManager interface if the duration is larger than this value. If the duration is not provided in the request, this value is used. This is a shared value. Format: int [>0].

Scope: Cluster

See Also:
Constant Field Values

mlpAltitudeSupported

public static final boolean mlpAltitudeSupported
Specifies if the MLP server supports altitude requests. When set to true, the <alt_acc> element is included in requests towards the MLP server. Only applicable when the plug-in instance operates in MLP 3.2 mode. See mlpVersionSupported for more information. This is a shared value. Format: Boolean [true | false], not case sensitive, all strings other than true are treated as false.

Scope: Cluster

See Also:
Constant Field Values

mlpLocationEstimates

public static final boolean mlpLocationEstimates
Specifies if the MLP server is allowed to estimate locations. Use true if estimates are allowed, otherwise false. Defines the value of the loc_estimates attribute in MLP. This is a shared value. Format: Boolean [true | false], not case sensitive, all strings other than true are treated as false.

Scope: Cluster

See Also:
Constant Field Values

mlpPushAddr

public static final String mlpPushAddr
Specifies the callback URL to which the MLP server delivers location reports, periodic or triggered. This is the URL at which the plug-in instance listens for location reports. The format for the URL is: http://ipaddressOfNTMachine:portOfWLS/tl-mlp/mlp_client For example: http://172.16.0.0:8001/tl-mlp/mlp_client Format: URL.

Scope: Cluster


mlpRequestType

public static final String mlpRequestType
Specifies which type of location request to use towards the MLP server. Defines the DTD to be used for constructing the request towards the MLP server. Valid values are:

Scope: Cluster


mlpServerUrl

public static final String mlpServerUrl
The MLP server URL. This is a shared value. Format: URL.

Scope: Cluster


mlpSrsName

public static final String mlpSrsName
MLP Spatial Reference System (SRS) name. Normally, this is www.epsg.org#4326. This is a shared value.

Scope: Cluster


mlpVersionSupported

public static final String mlpVersionSupported
MLP version supported. Must be either '3.0.0' or '3.2.0'. This is a shared value. Format: String [3.0.0 |3.2.0].

Scope: Cluster


msidType

public static final String msidType
MSID type of identifier for mobile subscriber. Must be either 'MSISDN' or 'MDN'. This is a shared value. Format: String [MSISDN |MDN].

Scope: Cluster


password

public static final String password
Specifies the password used when Services Gatekeeper connects to the MLP server. The password is provided by the MLP server administrator. This is a shared value.

Scope: Cluster


requestor

public static final String requestor
Specifies the requestor ID. If set to an empty string, the <requestorid> element will not be used in the MLP request. The requestor ID is provided by the MLP server administrator. This is a shared value.

Scope: Cluster


requestTimeout

public static final int requestTimeout
The MLP request time out in seconds. This is a shared value. Format: int [0-3600].

Scope: Cluster

See Also:
Constant Field Values

serviceId

public static final String serviceId
Specifies the Services Gatekeeper service ID. If set to an empty string, the <serviceid> element will not be used in the MLP request. The service ID is provided by the MLP server administrator. This is a shared value.

Scope: Cluster


useInterval

public static final boolean useInterval
When enabled this flag indicates that the interval element will be used when sending a TLRR.

Scope: Cluster

See Also:
Constant Field Values

username

public static final String username
Specifies the Services Gatekeeper user ID used for connecting to the MLP server. The user ID is provided by the MLP administrator. This is a shared value.

Scope: Cluster


xmlDoctypeTagUsage

public static final boolean xmlDoctypeTagUsage
Specifies if the XML tag !DOCTYPE should be included in requests towards the MLP node. This is a shared value. Format: Boolean [true | false], not case sensitive. All strings other than true are treated as false.

Scope: Cluster

Method Detail

getCharacterEncoding

public String getCharacterEncoding()
                            throws ManagementException
Throws:
ManagementException

getCleanupInterval

public int getCleanupInterval()
                       throws ManagementException
Throws:
ManagementException

getDecimalDegreesToDMSH

public boolean getDecimalDegreesToDMSH()
                                throws ManagementException
Throws:
ManagementException

getMaxDuration

public int getMaxDuration()
                   throws ManagementException
Throws:
ManagementException

getMlpAltitudeSupported

public boolean getMlpAltitudeSupported()
                                throws ManagementException
Throws:
ManagementException

getMlpLocationEstimates

public boolean getMlpLocationEstimates()
                                throws ManagementException
Throws:
ManagementException

getMlpPushAddr

public String getMlpPushAddr()
                      throws ManagementException
Throws:
ManagementException

getMlpRequestType

public String getMlpRequestType()
                         throws ManagementException
Throws:
ManagementException

getMlpServerUrl

public String getMlpServerUrl()
                       throws ManagementException
Throws:
ManagementException

getMlpSrsName

public String getMlpSrsName()
                     throws ManagementException
Throws:
ManagementException

getMlpVersionSupported

public String getMlpVersionSupported()
                              throws ManagementException
Throws:
ManagementException

getMsidType

public String getMsidType()
                   throws ManagementException
Throws:
ManagementException

getPassword

public String getPassword()
                   throws ManagementException
Throws:
ManagementException

getRequestor

public String getRequestor()
                    throws ManagementException
Throws:
ManagementException

getRequestTimeout

public int getRequestTimeout()
                      throws ManagementException
Throws:
ManagementException

getServiceId

public String getServiceId()
                    throws ManagementException
Throws:
ManagementException

getUseInterval

public boolean getUseInterval()
                       throws ManagementException
Throws:
ManagementException

getUsername

public String getUsername()
                   throws ManagementException
Throws:
ManagementException

getXmlDoctypeTagUsage

public boolean getXmlDoctypeTagUsage()
                              throws ManagementException
Throws:
ManagementException

setCharacterEncoding

public void setCharacterEncoding(String encoding)
                          throws ManagementException
Throws:
ManagementException

setCleanupInterval

public void setCleanupInterval(int interval)
                        throws ManagementException
Throws:
ManagementException

setDecimalDegreesToDMSH

public void setDecimalDegreesToDMSH(boolean decimalDegToDMSH)
                             throws ManagementException
Throws:
ManagementException

setMaxDuration

public void setMaxDuration(int duration)
                    throws ManagementException
Throws:
ManagementException

setMlpAltitudeSupported

public void setMlpAltitudeSupported(boolean supported)
                             throws ManagementException
Throws:
ManagementException

setMlpLocationEstimates

public void setMlpLocationEstimates(boolean locationEstimates)
                             throws ManagementException
Throws:
ManagementException

setMlpPushAddr

public void setMlpPushAddr(String mlpPushAddr)
                    throws ManagementException
Throws:
ManagementException

setMlpRequestType

public void setMlpRequestType(String requestType)
                       throws ManagementException
Throws:
ManagementException

setMlpServerUrl

public void setMlpServerUrl(String mlpServerUrl)
                     throws ManagementException
Throws:
ManagementException

setMlpSrsName

public void setMlpSrsName(String srsName)
                   throws ManagementException
Throws:
ManagementException

setMlpVersionSupported

public void setMlpVersionSupported(String version)
                            throws ManagementException
Throws:
ManagementException

setMsidType

public void setMsidType(String type)
                 throws ManagementException
Throws:
ManagementException

setPassword

public void setPassword(String password)
                 throws ManagementException
Throws:
ManagementException

setRequestor

public void setRequestor(String requestor)
                  throws ManagementException
Throws:
ManagementException

setRequestTimeout

public void setRequestTimeout(int requestTimeout)
                       throws ManagementException
Throws:
ManagementException

setServiceId

public void setServiceId(String serviceId)
                  throws ManagementException
Throws:
ManagementException

setUseInterval

public void setUseInterval(boolean useInterval)
                    throws ManagementException
Throws:
ManagementException

setUsername

public void setUsername(String username)
                 throws ManagementException
Throws:
ManagementException

setXmlDoctypeTagUsage

public void setXmlDoctypeTagUsage(boolean usage)
                           throws ManagementException
Throws:
ManagementException

Skip navigation links

Oracle Communications Services Gatekeeper OAM Java API Reference
6.0

E55516-02


Copyright © 2008, 2015, Oracle and/or its affiliates. All rights reserved.