com.nttdocomo.io
インタフェース ClientObexConnection

すべてのスーパーインタフェース:
javax.microedition.io.Connection, javax.microedition.io.InputConnection, ObexConnection, javax.microedition.io.OutputConnection, javax.microedition.io.StreamConnection
既知のサブインタフェースの一覧:
FelicaClientObexConnection

public interface ClientObexConnection
extends ObexConnection

OBEX でクライアントとして通信を行う場合の接続を定義します。 オペレーションとして PUT と GET をサポートしています。 一回の接続で複数回 sendRequest メソッドを呼び出すことが可能で、 連続して複数のリクエストを送信することができます。

OutputStream または DataOutputStream に出力したデータが PUT オペレーションの BODY ヘッダの内容としてサーバに送信されます。 GET オペレーションの場合、OutputStream または DataOutputStream に出力したデータは無視されます。
また、GET オペレーションに対するレスポンスの BODY ヘッダの内容は InputStream または DataInputStream から読み出すことができます。 PUT オペレーションに対するレスポンスの場合、 InputStream または DataInputStream は常に空のストリームとなります。 ObexConnection インタフェースで定義されている getContentLength メソッドは レスポンスの BODY ヘッダ内のコンテンツの長さを返します。

以下に IrDA 通信において PUT オペレーションを使用する場合のコード例を示します。

   try {
       ClientObexConnection coc;
       coc = (ClientObexConnection)Connector.open("obex:/irclient");
       coc.connect(); // IrDA の場合、この時点でデバイスに通電して
                      // CONNECT オペレーションを発行します。
       while (true) { // 複数のオペレーションを行う場合のループ。
                      // ループの中で PUT と GET を組み合わせて使用してもよい。
           coc.setOperation(ObexConnection.PUT);
           coc.setName("foo");
           OutputStream out = coc.openOutputStream();
           // 書き込み処理
           out.close();
           coc.sendRequest(); // IrDA の場合、この時点で PUT オペレーションを
                              // 送信して、レスポンスを受け取ります。
           int response = coc.getResponseCode();
       }
       coc.close(); // IrDA の場合、この時点で DISCONNECT オペレーションを
                    // 発行して、デバイスをオフにします。
   } catch (IOException e) {
   }
 
また、以下に IrDA 通信において GET オペレーションを使用する場合のコード例を示します。
   try {
       ClientObexConnection coc;
       coc = (ClientObexConnection)Connector.open("obex:/irclient");
       coc.connect(); // IrDA の場合、この時点でデバイスに通電して
                      // CONNECT オペレーションを発行します。
       while (true) { // 複数のオペレーションを行う場合のループ。
                      // ループの中で PUT と GET を組み合わせて使用してもよい。
           coc.setOperation(ObexConnection.GET);
           coc.setName("bar");
           coc.sendRequest(); // IrDA の場合、この時点で GET オペレーションを
                              // 送信して、レスポンスを受け取ります。
           int response = coc.getResponseCode();
           InputStream in = coc.openInputStream();
           // 読み出し処理
           in.close();
       }
       coc.close(); // IrDA の場合、この時点で DISCONNECT オペレーションを
                    // 発行して、デバイスをオフにします。
   } catch (IOException e) {
   }
 

[DoJa-5.1 (905i) 以降]
端末によっては、IrDA 通信に加え IrSimple 片方向通信と IrSimple 双方向通信をサポートします。 IrSimple 通信機能では、connect(int) によって通信モードを指定できます。 接続確立後、ObexConnection.getCommMode()を呼び出すことで通信モードを確認することができます。 なお、IrDA 通信のみサポートしているサーバに対して、IrSimple 双方向通信を試みた場合には、 IrSimple 通信機能の IrDA 通信互換により IrDA 通信で接続が確立されます。

IrSimple 片方向通信と IrSimple 双方向通信においては、 オペレーションとして PUT のみをサポートしています。

