ModemConfig (Eclipse Kura 3.2.0)

java.lang.Object
- org.eclipse.kura.net.modem.ModemConfig

All Implemented Interfaces:: NetConfig

@ProviderType
public class ModemConfig
extends java.lang.Object
implements NetConfig

Modem configuration representation

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ModemConfig.AuthType

static class ModemConfig.PdpType
Configuration for a cellular modem.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ModemConfig.AuthType`
`static class`	`ModemConfig.PdpType` Configuration for a cellular modem.

Constructor Summary

Constructors
Constructor and Description
`ModemConfig()` Empty constructor
`ModemConfig(int profileID, ModemConfig.PdpType pdpType, java.lang.String apn, IPAddress ipAddress, int dataCompression, int headerCompresion)` PDP config constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getActiveFilter()` Reports the value of the 'active-filter' option that specifies a packet filter to be applied to data packets to determine which packets are to be regarded as link activity.
`java.lang.String`	`getApn()` Reports access point name.
`ModemConfig.AuthType`	`getAuthType()` Reports authentication type.
`int`	`getDataCompression()` Reports a value of numeric parameter that supports PDP data compression.
`java.lang.String`	`getDialString()` Gets the dial string.
`int`	`getHeaderCompression()` Reports a value of numeric parameter that supports PDP header compression.
`int`	`getIdle()` Reports value of the 'idle' option.
`IPAddress`	`getIpAddress()` Reports PDP IP address.
`int`	`getLcpEchoFailure()` Reports number of failed LCP echo requests
`int`	`getLcpEchoInterval()` Reports LCP echo interval
`int`	`getMaxFail()` Reports maximum number of failed connection attempts.
`java.lang.String`	`getPassword()` Deprecated.
`Password`	`getPasswordAsPassword()` Reports password.
`ModemConfig.PdpType`	`getPdpType()` Reports PDP type.
`int`	`getPppNumber()` Reports PPP number (i.e.
`int`	`getProfileID()` Reports PDP profile ID.
`int`	`getResetTimeout()`
`java.lang.String`	`getUsername()` Reports user name.
`int`	`hashCode()`
`boolean`	`isDataCompression()` Reports if PDP data compression is enabled.
`boolean`	`isEnabled()` Reports whether it is enabled.
`boolean`	`isGpsEnabled()`
`boolean`	`isHeaderCompression()` Reports if PDP header compression is enabled.
`boolean`	`isPersist()` Reports if pppd is instructed to exit after a connection is terminated.
`boolean`	`isValid()` Checks whether or not this configuration is valid.
`void`	`setActiveFilter(java.lang.String activeFilter)` Sets the value of the 'active-filter' option that specifies a packet filter to be applied to data packets to determine which packets are to be regarded as link activity.
`void`	`setApn(java.lang.String apn)` Sets access point name.
`void`	`setAuthType(ModemConfig.AuthType authType)` Sets authentication type.
`void`	`setDataCompression(int dataCompression)` Sets a value of numeric parameter that supports PDP data compression.
`void`	`setDialString(java.lang.String dialString)` Sets the dial string.
`void`	`setEnabled(boolean enabled)` Sets the enabled setting.
`void`	`setGpsEnabled(boolean gpsEnabled)`
`void`	`setHeaderCompression(int headerCompression)` Sets a value of numeric parameter that supports PDP header compression.
`void`	`setIdle(int idle)` Sets value of the 'idle' option.
`void`	`setIpAddress(IPAddress address)` Sets PDP IP address.
`void`	`setLcpEchoFailure(int lcpEchoFailure)` Sets number of failed LCP echo requests (unacknowledged LCP echo requests to be sent for pppd to presume the peer to be dead)
`void`	`setLcpEchoInterval(int lcpEchoInterval)` Sets LCP echo interval
`void`	`setMaxFail(int maxFail)` Sets maximum number of failed connection attempts
`void`	`setPassword(Password password)` Sets password.
`void`	`setPassword(java.lang.String password)` Sets password.
`void`	`setPdpType(ModemConfig.PdpType pdpType)` Sets PDP type.
`void`	`setPersist(boolean persist)` Sets 'persist' flag to instruct pppd if it needs to exit after a connection is terminated.
`void`	`setPppNumber(int pppNumber)` Sets PPP number (i.e.
`void`	`setProfileID(int id)` Sets PDP profile ID.
`void`	`setResetTimeout(int tout)`
`void`	`setUsername(java.lang.String username)` Sets user name.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ModemConfig
```
public ModemConfig()
```
    Empty constructor
  - ModemConfig
```
public ModemConfig(int profileID,
                   ModemConfig.PdpType pdpType,
                   java.lang.String apn,
                   IPAddress ipAddress,
                   int dataCompression,
                   int headerCompresion)
```
    PDP config constructor
    
    Parameters:
    
    apn - - access point name as String
    
    ipAddress - - IP address as String
    
    profileID - - PDP profile ID as int
    
    pdpType - - PDP type as ModemConfig.PdpType
    
    dataCompression - - PDP data compression as int
    
    headerCompresion - - PDP header compression as int
- Method Detail
  - isEnabled
```
public boolean isEnabled()
```
    Reports whether it is enabled.
    
    Returns:
    
    is enabled as boolean
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Sets the enabled setting.
    
    Parameters:
    
    enabled - - enabled status as boolean
  - getDialString
```
public java.lang.String getDialString()
```
    Gets the dial string.
    
    Returns:
    
    dial string as String
  - setDialString
```
public void setDialString(java.lang.String dialString)
```
    Sets the dial string.
    
    Parameters:
    
    dialString - - dial string as String
  - getAuthType
```
public ModemConfig.AuthType getAuthType()
```
    Reports authentication type.
    
    Returns:
    
    authentication type as ModemConfig.AuthType
  - setAuthType
```
public void setAuthType(ModemConfig.AuthType authType)
```
    Sets authentication type.
    
    Parameters:
    
    authType - - authentication type as ModemConfig.AuthType
  - getUsername
```
public java.lang.String getUsername()
```
    Reports user name.
    
    Returns:
    
    user name as String
  - setUsername
```
public void setUsername(java.lang.String username)
```
    Sets user name.
    
    Parameters:
    
    username - - user name as String
  - getPassword
```
public java.lang.String getPassword()
```
    Deprecated.
    
    Reports password.
    
    Returns:
    
    password as String
  - getPasswordAsPassword
```
public Password getPasswordAsPassword()
```
    Reports password.
    
    Returns:
    
    password as Password
    
    Since:
    
    1.3
  - setPassword
```
public void setPassword(java.lang.String password)
```
    Sets password.
    
    Parameters:
    
    password - - password as String
  - setPassword
```
public void setPassword(Password password)
```
    Sets password.
    
    Parameters:
    
    password - - password as Password
    
    Since:
    
    1.3
  - isPersist
```
public boolean isPersist()
```
    Reports if pppd is instructed to exit after a connection is terminated.
    
    Returns:
    
    'persist' flag boolean
  - setPersist
```
public void setPersist(boolean persist)
```
    Sets 'persist' flag to instruct pppd if it needs to exit after a connection is terminated.
    
    Parameters:
    
    persist - as boolean
  - getMaxFail
```
public int getMaxFail()
```
    Reports maximum number of failed connection attempts.
    
    Returns:
    
    maximum number of failed connection attempts as int
  - setMaxFail
```
public void setMaxFail(int maxFail)
```
    Sets maximum number of failed connection attempts
    
    Parameters:
    
    maxFail - - maximum number of failed connection attempts as int
  - getIdle
```
public int getIdle()
```
    Reports value of the 'idle' option. The 'idle' option specifies that pppd should disconnect if the link is idle for n seconds.
    
    Returns:
    
    value of the 'idle' option as int
  - setIdle
```
public void setIdle(int idle)
```
    Sets value of the 'idle' option. The 'idle' option specifies that pppd should disconnect if the link is idle for n seconds.
    
    Parameters:
    
    idle -
  - getActiveFilter
```
public java.lang.String getActiveFilter()
```
    Reports the value of the 'active-filter' option that specifies a packet filter to be applied to data packets to determine which packets are to be regarded as link activity.
    
    Returns:
    
    value of the 'active-filter' option as String
  - setActiveFilter
```
public void setActiveFilter(java.lang.String activeFilter)
```
    Sets the value of the 'active-filter' option that specifies a packet filter to be applied to data packets to determine which packets are to be regarded as link activity.
    
    Parameters:
    
    activeFilter - - active filter as String
  - getLcpEchoInterval
```
public int getLcpEchoInterval()
```
    Reports LCP echo interval
    
    Returns:
    
    LCP echo interval (in sec) as int
  - setLcpEchoInterval
```
public void setLcpEchoInterval(int lcpEchoInterval)
```
    Sets LCP echo interval
    
    Parameters:
    
    lcpEchoInterval - - LCP Echo interval as int
  - getLcpEchoFailure
```
public int getLcpEchoFailure()
```
    Reports number of failed LCP echo requests
    
    Returns:
    
    number of failed LCP echo requests as int
  - setLcpEchoFailure
```
public void setLcpEchoFailure(int lcpEchoFailure)
```
    Sets number of failed LCP echo requests (unacknowledged LCP echo requests to be sent for pppd to presume the peer to be dead)
    
    Parameters:
    
    lcpEchoFailure -
  - getPppNumber
```
public int getPppNumber()
```
    Reports PPP number (i.e. '0' for ppp0).
    
    Returns:
    
    PPP number as int
  - setPppNumber
```
public void setPppNumber(int pppNumber)
```
    Sets PPP number (i.e. '0' for ppp0).
    
    Parameters:
    
    pppNumber - - PPP number as int
  - getProfileID
```
public int getProfileID()
```
    Reports PDP profile ID.
    
    Returns:
    
    PDP profile ID as int
  - setProfileID
```
public void setProfileID(int id)
```
    Sets PDP profile ID.
    
    Parameters:
    
    id - - PDP profile ID as int
  - getPdpType
```
public ModemConfig.PdpType getPdpType()
```
    Reports PDP type.
    
    Returns:
    
    PDP type as ModemConfig.PdpType
  - setPdpType
```
public void setPdpType(ModemConfig.PdpType pdpType)
```
    Sets PDP type.
    
    Parameters:
    
    pdpType - - PDP type as ModemConfig.PdpType
  - getApn
```
public java.lang.String getApn()
```
    Reports access point name.
    
    Returns:
    
    access point name as String
  - setApn
```
public void setApn(java.lang.String apn)
```
    Sets access point name.
    
    Parameters:
    
    apn - - access point name as String
  - getIpAddress
```
public IPAddress getIpAddress()
```
    Reports PDP IP address.
    
    Returns:
    
    IP address as IPAddress
  - setIpAddress
```
public void setIpAddress(IPAddress address)
```
    Sets PDP IP address.
    
    Parameters:
    
    address - - IP address as IPAddress
  - getDataCompression
```
public int getDataCompression()
```
    Reports a value of numeric parameter that supports PDP data compression.
    
    Returns:
    
    PDP data compression as int
  - setDataCompression
```
public void setDataCompression(int dataCompression)
```
    Sets a value of numeric parameter that supports PDP data compression.
    
    Parameters:
    
    dataCompression - - PDP data compression as int
  - getHeaderCompression
```
public int getHeaderCompression()
```
    Reports a value of numeric parameter that supports PDP header compression.
    
    Returns:
    
    PDP header compression as int
  - setHeaderCompression
```
public void setHeaderCompression(int headerCompression)
```
    Sets a value of numeric parameter that supports PDP header compression.
    
    Parameters:
    
    headerCompression - headerCompression PDP header compression as int
  - isDataCompression
```
public boolean isDataCompression()
```
    Reports if PDP data compression is enabled.
    
    Returns:
    
    boolean
  - isHeaderCompression
```
public boolean isHeaderCompression()
```
    Reports if PDP header compression is enabled.
    
    Returns:
    
    boolean
  - isGpsEnabled
```
public boolean isGpsEnabled()
```
  - getResetTimeout
```
public int getResetTimeout()
```
  - setResetTimeout
```
public void setResetTimeout(int tout)
```
  - setGpsEnabled
```
public void setGpsEnabled(boolean gpsEnabled)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - isValid
```
public boolean isValid()
```
    Description copied from interface: NetConfig
    
    Checks whether or not this configuration is valid.
    
    Specified by:
    
    isValid in interface NetConfig
    
    Returns:
    
    true if the configuration is valid, otherwise false

Class ModemConfig

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ModemConfig

ModemConfig

Method Detail

isEnabled

setEnabled

getDialString

setDialString

getAuthType

setAuthType

getUsername

setUsername

getPassword

getPasswordAsPassword

setPassword

setPassword

isPersist

setPersist

getMaxFail

setMaxFail

getIdle

setIdle

getActiveFilter

setActiveFilter

getLcpEchoInterval

setLcpEchoInterval

getLcpEchoFailure

setLcpEchoFailure

getPppNumber

setPppNumber

getProfileID

setProfileID

getPdpType

setPdpType

getApn

setApn

getIpAddress

setIpAddress

getDataCompression

setDataCompression

getHeaderCompression

setHeaderCompression

isDataCompression

isHeaderCompression

isGpsEnabled

getResetTimeout

setResetTimeout

setGpsEnabled

hashCode

equals

toString

isValid