ModemConfiguration

java.lang.Object
- com.esf.device.modem.configuration.ModemConfiguration

```
public class ModemConfiguration
extends java.lang.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

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ADD_DEFAULT_ROUTE`
`static java.lang.String`	`ALLOW_BSD_COMP`
`static java.lang.String`	`ALLOW_DEFLATE_COMP`
`static java.lang.String`	`ALLOW_MAGIC`
`static java.lang.String`	`ALLOW_PROXY_ARPS`
`static java.lang.String`	`ALLOW_VJ_CONNID_COMP`
`static java.lang.String`	`ALLOW_VJ_TCPIP_HDR_COMP`
`static java.lang.String`	`APN` the APN to use with this provider/carrier
`static java.lang.String`	`AUTH_TYPE` the authentication type to use (e.g. pap or chap)
`static java.lang.String`	`BAUDRATE`
`static java.lang.String`	`CARRIER_IMAGE_ID` Carrier image ID on MC8355
`static java.lang.String`	`CONNECT_DELAY`
`static java.lang.String`	`DEBUG_ENABLE`
`static java.lang.String`	`DIALSTRING` dialstring to use for this modem
`static java.lang.String`	`ENABLED` whether or not the modem is enabled
`static java.lang.String`	`IPCP_ACCEPT_LOCAL`
`static java.lang.String`	`IPCP_ACCEPT_REMOTE`
`static java.lang.String`	`LCP_ECHO_FAILURE`
`static java.lang.String`	`LCP_ECHO_INTERVAL`
`static java.lang.String`	`LOCK_SERIAL_DEVICE`
`static java.lang.String`	`LOGFILE`
`static java.lang.String`	`MODEL` the modem model number
`static java.lang.String`	`NETWORK_TECHNOLOGY` the network technology
`static java.lang.String`	`NUMBER_OF_MODEMS` number of modems on this system
`static java.lang.String`	`PASSWORD` the password to use if authentication is required
`static java.lang.String`	`PDP_TYPE` PDP type
`static java.lang.String`	`PEER_MUST_AUTHENTICATE_ITSELF`
`static java.lang.String`	`PEER_SUPPLIES_LOCAL_IP`
`static java.lang.String`	`PERSISTENCE` whether or not the configuration should be persisted in non-volatile RAM
`static java.lang.String`	`PPP_UNIT_NUMBER` ppp unit number (e.g. ppp0 would be 0, ppp1 would be 1)
`static java.lang.String`	`PRODUCT_ID` modem product id
`static java.lang.String`	`PROFILE_NAME` the profile name
`static java.lang.String`	`SERIAL_MODEM_TYPE` type of serial modem
`static java.lang.String`	`SERIAL_NUMBER` the modem serial number
`static java.lang.String`	`SERVICE_MODE` type of cellular service (i.e.
`static java.lang.String`	`SERVICE_PROVIDER` cellular provider/carrier name
`static java.lang.String`	`UMTS_PROFILE_ID` UMTS profile ID
`static java.lang.String`	`USB_PORT_ADDRESS` USB port address of this modem
`static java.lang.String`	`USE_DEFAULT_PEER_PARAM` whether or not to use the default ppp peer parameters
`static java.lang.String`	`USE_MODEM_CTRL_LINES`
`static java.lang.String`	`USE_PEER_DNS`
`static java.lang.String`	`USE_RTS_CTS_FLOWCTRL`
`static java.lang.String`	`USERNAME` the username to use if authentication is required
`static java.lang.String`	`VENDOR_ID` modem vendor id

Constructor Summary

Constructors
Constructor and Description

ModemConfiguration()
ModemConfiguration constructor

ModemConfiguration(java.util.Properties configProps)
ModemConfiguration constructor

Constructors
Constructor and Description
`ModemConfiguration()` ModemConfiguration constructor
`ModemConfiguration(java.util.Properties configProps)` ModemConfiguration constructor

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getApn()` Reports APN
`java.lang.String`	`getAuthenticationType()` Reports authentication type
`java.util.Properties`	`getConfigProps()` Reports configuration properties attached
`java.lang.String`	`getDialString()` Reports dialstring
`java.lang.String`	`getPassword()` Reports password
`java.lang.String`	`getPdpType()`
`int`	`getPppUnitNumber()` Reports PPP unit number (e.g. number of ppp interface)
`java.lang.String`	`getProfileName()`
`java.lang.String`	`getProvider()` Reports service provider
`int`	`getServiceMode()` Reports cellular service mode.
`java.lang.String`	`getUsername()` Reports username
`boolean`	`isEnabled()` Reports if modem is enabled in configuration

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ENABLED
```
public static final java.lang.String ENABLED
```
    whether or not the modem is enabled
    
    See Also:
    Constant Field Values
  - SERVICE_MODE
```
public static final java.lang.String SERVICE_MODE
```
    type of cellular service (i.e. CDMA, HSPA, WiMAX)
    
    See Also:
    Constant Field Values
  - CARRIER_IMAGE_ID
```
public static final java.lang.String CARRIER_IMAGE_ID
```
    Carrier image ID on MC8355
    
    See Also:
    Constant Field Values
  - UMTS_PROFILE_ID
```
public static final java.lang.String UMTS_PROFILE_ID
```
    UMTS profile ID
    
    See Also:
    Constant Field Values
  - NUMBER_OF_MODEMS
```
public static final java.lang.String NUMBER_OF_MODEMS
```
    number of modems on this system
    
    See Also:
    Constant Field Values
  - PPP_UNIT_NUMBER
```
public static final java.lang.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 java.lang.String USB_PORT_ADDRESS
```
    USB port address of this modem
    
    See Also:
    Constant Field Values
  - SERIAL_MODEM_TYPE
```
public static final java.lang.String SERIAL_MODEM_TYPE
```
    type of serial modem
    
    See Also:
    Constant Field Values
  - VENDOR_ID
```
public static final java.lang.String VENDOR_ID
```
    modem vendor id
    
    See Also:
    Constant Field Values
  - PRODUCT_ID
```
public static final java.lang.String PRODUCT_ID
```
    modem product id
    
    See Also:
    Constant Field Values
  - USE_DEFAULT_PEER_PARAM
```
public static final java.lang.String USE_DEFAULT_PEER_PARAM
```
    whether or not to use the default ppp peer parameters
    
    See Also:
    Constant Field Values
  - SERVICE_PROVIDER
```
public static final java.lang.String SERVICE_PROVIDER
```
    cellular provider/carrier name
    
    See Also:
    Constant Field Values
  - DIALSTRING
```
public static final java.lang.String DIALSTRING
```
    dialstring to use for this modem
    
    See Also:
    Constant Field Values
  - PERSISTENCE
```
public static final java.lang.String PERSISTENCE
```
    whether or not the configuration should be persisted in non-volatile RAM
    
    See Also:
    Constant Field Values
  - PROFILE_NAME
```
public static final java.lang.String PROFILE_NAME
```
    the profile name
    
    See Also:
    Constant Field Values
  - PDP_TYPE
```
public static final java.lang.String PDP_TYPE
```
    PDP type
    
    See Also:
    Constant Field Values
  - APN
```
public static final java.lang.String APN
```
    the APN to use with this provider/carrier
    
    See Also:
    Constant Field Values
  - AUTH_TYPE
```
public static final java.lang.String AUTH_TYPE
```
    the authentication type to use (e.g. pap or chap)
    
    See Also:
    Constant Field Values
  - USERNAME
```
public static final java.lang.String USERNAME
```
    the username to use if authentication is required
    
    See Also:
    Constant Field Values
  - PASSWORD
```
public static final java.lang.String PASSWORD
```
    the password to use if authentication is required
    
    See Also:
    Constant Field Values
  - MODEL
```
public static final java.lang.String MODEL
```
    the modem model number
    
    See Also:
    Constant Field Values
  - SERIAL_NUMBER
```
public static final java.lang.String SERIAL_NUMBER
```
    the modem serial number
    
    See Also:
    Constant Field Values
  - NETWORK_TECHNOLOGY
```
public static final java.lang.String NETWORK_TECHNOLOGY
```
    the network technology
    
    See Also:
    Constant Field Values
  - LOGFILE
```
public static final java.lang.String LOGFILE
```
    See Also:
    Constant Field Values
  - BAUDRATE
```
public static final java.lang.String BAUDRATE
```
    See Also:
    Constant Field Values
  - DEBUG_ENABLE
```
public static final java.lang.String DEBUG_ENABLE
```
    See Also:
    Constant Field Values
  - USE_RTS_CTS_FLOWCTRL
```
public static final java.lang.String USE_RTS_CTS_FLOWCTRL
```
    See Also:
    Constant Field Values
  - LOCK_SERIAL_DEVICE
```
public static final java.lang.String LOCK_SERIAL_DEVICE
```
    See Also:
    Constant Field Values
  - PEER_MUST_AUTHENTICATE_ITSELF
```
public static final java.lang.String PEER_MUST_AUTHENTICATE_ITSELF
```
    See Also:
    Constant Field Values
  - ADD_DEFAULT_ROUTE
```
public static final java.lang.String ADD_DEFAULT_ROUTE
```
    See Also:
    Constant Field Values
  - USE_PEER_DNS
```
public static final java.lang.String USE_PEER_DNS
```
    See Also:
    Constant Field Values
  - ALLOW_PROXY_ARPS
```
public static final java.lang.String ALLOW_PROXY_ARPS
```
    See Also:
    Constant Field Values
  - ALLOW_VJ_TCPIP_HDR_COMP
```
public static final java.lang.String ALLOW_VJ_TCPIP_HDR_COMP
```
    See Also:
    Constant Field Values
  - ALLOW_VJ_CONNID_COMP
```
public static final java.lang.String ALLOW_VJ_CONNID_COMP
```
    See Also:
    Constant Field Values
  - ALLOW_BSD_COMP
```
public static final java.lang.String ALLOW_BSD_COMP
```
    See Also:
    Constant Field Values
  - ALLOW_DEFLATE_COMP
```
public static final java.lang.String ALLOW_DEFLATE_COMP
```
    See Also:
    Constant Field Values
  - ALLOW_MAGIC
```
public static final java.lang.String ALLOW_MAGIC
```
    See Also:
    Constant Field Values
  - CONNECT_DELAY
```
public static final java.lang.String CONNECT_DELAY
```
    See Also:
    Constant Field Values
  - LCP_ECHO_FAILURE
```
public static final java.lang.String LCP_ECHO_FAILURE
```
    See Also:
    Constant Field Values
  - LCP_ECHO_INTERVAL
```
public static final java.lang.String LCP_ECHO_INTERVAL
```
    See Also:
    Constant Field Values
  - USE_MODEM_CTRL_LINES
```
public static final java.lang.String USE_MODEM_CTRL_LINES
```
    See Also:
    Constant Field Values
  - PEER_SUPPLIES_LOCAL_IP
```
public static final java.lang.String PEER_SUPPLIES_LOCAL_IP
```
    See Also:
    Constant Field Values
  - IPCP_ACCEPT_LOCAL
```
public static final java.lang.String IPCP_ACCEPT_LOCAL
```
    See Also:
    Constant Field Values
  - IPCP_ACCEPT_REMOTE
```
public static final java.lang.String IPCP_ACCEPT_REMOTE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ModemConfiguration
```
public ModemConfiguration()
```
    ModemConfiguration constructor
  - ModemConfiguration
```
public ModemConfiguration(java.util.Properties configProps)
```
    ModemConfiguration constructor
    
    Parameters:
    configProps - - configuration properties as Properties
- Method Detail
  - getConfigProps
```
public java.util.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
  - getProvider
```
public java.lang.String getProvider()
```
    Reports service provider
    
    Returns:
    service provider as String
  - getDialString
```
public java.lang.String getDialString()
```
    Reports dialstring
    
    Returns:
    dialstring as String
  - getApn
```
public java.lang.String getApn()
```
    Reports APN
    
    Returns:
    APN as String
  - getAuthenticationType
```
public java.lang.String getAuthenticationType()
```
    Reports authentication type
    
    Returns:
    authentication type as String
  - getUsername
```
public java.lang.String getUsername()
```
    Reports username
    
    Returns:
    username as String
  - getPassword
```
public java.lang.String getPassword()
```
    Reports password
    
    Returns:
    password as String
  - getProfileName
```
public java.lang.String getProfileName()
```
  - getPdpType
```
public java.lang.String getPdpType()
```

Class ModemConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENABLED

SERVICE_MODE

CARRIER_IMAGE_ID

UMTS_PROFILE_ID

NUMBER_OF_MODEMS

PPP_UNIT_NUMBER

USB_PORT_ADDRESS

SERIAL_MODEM_TYPE

VENDOR_ID

PRODUCT_ID

USE_DEFAULT_PEER_PARAM

SERVICE_PROVIDER

DIALSTRING

PERSISTENCE

PROFILE_NAME

PDP_TYPE

APN

AUTH_TYPE

USERNAME

PASSWORD

MODEL

SERIAL_NUMBER

NETWORK_TECHNOLOGY

LOGFILE

BAUDRATE

DEBUG_ENABLE

USE_RTS_CTS_FLOWCTRL

LOCK_SERIAL_DEVICE

PEER_MUST_AUTHENTICATE_ITSELF

ADD_DEFAULT_ROUTE

USE_PEER_DNS

ALLOW_PROXY_ARPS

ALLOW_VJ_TCPIP_HDR_COMP

ALLOW_VJ_CONNID_COMP

ALLOW_BSD_COMP

ALLOW_DEFLATE_COMP

ALLOW_MAGIC

CONNECT_DELAY

LCP_ECHO_FAILURE

LCP_ECHO_INTERVAL

USE_MODEM_CTRL_LINES

PEER_SUPPLIES_LOCAL_IP

IPCP_ACCEPT_LOCAL

IPCP_ACCEPT_REMOTE

Constructor Detail

ModemConfiguration

ModemConfiguration

Method Detail

getConfigProps

isEnabled

getServiceMode

getPppUnitNumber

getProvider

getDialString

getApn

getAuthenticationType

getUsername

getPassword

getProfileName

getPdpType