附属書B 状態コード及び推奨する状態コードメッセージ

附属書Bは，操作要求の結果であるセマンティクス情報の提供に使用される状態コード列挙キー ワード及び状態コード列挙値を定義する。各操作応答は，必ず状態コードを含んでいなけ ればず，状態の短テキスト記述である状態メッセージを含んでいてもよい。状態 コードは，オートマトンによって使用されることを意図し，状態メッセージ は，人間のエンドユーザを意図する。状態メッセージは操作応答のオプション の構成要素であり，IPPアプリケーション(ブラウザ，GUI，プリンタドライバ， ゲートウェイなど)に返されない場合もあってもよいので，アプリケーションは状態メッセージを 調べたり表示したりしなくてよい。

状態キーワードの接頭辞は，応答のクラスを次のとおりに定義する。

"informational"

要求受信。処理続行。

"successful"

動作は，受信，理解及び受付けに成功した。

"redirection"

要求を完成するために，さらに動作が必要とされる。

"client-error"

要求は悪い構文を含んでいるか，又は実行できない。

"server-error"

IPPオブジェクトは, 有効と思われる要求の実行に失敗した。

type2 enums，IPP状態コードは拡張可能である。IPPクライアントは,すべて の登録された状態コードの意味を理解することが明らかに望ましいが, 必ずしも必要なことではない。しかし,IPPクライアントは, どの状態コードにおいても, 接頭辞に示されるクラスを理解し,ある未認識の応答はキャッシュされてはいけないと いう例外はあるが,どの未認識の応答においてもそのクラスの最初の状態コードに同等で あるとして取り扱わなければならない。例えば, 未認識の状態コード"client-error-xxx- yyy"がクライアントに受信された場合,その要求に何らかの間違えがあったとみなし, あたかも"client-error-bad-request" 状態コードを受信したかのように応答を安全に取 り扱うことができる。その場合,IPPアプリケーションは,異常な状態を説明する 人間可読な情報をおそらく含んでいるオプションのメッセージ(存在す る場合)をエンドユーザに対して示すことが望ましい。列挙の名前は, アメリカ英語の推奨する状態 メッセージである。

状態コード値は, 0x0000〜0x7FFFに及ぶ。各状態コードクラス値の範囲を，表B.1に示す。

各範囲の(0x0n40〜0x0nFF,n = 0〜5に対して)上位(128値)は,各状態コードクラス 内で私的使用のために予約されている。0x0600〜0x7FFFの値は,将来のために予 約されていて, 使用してはいけない。

B.1 状態コード

B.1.1 Informational

このクラスの状態コードは仮の応答を示し,情報を提供する目的だけに使用さ れる。

IPP/1.1は,このクラスの状態コードを定義していない。

B.1.2 成功状態コード(Successful Status Codes)

このクラスの状態コードは,クライアントの要求が受信,理解及び受付けに成功したことを 示す。

B.1.2.1 successful-ok (0x0000)

要求は成功し,要求属性は置換又は無視されなかった。生成要求に対しての応答の 場合,'successful-ok' 状態コードは要求が受信され,有効になり,さらにジョブオブジ ェクトの生成に成功したことを示す。これはジョブが処理されたことは示さない。 ジョブオブジェクトの'completed'状態への遷移だけが, ジョブが印刷されたことを示す。

B.1.2.2 successful-ok-ignored-or-substituted-attributes (0x0001)

B.1.2.3 successful-ok-conflicting-attributes (0x0002)

B.1.3 リダイレクション状態コード(Redirection Status Codes)

このクラスの状態コードは,要求を満すにはさらにアクションが必要であることを示す。

IPP/1.1 では,このクラスの状態コードは定義されていない。

B.1.4 クライアントエラー状態コード(Client Error Status Codes)

このクラスの状態コードは,クライアントがエラーを起こしたと思われる場合を意図する。 IPPオブジェクトは, エラー状態の説明及びそれが一時的なものか又は永久的なも のかを示すどちらかのメッセージを返すことが望ましい。

B.1.4.1 client-error-bad-request (0x0400)

B.1.4.2 client-error-forbidden (0x0401)

IPPオブジェクトは要求を理解したが,その実行を拒否している。追加認証情報又は認定信任 は何も役に立たないので,その要求を繰り返さないことが望ましい。この状態コ ードは,通常,IPPオブジェクトが,要求が拒否された理由を正確に表したくないとき,又 は他の応答が全く当てはまらないときに使用される。

B.1.4.3 client-error-not-authenticated (0x0402)

