com.docomostar.io
インタフェース DDPConnection

すべてのスーパーインタフェース:

javax.microedition.io.Connection, javax.microedition.io.ContentConnection, HttpConnection, javax.microedition.io.InputConnection, javax.microedition.io.OutputConnection, javax.microedition.io.StreamConnection

public interface DDPConnection
extends HttpConnection

[iアプリオプションAPI]

DDPConnection インタフェース

音声認識バックエンドサーバーとの DDP 通信の接続を定義します。

導入されたバージョン:

Star-1.0

フィールドの概要

インタフェース com.docomostar.io.HttpConnection から継承されたフィールド

GET, HEAD, HTTP_ACCEPTED, HTTP_BAD_GATEWAY, HTTP_BAD_METHOD, HTTP_BAD_REQUEST, HTTP_CLIENT_TIMEOUT, HTTP_CONFLICT, HTTP_CREATED, HTTP_ENTITY_TOO_LARGE, HTTP_EXPECT_FAILED, HTTP_FORBIDDEN, HTTP_GATEWAY_TIMEOUT, HTTP_GONE, HTTP_INTERNAL_ERROR, HTTP_LENGTH_REQUIRED, HTTP_MOVED_PERM, HTTP_MOVED_TEMP, HTTP_MULT_CHOICE, HTTP_NO_CONTENT, HTTP_NOT_ACCEPTABLE, HTTP_NOT_AUTHORITATIVE, HTTP_NOT_FOUND, HTTP_NOT_IMPLEMENTED, HTTP_NOT_MODIFIED, HTTP_OK, HTTP_PARTIAL, HTTP_PAYMENT_REQUIRED, HTTP_PRECON_FAILED, HTTP_PROXY_AUTH, HTTP_REQ_TOO_LONG, HTTP_RESET, HTTP_SEE_OTHER, HTTP_TEMP_REDIRECT, HTTP_UNAUTHORIZED, HTTP_UNAVAILABLE, HTTP_UNSUPPORTED_RANGE, HTTP_UNSUPPORTED_TYPE, HTTP_USE_PROXY, HTTP_VERSION, POST

メソッドの概要

void	connect() メッセージを送受信します。
void	setDDP() この接続を DDP として利用することを設定します。
void	setRequestProperty(String key, String value) リクエストメッセージのヘッダを設定します。

インタフェース com.docomostar.io.HttpConnection から継承されたメソッド

close, getDate, getEncoding, getExpiration, getHeaderField, getLastModified, getLength, getResponseCode, getResponseMessage, getType, getURL, openDataInputStream, openDataOutputStream, openInputStream, openOutputStream, setIfModifiedSince, setRequestMethod

メソッドの詳細

setDDP

void setDDP()

この接続を DDP として利用することを設定します。

パーミッションとして音声認識APIの利用が許可されているトラステッド Star アプリのみ、このメソッドを呼び出すことができます。

このメソッドを呼び出した後で、DDP として利用する設定を解除することはできません。

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

例外:

UnsupportedOperationException -
端末が DDP 通信機能をサポートしていない場合に発生します。

RuntimeException -
呼び出してはならない状態の時に呼び出された場合に発生します 。

setRequestProperty

void setRequestProperty(String key,
                        String value)
                        throws java.io.IOException

リクエストメッセージのヘッダを設定します。

このオブジェクトが DDP として利用することが設定されている場合、キーが "X-DDP-" で始まるプロパティを設定することができます。 DDP として利用することが設定されていない場合は HttpConnection.setRequestProperty(String, String) の動作と同じです。

設定できるプロパティキーの種類以外の仕様については HttpConnection.setRequestProperty(String, String) の仕様に準じます。

定義:

インタフェース HttpConnection 内の setRequestProperty

パラメータ:

key - プロパティキー

value - プロパティ値

関連項目:

setDDP()

例外:

RuntimeException -
呼び出してはならない状態の時に呼び出された場合に発生します 。

java.io.IOException -
引数 value が256バイトを超えた場合に発生します。 バイト数はデフォルトのエンコーディングで評価します。

connect

void connect()
             throws java.io.IOException

メッセージを送受信します。

このオブジェクトが DDP として利用することが設定されている場合、リクエストメソッドは HttpConnection.POST でなくてはいけません。それ以外の動作については HttpConnection.connect() と同じです。

DDP として利用することが設定されていない場合は HttpConnection.connect() の動作と同じです。

定義:

インタフェース HttpConnection 内の connect

関連項目:

setDDP()

例外:

RuntimeException -
呼び出してはならない状態の時に呼び出された場合 に発生します。

ConnectionException -
(ILLEGAL_STATE)
リクエストメソッドが設定されていない場合に発生します。

ConnectionException -
(ILLEGAL_STATE)
使用不可なヘッダが設定されていた場合に発生します。

ConnectionException -
(ILLEGAL_STATE)
DDP として利用することが設定されており、かつリクエストメソッドに HttpConnection.POST 以外が設定されている場合に発生します。

ConnectionException -
(BUSY_RESOURCE)
サポートしている以上の接続を使おうとした場合に発生します。

ConnectionException -
(SELF_MODE)
端末がセルフモードの場合に発生します。

ConnectionException -
(USER_ABORT)
ユーザ操作により、 Suspended 状態に遷移した場合 に発生します。

ConnectionException -
(USER_ABORT)
バックグラウンドで SSL 通信中の場合に Star アプリが SSL 通信を行おうとすると、 バックグラウンドの SSL 通信を切断するかどうか確認するためのダイアログが表示されることがありますが、 そこでユーザがバックグラウンドの SSL 通信の切断を拒否した場合 に発生します。

ConnectionException -
(HTTP_ERROR)
サーバからのレスポンスコードが 2xx でない場合に発生します。 サーバからのレスポンスコードが 401 の場合はユーザが ID・パスワードを入力するためのダイアログが表示されますが、 そこでユーザがキャンセルした場合にもこの例外が発生します。

ConnectionException -
(BUSY_RESOURCE)
テレビ電話通話中に呼び出された場合に発生します。

ConnectionException -
(BUSY_RESOURCE)
[Star-1.1 まで] PTT呼通信中、PTT設定中に呼び出された場合に発生します。

ConnectionException -
(BUSY_RESOURCE)
ミュージックチャネルダウンローダ起動中に呼び出された場合に発生します。

ConnectionException -
(BUSY_RESOURCE)
ソフトウェア更新のダウンロード通知機能が起動中に呼び出された場合に発生します。

java.io.InterruptedIOException -
Suspended 状態に遷移した場合や中断要求が発生した場合に発生します。

java.io.IOException -
ネイティブ側で通信時に I/O エラーが発生した場合に発生します。