com.eurotech.framework.net.admin.modem
Class ModemConfiguration

java.lang.Object
  extended by com.eurotech.framework.net.admin.modem.ModemConfiguration

public class ModemConfiguration
extends Object

Defines modem configuration object that each modem will return in the provideConfiguration() method. This object will be piked up by the CellularConnectionManager. Copyright (c) 2011 Eurotech Inc. All rights reserved.


Field Summary
static String ADD_DEFAULT_ROUTE
           
static String ALLOW_BSD_COMP
           
static String ALLOW_DEFLATE_COMP
           
static String ALLOW_MAGIC
           
static String ALLOW_PROXY_ARPS
           
static String ALLOW_VJ_CONNID_COMP
           
static String ALLOW_VJ_TCPIP_HDR_COMP
           
static String ALLOWED_FREQ_BANDS
          Allowed frequency bands
static String APN
          the APN to use with this provider/carrier
static String AUTH_TYPE
          the authentication type to use (e.g.
static String BAUDRATE
           
static String CARRIER_IMAGE_ID
          Carrier image ID on MC8355
static String CONNECT_DELAY
           
static String DEBUG_ENABLE
           
static String DIALSTRING
          dialstring to use for this modem
static String ENABLED
          whether or not the modem is enabled
static String FREQ_BAND
          Frequency band
static String IPCP_ACCEPT_LOCAL
           
static String IPCP_ACCEPT_REMOTE
           
static String LCP_ECHO_FAILURE
           
static String LCP_ECHO_INTERVAL
           
static String LOCK_SERIAL_DEVICE
           
static String LOGFILE
           
static String MODEL
          the modem model number
static String NETWORK_TECHNOLOGY
          the network technology
static String NUMBER_OF_MODEMS
          number of modems on this system
static String PASSWORD
          the password to use if authentication is required
static String PDP_PROFILE_ID
          ID of selected PDP profile
static String PDP_PROFILES
          PDP Profiles
static String PDP_TYPE
          PDP type
static String PEER_MUST_AUTHENTICATE_ITSELF
           
static String PEER_SUPPLIES_LOCAL_IP
           
static String PERSISTENCE
          whether or not the configuration should be persisted in non-volatile RAM
static String PPP_UNIT_NUMBER
          ppp unit number (e.g.
static String PRODUCT_ID
          modem product id
static String PROFILE_NAME
          the profile name
static String SERIAL_MODEM_TYPE
          type of serial modem
static String SERIAL_NUMBER
          the modem serial number
static String SERVICE_MODE
          type of cellular service (i.e.
static String UMTS_PROFILE_ID
          UMTS profile ID
static String USB_PORT_ADDRESS
          USB port address of this modem
static String USE_DEFAULT_PEER_PARAM
          whether or not to use the default ppp peer parameters
static String USE_MODEM_CTRL_LINES
           
static String USE_PEER_DNS
           
static String USE_RTS_CTS_FLOWCTRL
           
static String USERNAME
          the username to use if authentication is required
static String VENDOR_ID
          modem vendor id
 
Constructor Summary
ModemConfiguration()
          ModemConfiguration constructor
ModemConfiguration(Properties configProps)
          ModemConfiguration constructor
 
Method Summary
 String getApn()
          Reports APN
 String getAuthenticationType()
          Reports authentication type
 Properties getConfigProps()
          Reports configuration properties attached
 String getDialString()
          Reports dialstring
 String getFreqBand()
           
 String getPassword()
          Reports password
 int getPdpProfileID()
           
 String getPdpType()
           
 int getPppUnitNumber()
          Reports PPP unit number (e.g.
 String getProfileName()
           
 int getServiceMode()
          Reports cellular service mode.
 String getUsername()
          Reports username
 boolean isEnabled()
          Reports if modem is enabled in configuration
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ENABLED

public static final String ENABLED
whether or not the modem is enabled

See Also:
Constant Field Values

SERVICE_MODE

public static final String SERVICE_MODE
type of cellular service (i.e. CDMA, HSPA, WiMAX)

See Also:
Constant Field Values

CARRIER_IMAGE_ID

public static final String CARRIER_IMAGE_ID
Carrier image ID on MC8355

See Also:
Constant Field Values

UMTS_PROFILE_ID

public static final String UMTS_PROFILE_ID
UMTS profile ID

See Also:
Constant Field Values

NUMBER_OF_MODEMS

public static final String NUMBER_OF_MODEMS
number of modems on this system

See Also:
Constant Field Values

PPP_UNIT_NUMBER

public static final String PPP_UNIT_NUMBER
ppp unit number (e.g. ppp0 would be 0, ppp1 would be 1)

See Also:
Constant Field Values

USB_PORT_ADDRESS

public static final String USB_PORT_ADDRESS
USB port address of this modem

See Also:
Constant Field Values

SERIAL_MODEM_TYPE

public static final String SERIAL_MODEM_TYPE
type of serial modem

See Also:
Constant Field Values

VENDOR_ID

public static final String VENDOR_ID
modem vendor id

See Also:
Constant Field Values

PRODUCT_ID

public static final String PRODUCT_ID
modem product id

See Also:
Constant Field Values

USE_DEFAULT_PEER_PARAM

public static final String USE_DEFAULT_PEER_PARAM
whether or not to use the default ppp peer parameters

See Also:
Constant Field Values

DIALSTRING

public static final String DIALSTRING
dialstring to use for this modem

See Also:
Constant Field Values

PERSISTENCE

public static final String PERSISTENCE
whether or not the configuration should be persisted in non-volatile RAM

See Also:
Constant Field Values

PROFILE_NAME

public static final String PROFILE_NAME
the profile name

See Also:
Constant Field Values

PDP_TYPE

public static final String PDP_TYPE
PDP type

See Also:
Constant Field Values

FREQ_BAND

public static final String FREQ_BAND
Frequency band

See Also:
Constant Field Values

ALLOWED_FREQ_BANDS

public static final String ALLOWED_FREQ_BANDS
Allowed frequency bands

See Also:
Constant Field Values

PDP_PROFILES

public static final String PDP_PROFILES
PDP Profiles

See Also:
Constant Field Values

PDP_PROFILE_ID

public static final String PDP_PROFILE_ID
ID of selected PDP profile

See Also:
Constant Field Values

APN

public static final String APN
the APN to use with this provider/carrier

See Also:
Constant Field Values

AUTH_TYPE

public static final String AUTH_TYPE
the authentication type to use (e.g. pap or chap)

See Also:
Constant Field Values

USERNAME

public static final String USERNAME
the username to use if authentication is required

See Also:
Constant Field Values

PASSWORD

public static final String PASSWORD
the password to use if authentication is required

See Also:
Constant Field Values

MODEL

public static final String MODEL
the modem model number

See Also:
Constant Field Values

SERIAL_NUMBER

public static final String SERIAL_NUMBER
the modem serial number

See Also:
Constant Field Values

NETWORK_TECHNOLOGY

public static final String NETWORK_TECHNOLOGY
the network technology

See Also:
Constant Field Values

LOGFILE

public static final String LOGFILE
See Also:
Constant Field Values

BAUDRATE

public static final String BAUDRATE
See Also:
Constant Field Values

DEBUG_ENABLE

public static final String DEBUG_ENABLE
See Also:
Constant Field Values

USE_RTS_CTS_FLOWCTRL

public static final String USE_RTS_CTS_FLOWCTRL
See Also:
Constant Field Values

LOCK_SERIAL_DEVICE

public static final String LOCK_SERIAL_DEVICE
See Also:
Constant Field Values

PEER_MUST_AUTHENTICATE_ITSELF

public static final String PEER_MUST_AUTHENTICATE_ITSELF
See Also:
Constant Field Values

ADD_DEFAULT_ROUTE

public static final String ADD_DEFAULT_ROUTE
See Also:
Constant Field Values

USE_PEER_DNS

public static final String USE_PEER_DNS
See Also:
Constant Field Values

ALLOW_PROXY_ARPS

public static final String ALLOW_PROXY_ARPS
See Also:
Constant Field Values

ALLOW_VJ_TCPIP_HDR_COMP

public static final String ALLOW_VJ_TCPIP_HDR_COMP
See Also:
Constant Field Values

ALLOW_VJ_CONNID_COMP

public static final String ALLOW_VJ_CONNID_COMP
See Also:
Constant Field Values

ALLOW_BSD_COMP

public static final String ALLOW_BSD_COMP
See Also:
Constant Field Values

ALLOW_DEFLATE_COMP

public static final String ALLOW_DEFLATE_COMP
See Also:
Constant Field Values

ALLOW_MAGIC

public static final String ALLOW_MAGIC
See Also:
Constant Field Values

CONNECT_DELAY

public static final String CONNECT_DELAY
See Also:
Constant Field Values

LCP_ECHO_FAILURE

public static final String LCP_ECHO_FAILURE
See Also:
Constant Field Values

LCP_ECHO_INTERVAL

public static final String LCP_ECHO_INTERVAL
See Also:
Constant Field Values

USE_MODEM_CTRL_LINES

public static final String USE_MODEM_CTRL_LINES
See Also:
Constant Field Values

PEER_SUPPLIES_LOCAL_IP

public static final String PEER_SUPPLIES_LOCAL_IP
See Also:
Constant Field Values

IPCP_ACCEPT_LOCAL

public static final String IPCP_ACCEPT_LOCAL
See Also:
Constant Field Values

IPCP_ACCEPT_REMOTE

public static final String IPCP_ACCEPT_REMOTE
See Also:
Constant Field Values
Constructor Detail

ModemConfiguration

public ModemConfiguration()
ModemConfiguration constructor


ModemConfiguration

public ModemConfiguration(Properties configProps)
ModemConfiguration constructor

Parameters:
configProps - - configuration properties as Properties
Method Detail

getConfigProps

public Properties getConfigProps()
Reports configuration properties attached

Returns:
configuration properties as Properties

isEnabled

public boolean isEnabled()
Reports if modem is enabled in configuration

Returns:
boolean
true - modem is enables
false - modem is disabled

getServiceMode

public int getServiceMode()
Reports cellular service mode.

Returns:
cellular service mode as int

getPppUnitNumber

public int getPppUnitNumber()
Reports PPP unit number (e.g. number of ppp interface)

Returns:
PPP unit number as int

getDialString

public String getDialString()
Reports dialstring

Returns:
dialstring as String

getApn

public String getApn()
Reports APN

Returns:
APN as String

getAuthenticationType

public String getAuthenticationType()
Reports authentication type

Returns:
authentication type as String

getUsername

public String getUsername()
Reports username

Returns:
username as String

getPassword

public String getPassword()
Reports password

Returns:
password as String

getProfileName

public String getProfileName()

getPdpType

public String getPdpType()

getFreqBand

public String getFreqBand()

getPdpProfileID

public int getPdpProfileID()


Copyright © 2013. All Rights Reserved.