com.docomo_um.module.net
クラス IPSettingInfo

java.lang.Object
  com.docomo_um.module.net.PDPTypeInfo
      com.docomo_um.module.net.IPSettingInfo

public class IPSettingInfo
extends PDPTypeInfo

IP 情報を表すクラスです。

IPアドレスはIPv4のみ対応しています。

フィールドの概要

static int	ALLOCATING_IP_DYNAMIC IPアドレスの割り当て方式の一つで動的IPアドレス割り当てを表します。
static int	ALLOCATING_IP_STATIC IPアドレスの割り当て方式の一つで固定IPアドレス割り当てを表します。
static int	IP_AUTHENTICATION_CHAP IPの認証方式の一つでCHAP認証を表します。
static int	IP_AUTHENTICATION_NONE IPの認証方式の一つで認証なしを表します。
static int	IP_AUTHENTICATION_PAP IPの認証方式の一つでPAP認証を表します。

クラス com.docomo_um.module.net.PDPTypeInfo から継承されたフィールド

PDP_TYPE_IP, PDP_TYPE_PPP

コンストラクタの概要

IPSettingInfo(int ipAuthentication, java.lang.String userName, java.lang.String password)
IP 情報インスタンスを生成します。

IPSettingInfo(int ipAuthentication, java.lang.String userName, java.lang.String password, java.lang.String ipAddress)
IP 情報インスタンスを生成します。

IPSettingInfo(int ipAuthentication, java.lang.String userName, java.lang.String password, java.lang.String primaryDNS, java.lang.String secondaryDNS)
IP 情報インスタンスを生成します。

IPSettingInfo(int ipAuthentication, java.lang.String userName, java.lang.String password, java.lang.String ipAddress, java.lang.String primaryDNS, java.lang.String secondaryDNS)
IP 情報インスタンスを生成します。

メソッドの概要

int	getAllocatingDNS() DNSサーバのIPアドレスの割り当て方式を取得します。
int	getAllocatingIP() IPアドレスの割り当て方式を取得します。
java.lang.String	getIPAddress() 自ホストのIPアドレスを取得します。
int	getIPAuthentication() IPの認証方式を取得します。
java.lang.String	getPassword() IPの認証に使用するパスワードを取得します。
int	getPDPType() このインスタンスが保持しているPDPタイプを取得します。
java.lang.String	getPrimaryDNS() プライマリDNSのIPアドレスを取得します。
java.lang.String	getSecondaryDNS() セカンダリDNSのIPアドレスを取得します。
java.lang.String	getUserName() IPの認証に使用するユーザ名を取得します。
void	setAllocatingDNS(int allocatingDNS) DNSサーバのIPアドレスの割り当て方式を設定します。
void	setAllocatingIP(int allocatingIP) IPアドレスの割り当て方式を設定します。
void	setIPAddress(java.lang.String ipAddress) 自ホストのIPアドレスを設定します。
void	setIPAuthentication(int ipAuthentication) IPの認証方式を設定します。
void	setPassword(java.lang.String password) IPの認証に使用するパスワードを設定します。
void	setPrimaryDNS(java.lang.String primaryDNS) プライマリDNSのIPアドレスを設定します。
void	setSecondaryDNS(java.lang.String secondaryDNS) セカンダリDNSのIPアドレスを設定します。
void	setUserName(java.lang.String userName) IPの認証に使用するユーザ名を設定します。

クラス java.lang.Object から継承されたメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait

フィールドの詳細

ALLOCATING_IP_DYNAMIC

public static final int ALLOCATING_IP_DYNAMIC

IPアドレスの割り当て方式の一つで動的IPアドレス割り当てを表します。

関連項目:

setAllocatingIP(int), setAllocatingDNS(int), getAllocatingIP(), getAllocatingDNS(), 定数フィールド値

ALLOCATING_IP_STATIC

public static final int ALLOCATING_IP_STATIC

IPアドレスの割り当て方式の一つで固定IPアドレス割り当てを表します。

関連項目:

setAllocatingIP(int), setAllocatingDNS(int), getAllocatingIP(), getAllocatingDNS(), 定数フィールド値

IP_AUTHENTICATION_NONE

public static final int IP_AUTHENTICATION_NONE

IPの認証方式の一つで認証なしを表します。

関連項目:

setIPAuthentication(int), getIPAuthentication(), 定数フィールド値

IP_AUTHENTICATION_CHAP

public static final int IP_AUTHENTICATION_CHAP

IPの認証方式の一つでCHAP認証を表します。

関連項目:

setIPAuthentication(int), getIPAuthentication(), 定数フィールド値

IP_AUTHENTICATION_PAP

