OPROARTS API

net.opro.product.odcaw.oproarts.api
クラス OPROARTSHandler

Object
  上位を拡張 OPROARTSHandler

public class OPROARTSHandler
extends Object

OPROARTS Application Program Interface の中心となるクラスです。
OPROARTSサーバー に対して、ドキュメント生成要求等を行います。

ドキュメント生成要求等を行うには、OPROARTSParameter で各パラメータを設定し、

を行います。

この API は、OPROARTSサーバー と HTTPS を用いて通信を行います。 このため、API と OPROARTSサーバー との間で HTTPS による通信が正しく行なえる環境が必要となります。

作成者:
OPRO Japan Co.,Ltd. R&D Center

フィールドの概要
static int FORMAT_EXCEL_MERGED
          Microsoft Excel形式を表します。
static int FORMAT_EXCEL_MERGED_DCT
          docutize の OfficeアドインでマッピングしたMicrosoft Excel形式を表します。
static int FORMAT_EXCEL_MERGED_DDO
          Document Designer for Office でマッピングしたMicrosoft Excel形式を表します。
static int FORMAT_OPR
          OPR形式を表します。
static int FORMAT_PDF
          PDF形式を表します。
static int FORMAT_WORD_MERGED_DCT
          docutize の OfficeアドインでマッピングしたMicrosoft Word形式を表します。
static int FORMAT_WORD_MERGED_DDO
          Document Designer for Office でマッピングしたMicrosoft Word形式を表します。
 
コンストラクタの概要
OPROARTSHandler(String url)
          指定された URL の OPROARTSサーバー を操作する OPROARTSHandler を構築します。
OPROARTSHandler(URL url)
          指定された URL の OPROARTSサーバー を操作する OPROARTSHandler を構築します。
OPROARTSHandler(URL url, Proxy proxy)
          指定された URL の OPROARTSサーバー を操作する OPROARTSHandler を構築します。
 
メソッドの概要
 boolean checkAuthentication(OPROARTSParameter parameter)
          この OPROARTSHandler が参照する OPROARTSサーバー に、指定したCID,UID,パスワードが存在するかを問い合わせます。
 int getConnectTimeout()
          setConnectTimeout(int) で指定した接続タイムアウト値を返します。
 Locale getLocale()
          setLocale(Locale) で指定した言語コードを示すロケールを返します。
 int getReadTimeout()
          setReadTimeout(int) で指定した読み取りタイムアウト値を返します。
 boolean isCheckSavedSize()
           
 String saveDirectPrintDocument(OPROARTSParameter parameter, String dir, String name)
          この OPROARTSHandler が参照する OPROARTSサーバー に、クライアント印刷用ドキュメントの作成を要求します。
 String saveDocument(OPROARTSParameter parameter, String dir, String name)
          この OPROARTSHandler が参照する OPROARTSサーバー に、ドキュメントの作成を要求します。
 void sendMail(OPROARTSParameter parameter)
          この OPROARTSHandler が参照する OPROARTSサーバー に、ドキュメントの添付されたメールの送信を要求します。
 void setCheckSavedSize(boolean checkSavedSize)
          saveDocument(OPROARTSParameter, String, String) または saveDirectPrintDocument(OPROARTSParameter, String, String) で、 保存したドキュメントのサイズと、OPROARTSサーバー が返却した Content-Length との一致を確認するかを指定します。
 void setConnectTimeout(int connectTimeout)
          この OPROARTSHandler が参照する OPROARTSサーバー への通信リンクを開く際に使用するタイムアウト値をミリ秒単位で指定します。
 void setLocale(Locale locale)
          この OPROARTSHandler が参照する OPROARTSサーバー へ要求する際に使用する言語コードを指定します。
 void setReadTimeout(int readTimeout)
          この OPROARTSHandler が参照する OPROARTSサーバー からデータを読み取る際に使用するタイムアウト値をミリ秒単位で指定します。
 
クラス Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

FORMAT_OPR

public static final int FORMAT_OPR
OPR形式を表します。

関連項目:
定数フィールド値