要求はユーザ認証を必要としている。IPPクライアントは適切な認証情報で要求を繰り返 すことができる。要求が既に認証情報を含んでいる場合,この状態コードは, その証明に対 して,権限が拒否されたことを示す。この応答が以前と同様な問題を含み, ユーザエージェントが既に認証を少なくても一度は試みている場合,応答メッセージは妥 当な診断情報を含むかもしれない。この状態コードは"client-error-forbidden"よ りも多くの情報を含む。

B.1.4.4 client-error-not-authorized (0x0403)

要求者は要求を実行する権限をもたない。追加認証情報又は認定信任は何も役にた たないので,要求を繰り返えさないことが望ましい。この状態コードは,IPPオブジェク トが,認証情報は理解可能であるが,要求者は要求を実行する権限をもたないことを明ら かにしたい場合に使用される。この状態コードは"client-error-forbidden"及び"client- error-not-authenticated"よりも多くの情報を含む。

B.1.4.5 client-error-not-possible (0x0404)

この状態コードは,何も起こすことができない要求があるときに使用する。例えば,既 にシステムによって取り消されるか中断されたジョブを取り消す要求があるかも知れない。 IPPクライアントは, この要求を繰り返さないことが望ましい。

B.1.4.6 client-error-timeout (0x0405)

B.1.4.7 client-error-not-found (0x0406)

IPPオブジェクトは,要求URIと一致するものを何も見つけられなかった。この状態が一 時的又は永久的なものであるかについては何も示されていない。例えば,Job(URI)への 古い参照をもつクライアントがJobの取消しを試みるが,その間にJobは完了し,Printer にあるJobの記録はすべて削除されている場合である。この状態コード'client-error-not- found'は,参照されたジョブが見つからないことを示すときに返される。このエラ ー状態コードは,クライアントがPrint-URI又はSend-URI操作のどちらかの文書デ ータに対して参照としてURIを供給したときに,文書が見つけられない場合にも使用され る。

実際には,IPPアプリケーションは見つからない状態を回避するために,エンドユーザに 対して有効Printer URI及びJob URIのリストを最初に問い合わせ,表示することが望ま しい。

B.1.4.8 client-error-gone (0x0407)

要求されたオブジェクトはすでに利用不可能であり,転送先アドレスも知られていない。 この状態は永久的と考えることが望ましく,リンク編集機能を持つクライアントはユーザ 承認後,要求URIへの参照を削除することが望ましい。IPPオブジェクトが,この状態が 永久的であるかどうかわからない場合,又は決定する手段が無い場合には,代わりに状態 コード"client-error-not-found"を使用することが望ましい。

この応答は,主として,資源が意図的に利用不可能であること,及びIPPオブジェクト管 理者がその資源に対しての遠隔リンクの削除を望んでいることを受信者に知らせることによって 保守のタスク支援を行なうことを意図する。すべての永久的に利用不可能な資源を"gone"として 表記したり, その表記をある時間保つ必要はない。これは,IPPオブジェクト管理者 の自由な判断に委ねられる。

B.1.4.9 client-error-request-entity-too-large (0x0408)

要求実体が,IPPオブジェクトが処理不可能な大きさ又は処理したくない大きさであるために, IPPオブジェクトはその要求の処理を拒否している。IPP Printerは,この状態コードを 印刷ジョブのサイズを制限していてその制限を超える場合又は属性が多すぎて,それらの符号 化によって,要求実体はIPPオブジェクト容量を超えてしまう場合に, 返す。

B.1.4.10 client-error-request-value-too-long (0x0409)

B.1.4.11 client-error-document-format-not-supported (0x040A)

B.1.4.12 client-error-attributes-or-values-not-supported (0x040B)

B.1.4.13 client-error-uri-scheme-not-supported (0x040C)

B.1.4.14 client-error-charset-not-supported (0x040D)

B.1.4.15 client-error-conflicting-attributes (0x040E)

B.1.4.16 client-error-compression-not-supported(0x040F)

B.1.4.17 client-error-compression-error(0x0410)

B.1.4.18 client-error-document-format-error (0x0411)

B.1.4.19 client-error-document-access-error (0x0412)

B.1.5 サーバエラー状態コード(Server Error Status Codes)

このクラスの状態コードは,IPPオブジェクト自体が起こしたエラーに気付いた場合,又は要 求を実行することができない場合を示す。IPPオブジェクトは,エラー状態を説明するメ ッセージを含み,それが一時的な状態か永久的な状態かを説明するメッセージを含むことが望 ましい。

B.1.5.1 server-error-internal-error (0x0500)