public static final int IP_AUTHENTICATION_PAP

IPの認証方式の一つでPAP認証を表します。

関連項目:

setIPAuthentication(int), getIPAuthentication(), 定数フィールド値

コンストラクタの詳細

IPSettingInfo

public IPSettingInfo(int ipAuthentication,
                     java.lang.String userName,
                     java.lang.String password)

IP 情報インスタンスを生成します。

パラメータ:

ipAuthentication - IPの認証方式(IP_AUTHENTICATION_NONE、IP_AUTHENTICATION_CHAP、IP_AUTHENTICATION_PAP)を指定します。

userName - IPの認証に使用するユーザ名を指定します。IPの認証方式でIP_AUTHENTICATION_NONEを指定した場合は無視されます。

password - IPの認証に使用するパスワードを指定します。IPの認証方式でIP_AUTHENTICATION_NONEを指定した場合は無視されます。

例外:

java.lang.IllegalArgumentException - 不正なipAuthenticationが指定された場合に発生します。

関連項目:

IP_AUTHENTICATION_NONE, IP_AUTHENTICATION_PAP, IP_AUTHENTICATION_CHAP

IPSettingInfo

public IPSettingInfo(int ipAuthentication,
                     java.lang.String userName,
                     java.lang.String password,
                     java.lang.String ipAddress)

IP 情報インスタンスを生成します。

本コンストラクタにてインスタンスを生成した場合、自ホストのIPアドレスの割り当て方式はALLOCATING_IP_STATICとなります。

IPアドレスはIPv4のドット付き10進表記で指定してください。 この形式以外の値を設定した場合、IllegalArgumentExceptionが発生します。

パラメータ:

ipAuthentication - IPの認証方式(IP_AUTHENTICATION_NONE、IP_AUTHENTICATION_CHAP、IP_AUTHENTICATION_PAP)を指定します。

userName - IPの認証に使用するユーザ名を指定します。IPの認証方式でIP_AUTHENTICATION_NONEを指定した場合は無視されます。

password - IPの認証に使用するパスワードを指定します。IPの認証方式でIP_AUTHENTICATION_NONEを指定した場合は無視されます。

ipAddress - 自ホストのIPアドレスを指定します。

例外:

java.lang.NullPointerException - ipAddressにnullを指定した場合に発生します。

java.lang.IllegalArgumentException - 不正なipAuthenticationを指定した場合や、ipAddressにループバックアドレス等の通信不可能なIPアドレスを指定した場合に発生します。

関連項目:

IP_AUTHENTICATION_NONE, IP_AUTHENTICATION_PAP, IP_AUTHENTICATION_CHAP

IPSettingInfo

public IPSettingInfo(int ipAuthentication,
                     java.lang.String userName,
                     java.lang.String password,
                     java.lang.String primaryDNS,
                     java.lang.String secondaryDNS)

IP 情報インスタンスを生成します。

本コンストラクタにてインスタンスを生成した場合、DNSサーバのIPアドレスの割り当て方式はALLOCATING_IP_STATICとなります。

IPアドレスはIPv4のドット付き10進表記で指定してください。 この形式以外の値を設定した場合、IllegalArgumentExceptionが発生します。

パラメータ:

ipAuthentication - IPの認証方式(IP_AUTHENTICATION_NONE、IP_AUTHENTICATION_CHAP、IP_AUTHENTICATION_PAP)を指定します。

userName - IPの認証に使用するユーザ名を指定します。IPの認証方式でIP_AUTHENTICATION_NONEを指定した場合は無視されます。

password - IPの認証に使用するパスワードを指定します。IPの認証方式でIP_AUTHENTICATION_NONEを指定した場合は無視されます。

primaryDNS - プライマリDNSのIPアドレスを指定します。

secondaryDNS - セカンダリDNSのIPアドレスを指定します。

例外:

java.lang.NullPointerException - primaryDNSとsecondaryDNSの両方にnullが指定された場合に発生します。

java.lang.IllegalArgumentException - 不正なipAuthenticationを指定した場合や、primaryDNSまたはsecondaryDNSにループバックアドレス等の通信不可能なIPアドレスを指定した場合に発生します。

関連項目:

IP_AUTHENTICATION_NONE, IP_AUTHENTICATION_PAP, IP_AUTHENTICATION_CHAP

IPSettingInfo

public IPSettingInfo(int ipAuthentication,
                     java.lang.String userName,
                     java.lang.String password,
                     java.lang.String ipAddress,
                     java.lang.String primaryDNS,
                     java.lang.String secondaryDNS)

IP 情報インスタンスを生成します。

