Class APN

Object
APN

public class APN
extends Object
A set of parameters used to hand over to the Access Point Name (APN) configuration related methods of the CASIO Enterprise Developer Tools:

Since the above mentioned methods use a variable set of parameters with overlapping parameter types, overloading methods or using variable argument lists isn't feasible.
Instead, instances of this class hold sets of all required parameters for these methods.

Use APN.Builder to create new instances.

Since:
1.00
  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  APN.Builder
    Provides a convenient way to set the fields of a APN object when creating a new instance, following the Builder pattern.
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static int AUTH_TYPE_CHAP
    Authentication type for CHAP. - this is one of the possible values of the authType field of the Access Point Name (APN) configuration
    static int AUTH_TYPE_NONE
    No Authentication type - this is one of the possible values of the authType field of the Access Point Name (APN) configuration
    static int AUTH_TYPE_PAP
    Authentication type for PAP. - this is one of the possible values of the authType field of the Access Point Name (APN) configuration
    static int AUTH_TYPE_PAP_OR_CHAP
    Authentication type for either PAP or CHAP. - this is one of the possible values of the authType field of the Access Point Name (APN) configuration
    static int AUTH_TYPE_UNKNOWN
    Unknown Authentication type - this is one of the possible values of the authType field of the Access Point Name (APN) configuration
    static int INVALID_APN
    Invalid Authentication type (for internal use only). - this is one of the possible values of the authType field of the Access Point Name (APN) configuration
  • Method Summary

    Modifier and Type Method Description
    String getApn()
    Returns the APN name of the Access Point Name (APN) configuration.
    int getAuthType()
    Returns the Authentication Type of the Access Point Name (APN) configuration.
    String getCurrent()
    Returns the APN currently being in use of the Access Point Name (APN) configuration.
    int getId()
    Returns the "id" field of the Access Point Name (APN) configuration.
    String getMcc()
    Returns the Mobile Country Code of the Access Point Name (APN) configuration.
    String getMmsc()
    Returns the MMSC (Multimedia Messaging Service Center) of the Access Point Name (APN) configuration.
    String getMmsPort()
    Returns the MMS Proxy Port of the Access Point Name (APN) configuration.
    String getMmsProxy()
    Returns the MMS Proxy URL of the Access Point Name (APN) configuration.
    String getMnc()
    Returns the Mobile Network Code of the Access Point Name (APN) configuration.
    String getName()
    Returns the name of the Access Point Name (APN) configuration.
    String getPassword()
    Returns APN password of the Access Point Name (APN) configuration.
    String getPort()
    Returns the Server's Port of the Access Point Name (APN) configuration.
    String getProxy()
    Returns the Proxy URL of the Access Point Name (APN) configuration.
    String getServer()
    Returns the APN Server of the Access Point Name (APN) configuration.
    String getType()
    Returns the Type of the Access Point Name (APN) configuration.
    String getUser()
    RReturns the APN username of the Access Point Name (APN) configuration.
    static APN.Builder setName​(String name)
    Since APN uses the Builder pattern with a mandatory name field, there's no public constructor available.
    Instead, this method is used to create a new instance of the Builder of this class.
    In order to finally instantiate a APN object, call the build() method of the builder when all optional chaining has been done.
  • Field Details

    • AUTH_TYPE_UNKNOWN

      public static final int AUTH_TYPE_UNKNOWN
      Unknown Authentication type - this is one of the possible values of the authType field of the Access Point Name (APN) configuration
      Since:
      1.00
      See Also:
      Constant Field Values
    • AUTH_TYPE_NONE

      public static final int AUTH_TYPE_NONE
      No Authentication type - this is one of the possible values of the authType field of the Access Point Name (APN) configuration
      Since:
      1.00
      See Also:
      Constant Field Values
    • AUTH_TYPE_PAP

      public static final int AUTH_TYPE_PAP
      Authentication type for PAP. - this is one of the possible values of the authType field of the Access Point Name (APN) configuration
      Since:
      1.00
      See Also:
      Constant Field Values
    • AUTH_TYPE_CHAP

      public static final int AUTH_TYPE_CHAP
      Authentication type for CHAP. - this is one of the possible values of the authType field of the Access Point Name (APN) configuration
      Since:
      1.00
      See Also:
      Constant Field Values
    • AUTH_TYPE_PAP_OR_CHAP

      public static final int AUTH_TYPE_PAP_OR_CHAP
      Authentication type for either PAP or CHAP. - this is one of the possible values of the authType field of the Access Point Name (APN) configuration
      Since:
      1.00
      See Also:
      Constant Field Values
    • INVALID_APN

      public static final int INVALID_APN
      Invalid Authentication type (for internal use only). - this is one of the possible values of the authType field of the Access Point Name (APN) configuration
      Since:
      1.00
      See Also:
      Constant Field Values
  • Method Details

    • setName

      public static APN.Builder setName​(String name)
      Since APN uses the Builder pattern with a mandatory name field, there's no public constructor available.
      Instead, this method is used to create a new instance of the Builder of this class.
      In order to finally instantiate a APN object, call the build() method of the builder when all optional chaining has been done.
      Parameters:
      name - String: The name to apply to the new Access Point Name (APN) configuration. Providing a name is mandatory.
      Returns:
      The instance object of this class, with a mandatory String name set, and further optional fields set from Builder chaining.
      Since:
      1.00
    • getApn

      public String getApn()
      Returns the APN name of the Access Point Name (APN) configuration.
      Returns:
      String: The APN name of the Access Point Name (APN) configuration.
      If this field has not been set, the return value is an empty String.
      Since:
      1.00
    • getAuthType

      public int getAuthType()
      Returns the Authentication Type of the Access Point Name (APN) configuration.
      Returns:
      int: The Authentication Type of the Access Point Name (APN) configuration.
      If this field has not been set, the return value is an empty String.
      Since:
      1.00
    • getCurrent

      public String getCurrent()
      Returns the APN currently being in use of the Access Point Name (APN) configuration.
      Returns:
      String: The APN currently being in use of the Access Point Name (APN) configuration.
      If this field has not been set, the return value is an empty String.
      Since:
      1.00
    • getId

      public int getId()
      Returns the "id" field of the Access Point Name (APN) configuration.
      Returns:
      int: The "id" field of the Access Point Name (APN) configuration or INVALID_APN (-1) if no ID has been set.
      Since:
      1.00
    • getMcc

      public String getMcc()
      Returns the Mobile Country Code of the Access Point Name (APN) configuration.
      Returns:
      String: The Mobile Country Code of the Access Point Name (APN) configuration.
      If this field has not been set, the return value is an empty String.
      Since:
      1.00
    • getMmsPort

      public String getMmsPort()
      Returns the MMS Proxy Port of the Access Point Name (APN) configuration.
      Returns:
      String: The MMS Proxy Port of the Access Point Name (APN) configuration.
      If this field has not been set, the return value is an empty String.
      Since:
      1.00
    • getMmsProxy

      public String getMmsProxy()
      Returns the MMS Proxy URL of the Access Point Name (APN) configuration.
      Returns:
      String: The MMS Proxy URL of the Access Point Name (APN) configuration.
      If this field has not been set, the return value is an empty String.
      Since:
      1.00
    • getMmsc

      public String getMmsc()
      Returns the MMSC (Multimedia Messaging Service Center) of the Access Point Name (APN) configuration.
      Returns:
      String: The MMSC (Multimedia Messaging Service Center) of the Access Point Name (APN) configuration.
      If this field has not been set, the return value is an empty String.
      Since:
      1.00
    • getMnc

      public String getMnc()
      Returns the Mobile Network Code of the Access Point Name (APN) configuration.
      Returns:
      String: The Mobile Network Code of the Access Point Name (APN) configuration.
      If this field has not been set, the return value is an empty String.
      Since:
      1.00
    • getName

      public String getName()
      Returns the name of the Access Point Name (APN) configuration.
      Returns:
      String: The name of the Access Point Name (APN) configuration.
      If this field has not been set, the return value is an empty String.
      Since:
      1.00
    • getPassword

      public String getPassword()
      Returns APN password of the Access Point Name (APN) configuration.
      Returns:
      String: The APN password of the Access Point Name (APN) configuration.
      If this field has not been set, the return value is an empty String.
      Since:
      1.00
    • getPort

      public String getPort()
      Returns the Server's Port of the Access Point Name (APN) configuration.
      Returns:
      String: The Server's Port of the Access Point Name (APN) configuration.
      If this field has not been set, the return value is an empty String.
      Since:
      1.00
    • getProxy

      public String getProxy()
      Returns the Proxy URL of the Access Point Name (APN) configuration.
      Returns:
      String: The Proxy URL of the Access Point Name (APN) configuration.
      If this field has not been set, the return value is an empty String.
      Since:
      1.00
    • getServer

      public String getServer()
      Returns the APN Server of the Access Point Name (APN) configuration.
      Returns:
      String: The APN Server of the Access Point Name (APN) configuration.
      If this field has not been set, the return value is an empty String.
      Since:
      1.00
    • getType

      public String getType()
      Returns the Type of the Access Point Name (APN) configuration.
      Returns:
      String: The Type of the Access Point Name (APN) configuration.
      If this field has not been set, the return value is an empty String.
      Since:
      1.00
      API Note:
      Valid settings are e.g. "default", "supl" and "mms".
      Multiple strings are separated by comma "," character. Default setting is "default,supl".
    • getUser

      public String getUser()
      RReturns the APN username of the Access Point Name (APN) configuration.
      Returns:
      String: The APN username of the Access Point Name (APN) configuration.
      If this field has not been set, the return value is an empty String.
      Since:
      1.00