office.api.common
クラス CBServiceClient

java.lang.Object
  上位を拡張 office.api.common.CBServiceClient

public class CBServiceClient
extends java.lang.Object

API とのデータの送受信を行うクラスです。

バージョン:
$api_version ver 1.0.0$
作成者:
$api_author Office Team@Cybozu$

コンストラクタの概要
CBServiceClient()
          新しいクライアントインスタンスを生成します。
 
メソッドの概要
 void cleanupTransport()
          サーバーとのコネクションを切断します。
 void load(java.net.URI url, java.lang.String username, java.lang.String password)
          アカウントファイルを元に設定を反映させます。
 void load(java.net.URI url, java.lang.String username, java.lang.String password, java.lang.String scheme, java.util.Date createtime, java.util.Date expiredtime)
          アカウントファイルを元に設定を反映させます。
 org.apache.axiom.om.OMElement sendReceive(Action action)
          受け取ったアクションを送信し、結果を受け取ります。
 void setCreatedTime(java.util.Date createdTime)
          メッセージの作成日時を設定します。
 void setExpiredTime(java.util.Date expiredTime)
          メッセージの有効期限を設定します。
 void setOfficeURI(java.net.URI uri)
          Officeの URL を設定します。
 void setScheme(java.lang.String scheme)
          スキーマを設定します。
 void setUser(java.lang.String username, java.lang.String password)
          ユーザーを設定します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

CBServiceClient

public CBServiceClient()
                throws org.apache.axis2.AxisFault
新しいクライアントインスタンスを生成します。

例外:
org.apache.axis2.AxisFault - サーバーと接続エラー
メソッドの詳細

setUser

public void setUser(java.lang.String username,
                    java.lang.String password)
ユーザーを設定します。
ユーザー名、パスワード共に非nullである必要があります。

パラメータ:
username - ユーザー名
password - パスワード

setCreatedTime

public void setCreatedTime(java.util.Date createdTime)
メッセージの作成日時を設定します。
null が渡された場合、値は無視されます。

パラメータ:
createdTime - 作成日時

setExpiredTime

public void setExpiredTime(java.util.Date expiredTime)
メッセージの有効期限を設定します。 null が渡された場合、値は無視されます。

パラメータ:
expiredTime - 有効期限

setScheme

public void setScheme(java.lang.String scheme)
スキーマを設定します。
例:http, https
null が渡された場合、値は無視されます。

パラメータ:
scheme - スキーマ
関連項目:
Constants

setOfficeURI

public void setOfficeURI(java.net.URI uri)
Officeの URL を設定します。 null が渡された場合、値は無視されます。

パラメータ:
uri - URI

sendReceive

public org.apache.axiom.om.OMElement sendReceive(Action action)
                                          throws org.apache.axis2.AxisFault,
                                                 org.apache.commons.httpclient.ConnectTimeoutException,
                                                 java.rmi.RemoteException,
                                                 java.lang.Throwable
受け取ったアクションを送信し、結果を受け取ります。

パラメータ:
action - SOAP アクション
戻り値:
org.apache.axiom.om.OMElement レスポンス
例外:
java.rmi.RemoteException
org.apache.axis2.AxisFault
org.apache.commons.httpclient.ConnectTimeoutException
java.lang.Throwable

load

public void load(java.net.URI url,
                 java.lang.String username,
                 java.lang.String password)
アカウントファイルを元に設定を反映させます。
このメソッドは次のメソッドで設定できる値を反映させます。
#setGaroonURI(URI),setUser(String, String),setScheme(String), setCreatedTime(Date),setExpiredTime(Date)

パラメータ:
URI - url OfficeのURL
String - username 接続ユーザー名
String - password 接続ユーザーパスワード

load

public void load(java.net.URI url,
                 java.lang.String username,
                 java.lang.String password,
                 java.lang.String scheme,
                 java.util.Date createtime,
                 java.util.Date expiredtime)
アカウントファイルを元に設定を反映させます。
このメソッドは次のメソッドで設定できる値を反映させます。
#setGaroonURI(URI),setUser(String, String),setScheme(String), setCreatedTime(Date),setExpiredTime(Date)

パラメータ:
URI - url OfficeのURL
String - username 接続ユーザー名
String - password 接続ユーザーパスワード
String - scheme 接続スキーマ
Date - createtime メッセージの作成日時
Date - expiredtime メッセージの有効期限

cleanupTransport

public void cleanupTransport()
サーバーとのコネクションを切断します。
コネクションを切断せずに、ひとつの CBServiceClient インスタンスを用いて複数回 APIとのやりとりを行うと org.apache.commons.httpclient.ConnectionPoolTimeoutException がスローされます。