本コンストラクタにてインスタンスを生成した場合、自ホスト、およびDNSサーバのIPアドレスの割り当て方式はALLOCATING_IP_STATICとなります。

IPアドレスはIPv4のドット付き10進表記で指定してください。 この形式以外の値を設定した場合、IllegalArgumentExceptionが発生します。

パラメータ:

ipAuthentication - IPの認証方式(IP_AUTHENTICATION_NONE、IP_AUTHENTICATION_CHAP、IP_AUTHENTICATION_PAP)を指定します。

userName - IPの認証に使用するユーザ名を指定します。IPの認証方式でIP_AUTHENTICATION_NONEを指定した場合は無視されます。

password - IPの認証に使用するパスワードを指定します。IPの認証方式でIP_AUTHENTICATION_NONEを指定した場合は無視されます。

ipAddress - 自ホストのIPアドレスを指定します。

primaryDNS - プライマリDNSのIPアドレスを指定します。

secondaryDNS - セカンダリDNSのIPアドレスを指定します。

例外:

java.lang.NullPointerException - ipAddress、またはprimaryDNSとsecondaryDNSの両方にnullを指定した場合に発生します。

java.lang.IllegalArgumentException - 不正なipAuthenticationを指定した場合や、ipAddressまたはprimaryDNSまたはsecondaryDNSにループバックアドレス等の通信不可能なIPアドレスを指定した場合に発生します。

関連項目:

IP_AUTHENTICATION_NONE, IP_AUTHENTICATION_PAP, IP_AUTHENTICATION_CHAP

メソッドの詳細

getPDPType

public int getPDPType()

クラス PDPTypeInfo の記述:

このインスタンスが保持しているPDPタイプを取得します。

定義:

クラス PDPTypeInfo 内の getPDPType

戻り値:

PDPタイプを返します。

setIPAuthentication

public void setIPAuthentication(int ipAuthentication)

IPの認証方式を設定します。

通信モジュールの実装が認証をサポートしていない場合、設定された認証方式に関わらず、IP_AUTHENTICATION_NONEを指定した場合と同等の動作を行います。

このメソッドを複数回呼び出した場合は最後に設定したipAuthenticationが有効になります。

パラメータ:

ipAuthentication - IPの認証方式(IP_AUTHENTICATION_NONE、IP_AUTHENTICATION_CHAP、IP_AUTHENTICATION_PAP)を指定します。

例外:

java.lang.IllegalArgumentException - 不正なipAuthenticationを指定した場合に発生します。

関連項目:

IP_AUTHENTICATION_NONE, IP_AUTHENTICATION_PAP, IP_AUTHENTICATION_CHAP

setUserName

public void setUserName(java.lang.String userName)

IPの認証に使用するユーザ名を設定します。

IPの認証方式でIP_AUTHENTICATION_NONEを指定した場合は無視されます。 nullを指定すると既に設定されてあるユーザ名は削除されます。このメソッドを複数回呼び出した場合は最後に設定したuserNameが有効になります。

パラメータ:

userName - IPの認証に使用するユーザ名を指定します。

setPassword

public void setPassword(java.lang.String password)

IPの認証に使用するパスワードを設定します。

IPの認証方式でIP_AUTHENTICATION_NONEを指定した場合は無視されます。 nullを指定すると既に設定されてあるパスワードは削除されます。このメソッドを複数回呼び出した場合は最後に設定したpasswordが有効になります。

パラメータ:

password - IPの認証に使用するパスワードを指定します。

setAllocatingIP

public void setAllocatingIP(int allocatingIP)

IPアドレスの割り当て方式を設定します。

このメソッドを複数回呼び出した場合は最後に設定したallocatingIPが有効になります。

パラメータ:

allocatingIP - IPアドレスの割り当て方式(ALLOCATING_IP_DYNAMIC、ALLOCATING_IP_STATIC)を指定します。

例外:

java.lang.IllegalArgumentException - 不正なallocatingIPを指定した場合に発生します。

関連項目:

ALLOCATING_IP_DYNAMIC, ALLOCATING_IP_STATIC

setIPAddress

public void setIPAddress(java.lang.String ipAddress)

自ホストのIPアドレスを設定します。

IPアドレスの割当て方式でALLOCATING_IP_DYNAMICを指定した場合は無視されます。 nullを指定すると既に設定されてある自ホストのIPアドレスは削除されます。このメソッドを複数回呼び出した場合は最後に設定したipAddressが有効になります。

IPアドレスはIPv4のドット付き10進表記で指定してください。 この形式以外の値を設定した場合、IllegalArgumentExceptionが発生します。

パラメータ:

ipAddress - 自ホストのIPアドレスを指定します。

例外:

