SynchronizeGroups
As described in Groups, it is sometimes necessary for a connector to provide group membership information to a group server.
OmniGroupServer might be configured to store group information from a repository with the following settings:
[MyRepository] GroupServerJobType=Connector ConnectorHost=localhost ConnectorPort=1234 ConnectorTask=MyFetchTask
When OmniGroupServer needs to get the latest group membership information for the “MyRepository” repository, it sends a SynchronizeGroups
fetch action to the connector listening at localhost:1234
.
To implement the SynchronizeGroups
fetch action, a connector implementation must override the S
ynchronizeGroups
method in ConnectorBase
, as illustrated in this sample code:
public override void SynchronizeGroups(ISynchronizeGroupsTask task) { task.GroupServer.AddMemberUser("Editors", "Samantha"); task.GroupServer.AddMemberUser("Editors", "George"); task.GroupServer.AddMemberUser("Viewers", "Samantha"); task.GroupServer.AddMemberUser("Viewers", "Henry"); task.GroupServer.Finish(); }
The I
SynchronizeGroupsTask
passed in to the S
ynchronizeGroups
method has a GroupServer
member that allows you to send membership information to the Group Server. In this example the user “Samantha” is a member of the “Editors” group and the “Viewers” group, “George” is a member of the “Editors” group only, and “Henry” is a member of the “Viewers” group only. This information completely replaces any information previously present in the group server [MyRepository]
repository.
When the connector has updated the group server with all of the group membership information from the repository, the SynchronizeGroups
task is complete.