FORMAT_PDF

public static final int FORMAT_PDF
PDF形式を表します。

関連項目:
定数フィールド値

FORMAT_EXCEL_MERGED

public static final int FORMAT_EXCEL_MERGED
Microsoft Excel形式を表します。

導入されたバージョン:
2015.10.31
関連項目:
定数フィールド値

FORMAT_EXCEL_MERGED_DCT

public static final int FORMAT_EXCEL_MERGED_DCT
docutize の OfficeアドインでマッピングしたMicrosoft Excel形式を表します。

導入されたバージョン:
2018.03.07
関連項目:
定数フィールド値

FORMAT_WORD_MERGED_DCT

public static final int FORMAT_WORD_MERGED_DCT
docutize の OfficeアドインでマッピングしたMicrosoft Word形式を表します。

導入されたバージョン:
2018.03.07
関連項目:
定数フィールド値

FORMAT_EXCEL_MERGED_DDO

public static final int FORMAT_EXCEL_MERGED_DDO
Document Designer for Office でマッピングしたMicrosoft Excel形式を表します。

導入されたバージョン:
2018.11.08
関連項目:
定数フィールド値

FORMAT_WORD_MERGED_DDO

public static final int FORMAT_WORD_MERGED_DDO
Document Designer for Office でマッピングしたMicrosoft Word形式を表します。

導入されたバージョン:
2018.11.08
関連項目:
定数フィールド値
コンストラクタの詳細

OPROARTSHandler

public OPROARTSHandler(String url)
                throws MalformedURLException
指定された URL の OPROARTSサーバー を操作する OPROARTSHandler を構築します。OPROARTSサーバー への接続は、この段階では行なわれません。

パラメータ:
url - この OPROARTSHandler が参照する OPROARTSサーバー の URL
例外:
MalformedURLException - url が不正な場合

OPROARTSHandler

public OPROARTSHandler(URL url)
指定された URL の OPROARTSサーバー を操作する OPROARTSHandler を構築します。OPROARTSサーバー への接続は、この段階では行なわれません。

パラメータ:
url - この OPROARTSHandler が参照する OPROARTSサーバー の URL
導入されたバージョン:
2009.07.08

OPROARTSHandler

public OPROARTSHandler(URL url,
                       Proxy proxy)
指定された URL の OPROARTSサーバー を操作する OPROARTSHandler を構築します。OPROARTSサーバー への接続は、この段階では行なわれません。
OPROARTSサーバー に接続する際に経由するプロキシを指定できます。

パラメータ:
url - この OPROARTSHandler が参照する OPROARTSサーバー の URL
proxy - OPROARTSサーバー に接続する際に経由するプロキシ
導入されたバージョン:
2013.11.25
メソッドの詳細

setLocale

public void setLocale(Locale locale)
この OPROARTSHandler が参照する OPROARTSサーバー へ要求する際に使用する言語コードを指定します。
nullを指定するとデフォルトロケールを使用します。

パラメータ:
locale - 使用する言語コードを示すロケール
導入されたバージョン:
2015.11.27

getLocale

public Locale getLocale()
setLocale(Locale) で指定した言語コードを示すロケールを返します。
nullはデフォルトロケールを使用することを示します。

戻り値:
setLocale(Locale) で指定した言語コードを示すロケール
導入されたバージョン:
2015.11.27

setConnectTimeout

public void setConnectTimeout(int connectTimeout)
この OPROARTSHandler が参照する OPROARTSサーバー への通信リンクを開く際に使用するタイムアウト値をミリ秒単位で指定します。
0 以下を指定すると、タイムアウトは無限とみなされます。

接続を確立する前にタイムアウトになる場合、OPROARTSAPIConnectTimeoutException がスローされます。

パラメータ:
connectTimeout - ミリ秒単位の接続タイムアウト値
導入されたバージョン:
2009.07.08
関連項目:
getConnectTimeout(), saveDocument(OPROARTSParameter, String, String), saveDirectPrintDocument(OPROARTSParameter, String, String), sendMail(OPROARTSParameter), java.net.URLConnection.setConnectTimeout(int)