java.lang.IllegalArgumentException - ipAddressにループバックアドレス等の通信不可能なIPアドレスを指定した場合に発生します。

setAllocatingDNS

public void setAllocatingDNS(int allocatingDNS)

DNSサーバのIPアドレスの割り当て方式を設定します。

このメソッドを複数回呼び出した場合は最後に設定したallocatingDNSが有効になります。

パラメータ:

allocatingDNS - DNSサーバのIPアドレスの割り当て方式(ALLOCATING_IP_DYNAMIC、ALLOCATING_IP_STATIC)を指定します。

例外:

java.lang.IllegalArgumentException - 不正なallocatingDNSを指定した場合に発生します。

関連項目:

ALLOCATING_IP_DYNAMIC, ALLOCATING_IP_STATIC

setPrimaryDNS

public void setPrimaryDNS(java.lang.String primaryDNS)

プライマリDNSのIPアドレスを設定します。

DNSサーバのIPアドレスの割当て方式でALLOCATING_IP_DYNAMICを指定した場合は無視されます。 nullを指定すると既に設定されてあるプライマリDNSのIPアドレスは削除されます。このメソッドを複数回呼び出した場合は最後に設定したprimaryDNSが有効になります。

IPアドレスはIPv4のドット付き10進表記で指定してください。 この形式以外の値を設定した場合、IllegalArgumentExceptionが発生します。

パラメータ:

primaryDNS - プライマリDNSのIPアドレスを指定します。

例外:

java.lang.IllegalArgumentException - primaryDNSにループバックアドレス等の通信不可能なIPアドレスを指定した場合に発生します。

setSecondaryDNS

public void setSecondaryDNS(java.lang.String secondaryDNS)

セカンダリDNSのIPアドレスを設定します。

通信モジュールの実装がサポートしていない場合は、設定されていても使用しません。 DNSサーバのIPアドレスの割当て方式でALLOCATING_IP_DYNAMICを指定した場合は無視されます。 nullを指定すると既に設定されてあるセカンダリDNSのIPアドレスは削除されます。このメソッドを複数回呼び出した場合は最後に設定したsecondaryDNSが有効になります。

IPアドレスはIPv4のドット付き10進表記で指定してください。 この形式以外の値を設定した場合、IllegalArgumentExceptionが発生します。

パラメータ:

secondaryDNS - セカンダリDNSのIPアドレスを指定します。

例外:

java.lang.IllegalArgumentException - secondaryDNSにループバックアドレス等の通信不可能なIPアドレスを指定した場合に発生します。

getIPAuthentication

public int getIPAuthentication()

IPの認証方式を取得します。

戻り値:

IPの認証方式を返します。

関連項目:

IP_AUTHENTICATION_NONE, IP_AUTHENTICATION_PAP, IP_AUTHENTICATION_CHAP

getUserName

public java.lang.String getUserName()

IPの認証に使用するユーザ名を取得します。 設定されていない場合はnullを返します。

戻り値:

IPの認証に使用するユーザ名を返します。

getPassword

public java.lang.String getPassword()

IPの認証に使用するパスワードを取得します。 設定されていない場合はnullを返します。

戻り値:

IPの認証に使用するパスワードを返します。

getAllocatingIP

public int getAllocatingIP()

IPアドレスの割り当て方式を取得します。 設定されていない場合はALLOCATING_IP_DYNAMICを返します。

戻り値:

IPアドレスの割り当て方式を返します。

関連項目:

ALLOCATING_IP_DYNAMIC, ALLOCATING_IP_STATIC

getIPAddress

public java.lang.String getIPAddress()

自ホストのIPアドレスを取得します。 設定されていない場合はnullを返します。

戻り値:

自ホストのIPアドレスをIPv4のドット付き10進表記で返します。

getAllocatingDNS

public int getAllocatingDNS()

DNSサーバのIPアドレスの割り当て方式を取得します。

戻り値:

DNSサーバのIPアドレスの割り当て方式を返します。 設定されていない場合はALLOCATING_IP_DYNAMICを返します。

関連項目:

ALLOCATING_IP_DYNAMIC, ALLOCATING_IP_STATIC

getPrimaryDNS

public java.lang.String getPrimaryDNS()

プライマリDNSのIPアドレスを取得します。 設定されていない場合はnullを返します。

戻り値:

プライマリDNSのIPアドレスをIPv4のドット付き10進表記で返します。

getSecondaryDNS

public java.lang.String getSecondaryDNS()

セカンダリDNSのIPアドレスを取得します。 設定されていない場合はnullを返します。

戻り値:

セカンダリDNSのIPアドレスをIPv4のドット付き10進表記で返します。