IPPオブジェクトは，要求を満たすことを妨げる予期できない状態にであった。このエラ ー状態コードは，もっと永久的な型の内部エラーを暗示する意味で"server-error- temporary-error"とは異なる。予期できない状態を暗示する意味で，"server-error- device-error"とも異なる(望ましくはないが，予期できる紙詰まり，又はトナー切れ問 題とは違って)。このエラー状態コードは,知識のある人間の介入が必要であろうことを示す。

B.1.5.2 server-error-operation-not-supported (0x0501)

B.1.5.3 server-error-service-unavailable (0x0502)

IPPオブジェクトは,現在,IPPオブジェクトの一時的な過負荷,又は保守のために, 要求 を扱うことができない。これには,後に解放される一時的な状態であるという含みがある。 わかっている場合には,遅延時間の長さをメッセージで示してもよい。遅延時間がわから ない場合には,IPPアプリケーションは"server-error-temporary-error"応答を扱うよう に応答を扱うことが望ましい。状態がもっと永久的なものである場合には,"client- error-gone"又は"client-error-not-found"のエラー状態コードを使用することがで きる。

B.1.5.4 server-error-version-not-supported (0x0503)

B.1.5.5 server-error-device-error (0x0504)

紙詰まりなどのプリンタエラーは,IPPオブジェクトがPrint又はSend操作を処理して いる間に発生する。応答は,本当のJob Status("job-state"及び"job-state-reasons" 属性の値)を含む。追加情報は,オプションである"job-state-message"の 属性値又はエ ラーを詳細に記述するオプションである状態メッセージにて返されることができる。この エラー状態コードは,Printerがそれらのデバイスエラーのため生成要求を受け取るこ とができない状態である場合だけでしか返されない。例えば,Printerがスプール不可能でジ ョブを一つずつしか受け取ることができない場合,生成要求を拒否してしまう理由は, Printerが現在紙詰まりを起こしているためである。しかし,Printer オブジェクトは, Printerに何らかのエラー状態が発生していても,要求を受け取ることができる多くの場 合,'successful-ok'の 状態コードが返される。その場合には,クライアントは返 されたJob Object Attributesを調べるか,状態及び状態理由を確認するために後で Printerに問い合わせる。

B.1.5.6 server-error-temporary-error (0x0505)

バッファがいっぱいの書き込みエラー,メモリオーバフロー(例えば,文書データが Printerのメモリを超えてしまう),又はディスクがいっぱいの状態などの一時的なエラ ーは,IPP Printerが操作を処理している間に発生する。クライアントは,しはらくして からこの一時的な内部エラー状態が解除されているかもしれないことを期待して,再度修 正無しの要求を試してよい℃ﾀ装のオプションとして,Printerオブジェクト がエラーを返さないで一時的状態が解除されるまで応答を遅らせてもよい。

B.1.5.7 server-error-not-accepting-jobs (0x0506)

管理者がPrinterの"printer-is-not-accepting-jobs"の属性を'偽(false)'に設定したた め(このIPP/1.1規定の適用範囲外の方法において),Printerは現在ジョブを受け付け ていないことを示す一時的エラー。

B.1.5.8 server-error-busy (0x0507)

Printerがジョブ及び/又は他の要求の処理を実行中で手がふさがっていることを示す一 時的エラー。クライアントは,しばらくしてからこの一時的なビジー状態が解除されてい ることを期待して,再度修正無しの要求を試してみることが望ましい。

B.1.5.9 server-error-job-canceled (0x0508)

クライアントがIPP Printerにデータを送信している間にオペレータ又はシステムによっ てジョブが取り消されたことを示すエラー。job-id及びjob-uriが生成された場合,そ れらは通常と同様に,Print-Job,Send-Document,又はSend-URI応答によって返される。 そうしないと,応答としてjob-id及びjob-uriは返されない。

B.1.5.10 server-error-multiple-document-jobs-not-supported (0x0509)

IPPオブジェクトは,一つのジョブとして複数の文書をサポートせず, クライアントは,２回目のSend-Document又はSend-URI操作として文書データを供給することを 試した。

B.2 IPP操作のための状態コード

B.2は，IPP操作のための状態コードの一覧を表B.2及び表B.3に示す。

表B.2は，次の短縮形を使用する。

• PJ = Print-Job
• PU = Print-URI
• CJ = Create-Job
• SD = Send-Document
• SU = Send-URI
• V = Validate-Job
• GA = Get-Job-Attributes and Get-Printer-Attributes
• GJ = Get-Jobs
• C = Cancel-Job

表B.3は，次の短縮形を使用する。

• HJ = Hold-Job
• RJ = Release-Job
• RS = Restart-Job
• PP = Pause-Printer
• RP = Resume-Printer
• PJ = Purge-Jobs