|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface that provides user and group synchronization functionality against a remote system.
Method Summary | |
IGroup |
attachToGroup(java.lang.String groupID)
Gets an IGroup object used to query for groups and users contained within
the specified group. |
SyncObjectList |
getGroups()
Returns a SyncObjectList object with an array of SyncObject s inside representing groups. |
SyncObjectList |
getUsers()
Returns a SyncObjectList object with an array of SyncObject s inside representing users. |
boolean |
initialize(SyncInfo syncInfo)
Initializes the synchronization provider using the information configured in the portal by the administrator. |
void |
reset()
Called when an IGroup is done with any queries for subusers and subgroups. |
void |
shutdown()
Cleans up any resources used by the synchronization provider. |
Method Detail |
public SyncObjectList getGroups() throws ServiceException
SyncObjectList
object with an array of SyncObject
s inside representing groups.
The portal will continue calling getGroups
until it receives a
SyncObjectList
with the isDone
flag set to true. If the ISyncProvider
implementation returns these SyncObject
s in batches, it must
maintain state internally and return isDone=false
until the last
batch.
SyncObjectList
object containing SyncObject
s that represent groups
ServiceException
- if an error occurredSyncObjectList
,
SyncObject.createGroup(String, String)
public SyncObjectList getUsers() throws ServiceException
SyncObjectList
object with an array of SyncObject
s inside representing users.
The portal will continue calling getUsers
until it receives a
SyncObjectList
with the isDone
flag set to true. If the ISyncProvider
implementation returns these SyncObject
s in batches, it must
maintain state internally and return isDone=false
until the last
batch.
SyncObjectList
object containing SyncObject
s that represent users
ServiceException
- if an error occurredSyncObjectList
,
SyncObject.createUser(String, String, String)
public IGroup attachToGroup(java.lang.String groupID) throws ServiceException
IGroup
object used to query for groups and users contained within
the specified group.
groupID
- the string ID of the group to query
IGroup
interface
ServiceException
- if an error occurredpublic boolean initialize(SyncInfo syncInfo) throws ServiceException
syncInfo
- the data set in the portal's SCI editors. Note: The names in the NamedValue
s in syncInfo
will be uppercase.
ServiceException
- if an error occurredpublic void reset() throws ServiceException
IGroup
is done with any queries for subusers and subgroups.
Used to clean up state management.
This method is generally not required for synchronization against a version 5.0 portal.
ServiceException
- if an error occurredpublic void shutdown() throws ServiceException
ServiceException
- if an error occurred.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright ©2010 Oracle® Corporation. All Rights Reserved.