getConnectTimeout

public int getConnectTimeout()
setConnectTimeout(int) で指定した接続タイムアウト値を返します。

戻り値:
setConnectTimeout(int) で指定したミリ秒単位の接続タイムアウト値
導入されたバージョン:
2009.07.08
関連項目:
setConnectTimeout(int)

setReadTimeout

public void setReadTimeout(int readTimeout)
この OPROARTSHandler が参照する OPROARTSサーバー からデータを読み取る際に使用するタイムアウト値をミリ秒単位で指定します。
0 以下を指定すると、タイムアウトは無限とみなされます。

データを読み取る準備ができる前にタイムアウトになる場合、OPROARTSAPIReadTimeoutException がスローされます。

パラメータ:
readTimeout - ミリ秒単位の読み取りタイムアウト値
導入されたバージョン:
2009.07.08
関連項目:
getReadTimeout(), saveDocument(OPROARTSParameter, String, String), saveDirectPrintDocument(OPROARTSParameter, String, String), sendMail(OPROARTSParameter), java.net.URLConnection.setReadTimeout(int)

getReadTimeout

public int getReadTimeout()
setReadTimeout(int) で指定した読み取りタイムアウト値を返します。

戻り値:
setReadTimeout(int) で指定したミリ秒単位の読み取りタイムアウト値
導入されたバージョン:
2009.07.08
関連項目:
setReadTimeout(int)

setCheckSavedSize

public void setCheckSavedSize(boolean checkSavedSize)
saveDocument(OPROARTSParameter, String, String) または saveDirectPrintDocument(OPROARTSParameter, String, String) で、 保存したドキュメントのサイズと、OPROARTSサーバー が返却した Content-Length との一致を確認するかを指定します。
確認の結果、両者が一致しない場合は、OPROARTSAPIFileSizeException がスローされます。

パラメータ:
checkSavedSize - 保存したドキュメントのサイズと、OPROARTSサーバー が返却した Content-Length との一致を確認する場合はtrue
導入されたバージョン:
2017.11.14

isCheckSavedSize

public boolean isCheckSavedSize()
戻り値:
setCheckSavedSize(boolean) で指定した値
導入されたバージョン:
2017.11.14

saveDocument

public String saveDocument(OPROARTSParameter parameter,
                           String dir,
                           String name)
                    throws OPROARTSUnAuthorizedException,
                           OPROARTSRestrictedException,
                           OPROARTSConcurrentRequestException,
                           OPROARTSIllegalRequestException,
                           OPROARTSRequestTooLargeException,
                           OPROARTSTimeoutException,
                           OPROARTSCanceledException,
                           OPROARTSException,
                           OPROARTSAPIConnectTimeoutException,
                           OPROARTSAPIReadTimeoutException,
                           OPROARTSAPIConnectionException,
                           OPROARTSAPISavingException,
                           OPROARTSAPIException
この OPROARTSHandler が参照する OPROARTSサーバー に、ドキュメントの作成を要求します。
作成されたドキュメントは、引数 dir で指定されたディレクトリに、引数 name にドキュメントの拡張子が付加された名称でクライアント上に保存されます。

このメソッドが正しく動作するには、引数 parameter である OPROARTSParameter インスタンスのフィールドに適切な値がセットされている必要があります。
また、API が動作する JAVA_VM から引数 dir で指定されたディレクトリへのファイル書き込みが可能である必要があります。

OPROARTSサーバー のドキュメント作成、JAVA_VM のドキュメント保存が完了するまで制御は戻りません。
処理完了後、保存されたドキュメントへのパス文字列が返却されます。