以下に IrSimple 片方向通信を行う場合のコード例を示します。
 
 try {
     ClientObexConnection coc;
     coc = (ClientObexConnection)Connector.open("obex:/irclient");
     coc.connect(ClientObexConnection.COMM_MODE_IRSIMPLE_UNILATERALLY); // この時点でデバイスに通電して
                                                   // CONNECT オペレーションを発行します。
                                                   // Server側からの接続要求応答がない為、
                                                   // 接続要求応答の受信が完了するまで待ちません。
     while (true) { // 複数のオペレーションを行う場合のループ。
                    // ループの中で PUT のみ指定できます。
         coc.setOperation(ObexConnection.PUT);
         coc.setName("foo");
         OutputStream out = coc.openOutputStream();
         // 書き込み処理
         out.close();
         coc.sendRequest(); // この時点で PUT オペレーションを送信します。
                            // Server側からのレスポンスがない為、レスポンスは受け取りません。
         int response = coc.getResponseCode(); // 必ずレスポンスコード「ObexConnection.SUCCESS」が返ります。
     }
     coc.close(); // IrSimple の場合、この時点で DISCONNECT オペレーションを
                  // 発行して、デバイスをオフにします。
 } catch (IOException e) {
 }
 
以下に IrSimple 双方向通信を行う場合のコード例を示します。
 try {
     ClientObexConnection coc;
     coc = (ClientObexConnection)Connector.open("obex:/irclient");
     coc.connect(ClientObexConnection.COMM_MODE_IRSIMPLE_INTERACTIVE); // この時点でデバイスに通電して
                                                  //  CONNECT オペレーションを発行します。
                                                  // Server側からの接続要求応答の受信が完了するまで待ちます。
     while (true) { // 複数のオペレーションを行う場合のループ。
                    // ループの中で PUT のみ指定できます。
         coc.setOperation(ObexConnection.PUT);
         coc.setName("foo");
         OutputStream out = coc.openOutputStream();
         // 書き込み処理
         out.close();
         coc.sendRequest(); // この時点で PUT オペレーションを送信して、レスポンスを受け取ります。
         int response = coc.getResponseCode();
     }
     coc.close(); // IrSimple の場合、この時点で DISCONNECT オペレーションを
                  // 発行して、デバイスをオフにします。
 } catch (IOException e) {
 }
 

導入されたバージョン:
DoJa-2.0

フィールドの概要
 
インタフェース com.nttdocomo.io.ObexConnection から継承したフィールド
ACCEPTED, BAD_GATEWAY, BAD_REQUEST, COMM_MODE_IRDA, COMM_MODE_IRSIMPLE_INTERACTIVE, COMM_MODE_IRSIMPLE_UNILATERALLY, CONFLICT, CONTINUE, CREATED, DATABASE_FULL, DATABASE_LOCKED, DISCONNECT, FORBIDDEN, GATEWAY_TIMEOUT, GET, GONE, HTTP_VERSION_NOT_SUPPORTED, INTERNAL_SERVER_ERROR, LENGTH_REQUIRED, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MOVED_TEMPORARILY, MULTIPLE_CHOICES, NO_CONTENT, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, PARTIAL_CONTENT, PAYMENT_REQUIRED, PRECONDITION_FAILED, PROXY_AUTHENTICATION_REQUIRED, PUT, REQUEST_ENTITY_TOO_LARGE, REQUEST_TIME_OUT, REQUEST_URL_TOO_LARGE, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SUCCESS, UNAUTHORIZED, UNSUPPORTED_MEDIA_TYPE, USE_PROXY
 
メソッドの概要
 void connect()
           接続を確立します。
 void connect(int mode) [iアプリオプションAPI]
          通信モードに対応した接続を確立します。
 int getResponseCode()
           レスポンスコードを取得します。
 void sendRequest()
           リクエストを送信して、レスポンスの受信を完了するまで待ちます。
 void setOperation(int operation)
           オペレーションコードを設定します。
 
インタフェース com.nttdocomo.io.ObexConnection から継承したメソッド
getCommMode, getContentLength, getName, getTime, getType, setName, setTime, setType
 
インタフェース javax.microedition.io.InputConnection から継承したメソッド
openDataInputStream, openInputStream
 
