com.cloudpos.advance.ext.system.network

Interface IApnDevice

All Superinterfaces:

IAdvanceDevice

public interface IApnDevice
extends IAdvanceDevice

The APN Device

Method Summary

Modifier and Type	Method and Description
String	add(String name, String apn) Add a simple APN configuration with only name and APN address.
String	addByAllArgs(String name, String apn, String mcc, String mnc, String proxy, String port, String MMSProxy, String MMSPort, String userName, String server, String password, String MMSC, String authType, String protocol, String roamingProtocol, String type, String bearer, String MVNOType, String MVNOMatchData) Add a complete APN configuration with full parameter set.
String	addByMCCAndMNC(String name, String apn, String mcc, String mnc) Add APN with specified MCC and MNC.
boolean	clear() Remove all APN configurations.
boolean	clearWithSlot(int slot) Remove all APN configurations for a specific SIM slot.
Map	getSelected() Get currently selected APN information.
List	query(String columnName, String value) Query APN configurations by column name and value.
List	queryByName(String value) Query APN configurations by APN name.
boolean	removeByID(int id) Remove an APN configuration by ID.
boolean	removeByName(String name) Remove an APN configuration by APN name.
boolean	setSelected(String name) Set the specified APN as the currently active APN.

Methods inherited from interface com.cloudpos.advance.ext.IAdvanceDevice

close, isOpened, open

Method Detail

add

String add(String name,
           String apn)
    throws DeviceException

Add a simple APN configuration with only name and APN address.

Parameters:

name - APN display name. Must not be null.

apn - APN address. Must not be null.

Returns:

"succeed" if APN was successfully inserted.

Throws:

DeviceException - if operation fails.

addByAllArgs

String addByAllArgs(String name,
                    String apn,
                    String mcc,
                    String mnc,
                    String proxy,
                    String port,
                    String MMSProxy,
                    String MMSPort,
                    String userName,
                    String server,
                    String password,
                    String MMSC,
                    String authType,
                    String protocol,
                    String roamingProtocol,
                    String type,
                    String bearer,
                    String MVNOType,
                    String MVNOMatchData)
             throws DeviceException

Add a complete APN configuration with full parameter set.

Parameters:

name: - @NonNull

apn: - @NonNull

mcc: - @NonNull

mnc: - @NonNull

proxy: - @Nullable, default: null

port: - @Nullable, default: null

MMSProxy: - @Nullable, default: null

MMSPort: - @Nullable, default: null

userName - @Nullable, default: null

server - @Nullable, default: null

password - @Nullable, default: null

MMSC - @Nullable, default: null

authType: - 0,PAP,CHAP,PAP/CHAP @Nullable, default: 0

protocol: - IPV4,IPV6,IPV4/IPV6 @Nullable, default: IPV4

roamingProtocol: - IPV4,IPV6,IPV4/IPV6 @Nullable, default: IPV4

type: - @Nullable, default: null

bearer: - @Nullable, default: 0

MVNOType: - @Nullable, default: ""

MVNOMatchData - @Nullable, default: null

Returns:

"succeed" if inserted

Throws:

DeviceException

addByMCCAndMNC

String addByMCCAndMNC(String name,
                      String apn,
                      String mcc,
                      String mnc)
               throws DeviceException

Add APN with specified MCC and MNC.

Parameters:

name - APN display name.

apn - APN address.

mcc - Mobile Country Code.

mnc - Mobile Network Code.

Returns:

"succeed" if APN was successfully inserted.

Throws:

DeviceException - if operation fails.

clear

boolean clear()
       throws DeviceException

Remove all APN configurations.

Returns:

true if cleared successfully.

Throws:

DeviceException - if operation fails.

clearWithSlot

boolean clearWithSlot(int slot)
               throws DeviceException

Remove all APN configurations for a specific SIM slot.

Parameters:

slot - SIM slot index.

Returns:

true if cleared successfully.

Throws:

DeviceException - if operation fails.

getSelected

Map getSelected()
         throws DeviceException

Get currently selected APN information.

Returns:

A map containing current APN configuration fields.

Throws:

DeviceException - if operation fails.

query

List query(String columnName,
           String value)
    throws DeviceException

Query APN configurations by column name and value.

Parameters:

columnName - Column name to query.

value - Column value to match.

Returns:

List of APN records matching the query.

Throws:

DeviceException - if operation fails.

queryByName

List queryByName(String value)
          throws DeviceException

Query APN configurations by APN name.

Parameters:

value - APN name to match.

Returns:

List of APN records.

Throws:

DeviceException - if operation fails.

removeByID

boolean removeByID(int id)
            throws DeviceException

Remove an APN configuration by ID.

Parameters:

id - APN record ID.

Returns:

true if removed successfully.

Throws:

DeviceException - if operation fails.

removeByName

boolean removeByName(String name)
              throws DeviceException

Remove an APN configuration by APN name.

Parameters:

name - APN display name.

Returns:

true if removed successfully.

Throws:

DeviceException - if operation fails.

setSelected

boolean setSelected(String name)
             throws DeviceException

Set the specified APN as the currently active APN.

Parameters:

name - APN display name to be selected.

Returns:

true if selection succeeds.

Throws:

DeviceException - if operation fails.