レプリカをフィルターする方法
このトピックでは、マネージ言語を使用して、フィルターされたレプリカを表す Sync Framework プロバイダーを実装する方法について説明します。フィルターされたレプリカは、そのフィルター内にある項目または変更単位のデータだけを格納します。
このトピックは、C# および Microsoft .NET Framework の概念について基本的な知識がある方を対象としています。
このトピックの例では、次に示す Sync Framework のクラスとメンバーを中心に説明します。
フィルターされたレプリカについて
フィルターされたレプリカには、フィルターに含まれている項目と変更単位のみに対して項目と変更単位のデータが格納され、フィルターに含まれていたが除外された項目と変更単位のメタデータである非実体も格納されます。フィルターされたレプリカはそのフィルターを追跡しますが、他のフィルターも追跡することがあります。フィルターされたレプリカは同期元プロバイダーとの間でフィルターに関するネゴシエーションを行うことができます。その場合、同期元プロバイダーはフィルターされた変更バッチを作成します。同期元プロバイダーでフィルターされた変更バッチを作成できない場合、フィルターされたプロバイダーは独自に変更をフィルターし、フィルター内に存在する変更のみを適用します。
フィルターされたプロバイダーは、フィルターに移動した項目について変更の適用元と通信するために IFilteredReplicaNotifyingChangeApplierTarget を実装します。また、一般的に、フィルターされたプロバイダーは、IRequestFilteredSync を実装するので、同期元プロバイダーが変更の列挙に使用するフィルターのネゴシエーションを行うことができます。
ビルド要件
.NET Framework 2.0 以降
例
このトピックのコード例は、フィルターされた同期先プロバイダーを実装する方法を示します。フィルターされたプロバイダーは、非実体を含むフィルターされた変更バッチを要求し、フィルターされた変更および非実体を同期先レプリカに適用します。この例のレプリカは、連絡先情報がコンマ区切りの値の一覧として保存されているテキスト ファイルです。同期する項目は、このファイルに含まれる連絡先です。フィルターは、連絡先のアドレス フィールドでフィルター文字列が見つかった場合にのみ連絡先を含める文字列です。
フィルターのネゴシエーション
Sync Framework が同期先レプリカの SpecifyFilter メソッドを呼び出すとき、同期先レプリカは、同期元プロバイダーが変更の列挙に使用するフィルターを要求します。この例は、同期先レプリカによって追跡されるフィルターの一覧の最初のフィルターを指定し、同期元プロバイダーがフィルターを拒否したときに例外をスローします。
public void SpecifyFilter(FilterRequestCallback filterRequest)
{
// Use the first tracked filter as the filter for sync.
if (0 < _ContactStore.TrackedFilters.Count)
{
_filterForSync = _ContactStore.TrackedFilters[0];
}
// The source provider must agree to send a filtered change batch.
if (!filterRequest(_filterForSync, FilteringType.CurrentItemsAndVersionsForMovedOutItems))
{
throw new SyncInvalidOperationException("Filter specified by SpecifyFilter was rejected.");
}
}
フィルター選択された変更の適用
同期先プロバイダーは、変更適用元を使用して変更バッチを処理します。Metadata Storage Service はカスタム フィルターをサポートしないので、ローカル バージョンの一覧を変更適用元に送信する前に、一覧を更新して非実体の変更を更新する必要があります。
public override void ProcessChangeBatch(ConflictResolutionPolicy resolutionPolicy, ChangeBatch sourceChanges, object changeDataRetriever, SyncCallbacks syncCallbacks, SyncSessionStatistics sessionStatistics)
{
// Use the metadata storage service to get the local versions of changes received from the source provider.
IEnumerable<ItemChange> localVersions = _ContactStore.ContactReplicaMetadata.GetLocalVersions(sourceChanges);
// Copy and fix up the local version list to include ghost information.
List<ItemChange> fixedLocalVersions = new List<ItemChange>();
ChangeKind fixedChangeKind;
foreach (ItemChange localVersion in localVersions)
{
fixedChangeKind = localVersion.ChangeKind;
if (localVersion.ChangeKind != ChangeKind.UnknownItem && _ContactStore.IsGhost(localVersion.ItemId))
{
fixedChangeKind = ChangeKind.Ghost;
}
fixedLocalVersions.Add(new ItemChange(IdFormats, localVersion.ReplicaId, localVersion.ItemId, fixedChangeKind, localVersion.CreationVersion,
localVersion.ChangeVersion));
}
// Use a NotifyingChangeApplier object to process the changes. Note that the provider object is passed as the INotifyingChangeApplierTarget
// object that will be called to apply changes to the item store.
NotifyingChangeApplier changeApplier = new NotifyingChangeApplier(ContactStore.ContactIdFormatGroup);
changeApplier.ApplyChanges(resolutionPolicy, sourceChanges, (IChangeDataRetriever)changeDataRetriever,
fixedLocalVersions, _ContactStore.ContactReplicaMetadata.GetKnowledge(),
_ContactStore.ContactReplicaMetadata.GetForgottenKnowledge(), this, _sessionContext, syncCallbacks);
}
変更適用元は、SaveItemChange メソッドを呼び出して変更を保存します。フィルターされたレプリカは、非実体に影響する変更操作を処理します。
case SaveChangeAction.CreateGhost:
case SaveChangeAction.UpdateGhost:
{
try
{
_ContactStore.UpdateGhostFromSync(change, _filterKeyMap);
}
catch (Exception ex)
{
RecoverableErrorData errData = new RecoverableErrorData(ex);
context.RecordRecoverableErrorForItem(errData);
}
break;
}
case SaveChangeAction.MarkItemAsGhost:
{
try
{
// Delete the item from the contact store and update the metadata to indicate it is a ghost.
_ContactStore.MarkItemAsGhost(change, _filterKeyMap);
}
catch (Exception ex)
{
RecoverableErrorData errData = new RecoverableErrorData(ex);
context.RecordRecoverableErrorForItem(errData);
}
break;
}
case SaveChangeAction.UnmarkItemAsGhost:
{
try
{
// Create the item in the contact store and update the metadata to indicate the item is not a ghost.
_ContactStore.UnmarkItemAsGhost(change, (string)context.ChangeData, _filterKeyMap);
}
catch (Exception ex)
{
RecoverableErrorData errData = new RecoverableErrorData(ex);
context.RecordRecoverableErrorForItem(errData);
}
break;
}
case SaveChangeAction.DeleteGhostAndStoreTombstone:
{
try
{
_ContactStore.DeleteGhostFromSync(change.ItemId, change.ChangeVersion);
}
catch (Exception ex)
{
RecoverableErrorData errData = new RecoverableErrorData(ex);
context.RecordRecoverableErrorForItem(errData);
}
break;
}
public void UpdateGhostFromSync(ItemChange itemChange, FilterKeyMap providerFilterKeyMap)
{
// Find the ghost metadata in our list or load it from the metadata store.
ItemMetadata itemMeta = null;
if (_ContactGhostMetaList.ContainsKey(itemChange.ItemId))
{
itemMeta = _ContactGhostMetaList[itemChange.ItemId];
}
else
{
itemMeta = _ContactReplicaMetadata.FindItemMetadataById(itemChange.ItemId);
}
// The ghost does not exist, so create it and add it to the metadata store.
if (null == itemMeta)
{
itemMeta = _ContactReplicaMetadata.CreateItemMetadata(itemChange.ItemId,
itemChange.CreationVersion);
InitializeFilterTrackingFields(itemMeta);
// Create values for all index fields in the metadata store.
itemMeta.SetCustomField(FirstNameField, itemChange.ItemId.ToString());
itemMeta.SetCustomField(LastNameField, "0");
itemMeta.SetCustomField(PhoneNumberField, "0");
_ContactGhostMetaList.Add(itemMeta.GlobalId, itemMeta);
}
// Set the version metadata for the change unit by using the metadata storage service.
itemMeta.ChangeVersion = itemChange.ChangeVersion;
// Update the filter tracking metadata for filter change metadata sent from the source provider.
for (int iFilter = 0; iFilter < _trackedFilters.Count; iFilter++)
{
// Get filter change metadata from the source provider for this change, if it exists.
FilterChange filterChange = GetFilterChange(itemChange, iFilter, providerFilterKeyMap);
// If filter change metadata is present, use it to update the item metadata.
if (null != filterChange)
{
SetIsInFilter(itemMeta, iFilter, filterChange.IsMoveIn);
SetMoveVersion(itemMeta, iFilter, filterChange.MoveVersion);
}
}
}
public bool IsGhost(SyncId itemId)
{
bool isGhost = false;
ItemMetadata itemMeta = _ContactReplicaMetadata.FindItemMetadataById(itemId);
if (null != itemMeta)
{
// The item is a ghost if it is not deleted and it does not exist in the contact store.
isGhost = (!itemMeta.IsDeleted && !_ContactList.ContainsKey(itemId));
}
return isGhost;
}
public void MarkItemAsGhost(ItemChange itemChange, FilterKeyMap providerFilterKeyMap)
{
// Delete the item from the contact store.
_ContactList.Remove(itemChange.ItemId);
// Move the item from the active metadata list to the ghost list.
ItemMetadata ghostMeta = _ContactItemMetaList[itemChange.ItemId];
_ContactGhostMetaList.Add(itemChange.ItemId, ghostMeta);
_ContactItemMetaList.Remove(itemChange.ItemId);
// Update the filter tracking metadata for filter change metadata sent from the source provider.
for (int iFilter = 0; iFilter < _trackedFilters.Count; iFilter++)
{
// Get filter change metadata from the source provider for this change, if it exists.
FilterChange filterChange = GetFilterChange(itemChange, iFilter, providerFilterKeyMap);
// If filter change metadata is present, use it to update the item metadata.
if (null != filterChange)
{
SetIsInFilter(ghostMeta, iFilter, filterChange.IsMoveIn);
SetMoveVersion(ghostMeta, iFilter, filterChange.MoveVersion);
}
}
}
public void UnmarkItemAsGhost(ItemChange itemChange, string changeData, FilterKeyMap providerFilterKeyMap)
{
// Get the metadata for the ghost.
ItemMetadata itemMeta = null;
if (_ContactGhostMetaList.ContainsKey(itemChange.ItemId))
{
itemMeta = _ContactGhostMetaList[itemChange.ItemId];
}
else
{
itemMeta = _ContactReplicaMetadata.FindItemMetadataById(itemChange.ItemId);
}
if (null == itemMeta)
{
throw new SyncInvalidOperationException("UnmarkItemAsGhost received an item but has not metadata for the item.");
}
// Create a new contact and add it to the contact store.
Contact contact = new Contact();
_ContactList.Add(itemMeta.GlobalId, contact);
_ContactList[itemChange.ItemId].FromString(changeData);
// Move the metadata from the ghost list to the active list.
_ContactItemMetaList.Add(itemMeta.GlobalId, itemMeta);
_ContactGhostMetaList.Remove(itemMeta.GlobalId);
// Update the metadata for the item.
UpdateContactMetadataInternal(itemChange.ItemId, itemChange.ChangeVersion, itemChange, providerFilterKeyMap);
}
// Mark a ghost as deleted in the metadata store.
public void DeleteGhostFromSync(SyncId itemId, SyncVersion changeVersion)
{
// Find the item in the ghost metadata list or load it from the metadata store.
ItemMetadata itemMeta = null;
if (_ContactGhostMetaList.ContainsKey(itemId))
{
itemMeta = _ContactGhostMetaList[itemId];
}
else
{
itemMeta = _ContactReplicaMetadata.FindItemMetadataById(itemId);
}
if (null == itemMeta)
{
throw new SyncInvalidOperationException("DeleteGhostFromSync received item but has no metadata.");
}
//Mark item as deleted.
itemMeta.MarkAsDeleted(changeVersion);
// Clear the index name field so it doesn't collide with future items.
itemMeta.SetCustomField(FirstNameField, itemMeta.GlobalId.ToString());
// Move the item to the deleted list.
_ContactDeletedItemMetaList.Add(itemMeta);
_ContactGhostMetaList.Remove(itemMeta.GlobalId);
}
フィルターに追加された項目の列挙
フィルターされたプロバイダーは、フィルターに移動した項目について変更の適用元と通信するために IFilteredReplicaNotifyingChangeApplierTarget を実装します。この例は、メタデータ ストア内のすべての項目を列挙します。項目がレプリカのフィルター内にあり、指定されたベース ナレッジに項目の移動バージョンが含まれていない場合は、返された一覧に項目を追加します。
public IEnumerator<SyncId> GetNewMoveInItems(SyncKnowledge baseKnowledge)
{
List<SyncId> newMoveInIdList = new List<SyncId>();
IEnumerable<ItemMetadata> allItems = _ContactStore.ContactReplicaMetadata.GetAllItems(false);
SyncKnowledge mappedBaseKnowledge = _ContactStore.ContactReplicaMetadata.GetKnowledge().MapRemoteKnowledgeToLocal(baseKnowledge);
foreach (ItemMetadata itemMeta in allItems)
{
FilterChange filterChange = _ContactStore.GetTrackedFilterMetadata(itemMeta, _filterForSync);
if (filterChange.IsMoveIn)
{
if (!mappedBaseKnowledge.Contains(_ContactStore.ContactReplicaMetadata.ReplicaId, itemMeta.GlobalId, filterChange.MoveVersion))
{
newMoveInIdList.Add(itemMeta.GlobalId);
}
}
}
return newMoveInIdList.GetEnumerator();
}
次の手順
次は、フィルター ネゴシエーションをプロバイダーに追加して、変更列挙にどのフィルターを使用するかを同期先プロバイダーと通信して決定できるようにします。フィルターのネゴシエーションの詳細については、「フィルター ネゴシエーションの方法」を参照してください。
プロバイダーでフィルターを追跡する必要がある場合があります。フィルター追跡レプリカは、フィルターされたレプリカに変更を送信するときにナレッジのサイズを小さく抑えます。フィルター追跡プロバイダーを実装する方法の詳細については、「フィルターを追跡し、フィルターされた変更を列挙する方法」を参照してください。