インタフェース javax.microedition.io.Connection から継承したメソッド
close
 
インタフェース javax.microedition.io.OutputConnection から継承したメソッド
openDataOutputStream, openOutputStream
 

メソッドの詳細

connect

public void connect()
             throws java.io.IOException
接続を確立します。

例外:
ConnectionException - [DoJa-2.x のみ] サポートしている以上の接続を使おうとした場合に発生します(BUSY_RESOURCE)。
ConnectionException - [DoJa-3.0 (505i) 以降] 既に接続要求発行中の別スレッドが存在するか、別オブジェクトにより既に通信リソースが使用されている場合に発生します(BUSY_RESOURCE)。
ConnectionException - 端末がセルフモードの場合に発生します(SELF_MODE)。
SecurityException - [DoJa-3.0 (505i) 以降] OBEX の使用が許可されていない場合に発生します。
java.io.InterruptedIOException - [DoJa-2.x] 別スレッドからの中断要求やサスペンド により通信が中断された場合に発生します。
java.io.InterruptedIOException - [DoJa-3.0] 別スレッドからの中断要求やサスペンド、 待ち受けアプリケーションでの非活性化状態への遷移により通信が中断された場合に発生します。
java.io.InterruptedIOException - [DoJa-3.5 (900i) 以降] 別スレッドからの中断要求発生、動画再生(コンポーネント上における再生に限る)の開始、 待ち受けアプリケーションでの非活性化状態への遷移により、 通信が中断された場合に発生します。
IllegalStateException - [DoJa-2.1 以降] 音声・テレビ電話通話中に呼び出された場合に発生します。
ConnectionException - [DoJa-3.0 (505i) 以降] 赤外線リモコンが通信中である場合に発生します (BUSY_RESOURCE)。
ConnectionException - [DoJa-5.0 (903i) 以降] アドホック通信中の場合に発生します(BUSY_RESOURCE)。
ConnectionException - [DoJa-4.0 (901i) 以降] バックグラウンドで動作しているネイティブ機能が、 パケット通信中の場合に発生します(BUSY_RESOURCE)。
[DoJa-4.1 (902i) 以降] PTT呼通信中、PTT設定中に呼び出された場合にも発生します。
[DoJa-5.1 (905i) 以降] ミュージックチャネルダウンローダが起動中の場合にも発生します。

[DoJa-5.1 (906i) 以降] ソフトウェア更新のダウンロード通知機能が起動中の場合にも発生します。
ConnectionException - ネイティブのOBEXレイヤでタイムアウトが発生した場合に発生します(TIMEOUT)。
ConnectionException - ユーザが通信開始を許可しなかった場合や、 ユーザ操作により通信を中断された場合に発生します(USER_ABORT)。
java.io.IOException - I/O エラーが発生した場合に発生します。

connect

public void connect(int mode)
             throws java.io.IOException [iアプリオプションAPI]
通信モードに対応した接続を確立します。

以下の通信モードを指定できます。

ObexConnection.COMM_MODE_IRDA を指定した場合は、IrDA 通信を試みます。 connect() の振る舞いと同じになります。

ObexConnection.COMM_MODE_IRSIMPLE_INTERACTIVE を指定した場合は、IrSimple 双方向通信を試みます。 サーバが IrDA 通信のみサポートしている場合、 IrSimple 通信機能の IrDA 通信互換により IrDA 通信で接続が確立されます。

ObexConnection.COMM_MODE_IRSIMPLE_UNILATERALLY を指定した場合は、IrSimple 片方向通信を試みます。 IrSimple 片方向通信においては、サーバからレスポンスが送信されないため、 サーバとの接続の確立を待たずにこのメソッドから戻ります。 このため、このメソッドで ConnectionException(TIMEOUT) が発生することはありません。

接続確立後、ObexConnection.getCommMode() を呼び出すことで実際の通信モードを確認することができます。

端末によっては、IrSimple 通信機能をサポートしていない場合があります。 その場合には、例外 UnsupportedOperationException が発生します。