パラメータ:
parameter - 要求内容を表す OPROARTSParameter インスタンス
dir - ドキュメント保存先ディレクトリ
name - ドキュメント保存名
戻り値:
保存されたドキュメントへのパス文字列
例外:
OPROARTSUnAuthorizedException - OPROARTSサーバー で認証されなかった場合
OPROARTSRestrictedException - OPROARTS の利用が制限されている場合
OPROARTSConcurrentRequestException - 他の処理が実行中の場合
OPROARTSIllegalRequestException - 引数 parameter の内容に誤りがある場合
OPROARTSRequestTooLargeException - 引数 parameter の内容が大きすぎる場合
OPROARTSTimeoutException - OPROARTSサーバー でタイムアウトが発生した場合
OPROARTSCanceledException - OPROARTSサーバー で処理がキャンセルされた場合
OPROARTSException - OPROARTSサーバー で内部エラーが発生した場合
OPROARTSAPIConnectTimeoutException - OPROARTSサーバー への接続時にタイムアウトが発生した場合
OPROARTSAPIReadTimeoutException - OPROARTSサーバー からのデータ読み取り時にタイムアウトが発生した場合
OPROARTSAPIConnectionException - OPROARTSサーバー への接続中にエラーが発生した場合
OPROARTSAPISavingException - ドキュメントの保存中にエラーが発生した場合
OPROARTSAPIException - API で内部エラーが発生した場合

sendMail

public void sendMail(OPROARTSParameter parameter)
              throws OPROARTSUnAuthorizedException,
                     OPROARTSRestrictedException,
                     OPROARTSConcurrentRequestException,
                     OPROARTSIllegalRequestException,
                     OPROARTSRequestTooLargeException,
                     OPROARTSTimeoutException,
                     OPROARTSCanceledException,
                     OPROARTSException,
                     OPROARTSAPIConnectTimeoutException,
                     OPROARTSAPIReadTimeoutException,
                     OPROARTSAPIConnectionException,
                     OPROARTSAPIException
この OPROARTSHandler が参照する OPROARTSサーバー に、ドキュメントの添付されたメールの送信を要求します。
添付ドキュメントは、引数 parameter の内容にしたがって、このメソッドが呼ばれる度に OPROARTSサーバー で作成されます。

このメソッドが正しく動作するには、引数 parameter である OPROARTSParameter インスタンスのフィールドに適切な値セットされている必要があります。
また、引数 parameter である OPROARTSParameter インスタンスにセットされる MailParameter に、正しいメールアドレスをセットする必要があります。
メールの送信に成功した後は、送信されたメールが宛先に届かなくても、エラーは発生せず、課金対象としてカウントされます。

OPROARTSサーバー のドキュメント作成、メール送信が完了するまで制御は戻りません。

パラメータ:
parameter - 要求内容を表す OPROARTSParameter インスタンス
例外:
OPROARTSUnAuthorizedException - OPROARTSサーバー で認証されなかった場合
OPROARTSRestrictedException - OPROARTS の利用が制限されている場合
OPROARTSConcurrentRequestException - 他の処理が実行中の場合
OPROARTSIllegalRequestException - 引数 parameter の内容に誤りがある場合
OPROARTSRequestTooLargeException - 引数 parameter の内容が大きすぎる場合
OPROARTSTimeoutException - OPROARTSサーバー でタイムアウトが発生した場合
OPROARTSCanceledException - OPROARTSサーバー で処理がキャンセルされた場合
OPROARTSException - OPROARTSサーバー で内部エラーが発生した場合
OPROARTSAPIConnectTimeoutException - OPROARTSサーバー への接続時にタイムアウトが発生した場合
OPROARTSAPIReadTimeoutException - OPROARTSサーバー からのデータ読み取り時にタイムアウトが発生した場合
OPROARTSAPIConnectionException - OPROARTSサーバー への接続中にエラーが発生した場合
OPROARTSAPIException - API で内部エラーが発生した場合

saveDirectPrintDocument

public String saveDirectPrintDocument(OPROARTSParameter parameter,
                                      String dir,
                                      String name)
                               throws OPROARTSUnAuthorizedException,
                                      OPROARTSRestrictedException,
                                      OPROARTSConcurrentRequestException,
                                      OPROARTSIllegalRequestException,
                                      OPROARTSRequestTooLargeException,
                                      OPROARTSTimeoutException,
                                      OPROARTSCanceledException,
                                      OPROARTSException,
                                      OPROARTSAPIConnectTimeoutException,
                                      OPROARTSAPIReadTimeoutException,
                                      OPROARTSAPIConnectionException,
                                      OPROARTSAPISavingException,
                                      OPROARTSAPIException
