public class ImMailSyncManager extends Object
このクラスは、IM-Mailアカウントの同期処理と同期情報のデータストアへの操作を行います。
修飾子とタイプ | フィールドと説明 |
---|---|
static int |
SYNC_TYPE_CREATE
「登録」を示す同期処理種別です。
|
static int |
SYNC_TYPE_DELETE
「削除」を示す同期処理種別です。
|
static int |
SYNC_TYPE_MODIFY
「更新」を示す同期処理種別です。
|
static int |
SYNC_TYPE_NONE
「処理無し」を示す同期処理種別です。
|
コンストラクタと説明 |
---|
ImMailSyncManager()
新しいインスタンスを作成します。
|
ImMailSyncManager(Date date)
指定された基準日時を使用して新しいインスタンスを作成します。
|
修飾子とタイプ | メソッドと説明 |
---|---|
int |
getSyncType(ImMailAccount account)
指定されたIM-Mailアカウントの同期処理種別を取得します。
|
void |
syncAccount(ImMailAccount account)
指定されたIM-Mailアカウントの同期処理を行います。
|
void |
syncAccount(String userCd)
指定されたユーザコードからIM-Mailアカウントを取得して、同期処理を行います。
|
void |
syncCreateAccounts(int syncNo,
List<ImMailAccount> accountList)
IM-Mailアカウントを登録するための同期処理を行います。
|
void |
syncDeleteAccounts(int syncNo,
List<ImMailAccount> accountList)
IM-Mailアカウントを削除するための同期処理を行います。
|
void |
syncModifyAccounts(int syncNo,
List<ImMailAccount> accountList)
IM-Mailアカウントを更新するための同期処理を行います。
|
public static final int SYNC_TYPE_NONE
public static final int SYNC_TYPE_CREATE
public static final int SYNC_TYPE_MODIFY
public static final int SYNC_TYPE_DELETE
public ImMailSyncManager() throws ImMailException
ImMailException
- インスタンス生成に必要な設定の読み込みに失敗した場合、スローされます。public ImMailSyncManager(Date date) throws ImMailException
date
- 基準日時ImMailException
- インスタンス生成に必要な設定の読み込みに失敗した場合、スローされます。public int getSyncType(ImMailAccount account)
このメソッドは、IM-Mailアカウントの現在の同期状態とステータスから、どのような同期処理を実行すべきか判定します。
同期状態 (ステータス) |
現在のステータス | 同期処理 | 返却値 |
---|---|---|---|
同期済(全て) | アクティブ | 更新 | SYNC_TYPE_MODIFY |
SYNC_TYPE_MODIFY |
|||
同期済(閉鎖) | 閉鎖 | 無し | SYNC_TYPE_NONE |
同期済(閉鎖以外) | 閉鎖 | 更新 | SYNC_TYPE_MODIFY |
同期済(全て) | 削除 | 削除 | SYNC_TYPE_DELETE |
未同期(-) | アクティブ | 登録 | SYNC_TYPE_CREATE |
SYNC_TYPE_CREATE |
|||
未同期(-) | 閉鎖 | 無し | SYNC_TYPE_NONE |
未同期(-) | 削除 | 無し | SYNC_TYPE_NONE |
account
- IM-Mailアカウントpublic void syncAccount(ImMailAccount account) throws ImMailException
指定されたIM-Mailアカウントの同期状態とステータスによって自動的にデータストアへの登録・更新・削除、及びHTTP同期処理を行います。
account
- IM-MailアカウントImMailException
- 同期処理エラーpublic void syncAccount(String userCd) throws ImMailException
指定されたユーザコードのIM-MailアカウントクラスをImMailAccountManager
から取得し、アカウントの同期状態とステータスによって自動的にデータストアへの登録・更新・削除、及びHTTP同期処理を行います。
userCd
- ユーザコードImMailException
- 同期処理エラーpublic void syncCreateAccounts(int syncNo, List<ImMailAccount> accountList) throws ImMailException
指定されたリストに含まれるIM-Mailアカウントをデータストアへ登録・更新して、HTTP同期による登録処理を行います。
注意:リストに含まれるIM-Mailアカウントは、同期対象ドメイン名が全て同じドメイン名である必要があります。
syncNo
- 同期No(同期リクエストID)accountList
- IM-MailアカウントのリストImMailException
- アカウント同期エラーpublic void syncDeleteAccounts(int syncNo, List<ImMailAccount> accountList) throws ImMailException
指定されたリストに含まれるIM-Mailアカウントをデータストアから削除し、HTTP同期による削除処理を行います。
注意:リストに含まれるIM-Mailアカウントは、同期対象ドメイン名が全て同じドメイン名である必要があります。
syncNo
- 同期No(同期リクエストID)accountList
- IM-MailアカウントのリストImMailException
- アカウント同期エラーpublic void syncModifyAccounts(int syncNo, List<ImMailAccount> accountList) throws ImMailException
指定されたリストに含まれるIM-Mailアカウントをデータストアへ登録・更新し、HTTP同期による更新処理を行います。
注意:リストに含まれるIM-Mailアカウントは、同期対象ドメイン名が全て同じドメイン名である必要があります。
syncNo
- 同期No(同期リクエストID)accountList
- IM-MailアカウントのリストImMailException
- アカウント同期エラーCopyright © 2013 NTT DATA INTRAMART CORPORATION