パラメータ:
mode - 通信モード
例外:
UnsupportedOperationException - 端末が IrSimple 通信機能をサポートしていない場合に発生します。
IllegalArgumentException - 引数 mode に不正な値が指定された場合に発生します。
ConnectionException - 既に接続要求発行中の別スレッドが存在するか、別オブジェクトにより既に通信リソースが使用されている場合に発生します(BUSY_RESOURCE)。
ConnectionException - 端末がセルフモードの場合に発生します(SELF_MODE)。
SecurityException - OBEX の使用が許可されていない場合に発生します。
java.io.InterruptedIOException - 別スレッドからの中断要求発生、動画再生 (コンポーネント上における再生に限る)の開始、 待ち受けアプリケーションでの非活性化状態への遷移により、 通信が中断された場合に発生します。
IllegalStateException - 音声・テレビ電話通話中に呼び出された場合に発生します。
ConnectionException - 赤外線リモコンが通信中である場合に発生します (BUSY_RESOURCE)。
ConnectionException - アドホック通信中の場合に発生します(BUSY_RESOURCE)。
ConnectionException - バックグラウンドで動作しているネイティブ機能が、 パケット通信中の場合に発生します(BUSY_RESOURCE)。
PTT呼通信中、PTT設定中に呼び出された場合にも発生します。 ミュージックチャネルダウンローダが起動中の場合にも発生します。
[DoJa-5.1 (906i) 以降] ソフトウェア更新のダウンロード通知機能が起動中の場合にも発生します。
ConnectionException - ネイティブのOBEXレイヤでタイムアウトが発生した場合に発生します(TIMEOUT)。 ただし、IrSimple 片方向通信の場合には発生しません。
ConnectionException - ユーザが通信開始を許可しなかった場合や、 ユーザ操作により通信を中断された場合に発生します(USER_ABORT)。
java.io.IOException - I/O エラーが発生した場合に発生します。
導入されたバージョン:
DoJa-5.1 (905i)

setOperation

public void setOperation(int operation)
オペレーションコードを設定します。 設定できるオペレーションは "PUT" と "GET" です。

[DoJa-5.1 (905i) 以降]
IrSimple 片方向通信と IrSimple 双方向通信で設定できるオペレーションは "PUT" のみです。

パラメータ:
operation - オペレーションコードを指定します。
例外:
RuntimeException - 呼び出してはならない状態の時に呼び出された場合に発生します。
IllegalArgumentException - 引数 operation にサポートしていないオペレーションコードが指定された場合に発生します。 [DoJa-5.1 (905i) 以降] IrSimple 通信においては、PUT オペレーション以外が指定された場合に発生します。
IllegalArgumentException - WRITEモードでの接続に対してGETオペレーションが指定された場合やREADモードでの接続に対してPUTオペレーションが指定された場合に発生します。

sendRequest

public void sendRequest()
                 throws java.io.IOException
リクエストを送信して、レスポンスの受信を完了するまで待ちます。 このメソッドを呼び出すとリクエストを送信して、 レスポンスが到着するまでブロックします。 レスポンスを全て受信し終わったらこのメソッドから戻ります。

このメソッドを呼び出すことによって、それより前にこの接続オブジェクトから 取り出した InputStream, DataInputStream, OutputStream, DataOutputStream が無効になります。 次に InputStream, DataInputStream を取り出した時は、 このオペレーションで受信したデータを読み出す入力ストリームを返します。 また、次に OutputStream, DataOutputStream を取り出した時は、 次のオペレーションで送信するデータを書き込む出力ストリームを返します。

[DoJa-5.1 (905i) 以降]
IrSimple 片方向通信の場合、リクエストを全て送信し終わったらこのメソッドから戻ります。 IrSimple 片方向通信においては、サーバからレスポンスが送信されないため、 レスポンスの受信を待つことはありません。 このため、このメソッドで ConnectionException(TIMEOUT)、ConnectionException(OBEX_ERROR)が発生することはありません。