この OPROARTSHandler が参照する OPROARTSサーバー に、クライアント印刷用ドキュメントの作成を要求します。
作成されたドキュメントは、引数 dir で指定されたディレクトリに、引数 name に拡張子 .odp が付加された名称でクライアント上に保存されます。

このメソッドが正しく動作するには、引数 parameter である OPROARTSParameter インスタンスのフィールドに適切な値セットされている必要があります。
また、OPROARTSHandler が動作する JAVA_VM から引数 dir で指定されたディレクトリへのファイル書き込みが可能である必要があります。

OPROARTSサーバー のドキュメント作成、JAVA_VM のドキュメント保存が完了するまで制御は戻りません。
処理完了後、保存されたドキュメントへのパス文字列が返却されます。
保存されるドキュメント形式は、OPROARTSParameter.setFormat(int) の内容に関わらず、ODP (OPRO Direct Print) ファイルになります。

保存されたクライアント印刷用ドキュメントは、OPRO X Browser がインストールされたマシンでの、サイレント印刷に使用することができます。

パラメータ:
parameter - 要求内容を表す OPROARTSParameter インスタンス
dir - ドキュメント保存先ディレクトリ
name - ドキュメント保存名
戻り値:
保存されたドキュメントへのパス文字列
例外:
OPROARTSUnAuthorizedException - OPROARTSサーバー で認証されなかった場合
OPROARTSRestrictedException - OPROARTS の利用が制限されている場合
OPROARTSConcurrentRequestException - 他の処理が実行中の場合
OPROARTSIllegalRequestException - 引数 parameter の内容に誤りがある場合
OPROARTSRequestTooLargeException - 引数 parameter の内容が大きすぎる場合
OPROARTSTimeoutException - OPROARTSサーバー でタイムアウトが発生した場合
OPROARTSCanceledException - OPROARTSサーバー で処理がキャンセルされた場合
OPROARTSException - OPROARTSサーバー で内部エラーが発生した場合
OPROARTSAPIConnectTimeoutException - OPROARTSサーバー への接続時にタイムアウトが発生した場合
OPROARTSAPIReadTimeoutException - OPROARTSサーバー からのデータ読み取り時にタイムアウトが発生した場合
OPROARTSAPIConnectionException - OPROARTSサーバー への接続中にエラーが発生した場合
OPROARTSAPISavingException - ドキュメントの保存中にエラーが発生した場合
OPROARTSAPIException - API で内部エラーが発生した場合

checkAuthentication

public boolean checkAuthentication(OPROARTSParameter parameter)
                            throws OPROARTSException,
                                   OPROARTSAPIConnectTimeoutException,
                                   OPROARTSAPIReadTimeoutException,
                                   OPROARTSAPIConnectionException,
                                   OPROARTSAPIException
この OPROARTSHandler が参照する OPROARTSサーバー に、指定したCID,UID,パスワードが存在するかを問い合わせます。

引数 parameter である OPROARTSParameter インスタンスに設定された値の内、CID,UID,パスワード以外の値は使用されません。

パラメータ:
parameter - 問い合わせ内容を表す OPROARTSParameter インスタンス
戻り値:
指定したCID,UID,パスワードが存在する場合は、true
例外:
OPROARTSException - OPROARTSサーバー で内部エラーが発生した場合
OPROARTSAPIConnectTimeoutException - OPROARTSサーバー への接続時にタイムアウトが発生した場合
OPROARTSAPIReadTimeoutException - OPROARTSサーバー からのデータ読み取り時にタイムアウトが発生した場合
OPROARTSAPIConnectionException - OPROARTSサーバー への接続中にエラーが発生した場合
OPROARTSAPIException - API で内部エラーが発生した場合
導入されたバージョン:
2010.12.09

OPRO Japan Co.,Ltd.