例外:
ConnectionException - オペレーションコードがセットされていない場合に発生します(ILLEGAL_STATE)。
SecurityException - [DoJa-3.0 (505i) 以降] OBEX の使用が許可されていない場合に発生します。
java.io.InterruptedIOException - [DoJa-2.x] 別スレッドからの中断要求やサスペンド により通信が中断された場合に発生します。
java.io.InterruptedIOException - [DoJa-3.0] 別スレッドからの中断要求やサスペンド、 待ち受けアプリケーションでの非活性化状態への遷移により通信が中断された場合に発生します。
java.io.InterruptedIOException - [DoJa-3.5 (900i) 以降] 別スレッドからの中断要求発生、動画再生(コンポーネント上における再生に限る)の開始、 待ち受けアプリケーションでの非活性化状態への遷移により、 通信が中断された場合に発生します。
ConnectionException - ネイティブのOBEXレイヤでタイムアウトが発生した場合に発生します(TIMEOUT)。 [DoJa-5.1 (905i) 以降] ただし、IrSimple 片方向通信の場合には発生しません。
ConnectionException - ユーザ操作により通信を中断された場合や、ユーザ操作により通信を中断された直後に呼び出された場合 に発生します(USER_ABORT)。
java.io.IOException - I/O エラーが発生した場合に発生します。
ConnectionException - レスポンスコードが 0x20 番台 (generally ok 系の ステータスコード) 以外のコードだった場合に発生します(OBEX_ERROR)。 [DoJa-5.1 (905i) 以降] ただし、IrSimple 片方向通信の場合には発生しません。

getResponseCode

public int getResponseCode()

レスポンスコードを取得します。 直前に実行した sendRequest メソッドにおいて受信した レスポンスのレスポンスコードを返します。

[DoJa-3.0 (505i) 以降]
1つのデータを複数のパケットに分割して受信した場合、 一番最後に受信したパケットのレスポンスコードを返します。

[DoJa-5.1 (905i) 以降]
IrSimple 片方向通信の場合、戻り値として常に ObexConnection.SUCCESS を返します。 ただし、IrSimple 片方向通信においては、サーバからレスポンスが送信されないため、 ObexConnection.SUCCESS は実際のレスポンスコードではありません。

ミニマムスペックでは、 以下のレスポンスコードについて取得できることが保証されています。

  1. ObexConnection.CONTINUE
  2. ObexConnection.SUCCESS
  3. ObexConnection.NON_AUTHORITATIVE_INFORMATION
  4. ObexConnection.UNAUTHORIZED
  5. ObexConnection.FORBIDDEN
  6. ObexConnection.NOT_FOUND
  7. ObexConnection.REQUEST_TIME_OUT
  8. ObexConnection.CONFLICT
  9. ObexConnection.NOT_IMPLEMENTED
  10. ObexConnection.BAD_REQUEST
  11. ObexConnection.DATABASE_FULL
  12. ObexConnection.DATABASE_LOCKED

戻り値:
レスポンスコードを返します。
例外:
RuntimeException - 呼び出してはならない状態の時に呼び出された場合に発生します。


NTT DOCOMO,INC.

本製品または文書は著作権法により保護されており、その使用、複製、再頒布および逆コンパイルを制限するライセンスのもとにおいて頒布されます。NTTドコモ(その他に許諾者がある場合は当該許諾者も含めて)の書面による事前の許可なく、本製品および関連する文書のいかなる部分も、いかなる方法によっても複製することが禁じられます。フォントを含む第三者のソフトウェアは、著作権法により保護されており、その提供者からライセンスを受けているものです。

Sun、Sun Microsystems、Java、J2MEおよびJ2SEは、米国およびその他の国における米国 Sun Microsystems,Inc.の商標または登録商標です。サンのロゴマークは、米国 Sun Microsystems, Inc.の登録商標です。

FeliCaは、ソニー株式会社が開発した非接触ICカードの技術方式です。FeliCaは、ソニー株式会社の登録商標です。

「iモード」、「iアプリ/アイアプリ」、「i-αppli」ロゴ、「DoJa」はNTTドコモの商標または登録商標です。

その他記載された会社名、製品名などは該当する各社の商標または登録商標です。