com.sun.identity.liberty.ws.disco.plugins
Interface  DiscoEntryHandler
- public interface DiscoEntryHandler
The class DiscoEntryHandler is an interface that is 
 used to get and set DiscoEntries for a user.
 
 A default implementation will be provided for this discovery service.
 If you want to handle DiscoEntry differently, implement this
 interface and set the implementing class to
 DiscoEntryHandler Plugins Class field in Discovery Service.
| Field Summary | 
| static java.lang.String | NEW_ENTRY_IDSKey used in method
 modifyDiscoEntries()return Map. | 
| static java.lang.String | STATUS_CODEKey used in method
 modifyDiscoEntries()return Map. | 
 
| Method Summary | 
|  java.util.Map | getDiscoEntries(java.lang.String userID,
                java.util.List reqServiceTypes)Finds all the
 DiscoEntriesfor a user. | 
|  java.util.Map | modifyDiscoEntries(java.lang.String userID,
                   java.util.List removes,
                   java.util.List inserts)Modify
 DiscoEntriesfor a user. | 
 
STATUS_CODE
public static final java.lang.String STATUS_CODE
- Key used in method modifyDiscoEntries()return Map.
 The value of this key is status code String such as "OK", "Failed", etc.
NEW_ENTRY_IDS
public static final java.lang.String NEW_ENTRY_IDS
- Key used in method modifyDiscoEntries()return Map.
 The value of this key is a List ofentryIdsfor the entries
 that were added.
getDiscoEntries
public java.util.Map getDiscoEntries(java.lang.String userID,
                                     java.util.List reqServiceTypes)
- Finds all the DiscoEntriesfor a user.
- 
- Parameters:
- userID- The user whose- DiscoEntrieswill be returned.
- reqServiceTypes- List of- com.sun.identity.liberty.ws.disco.jaxb.RequestedServiceTypeobjects from discovery Query.
- Returns:
- Map of entryIdandcom.sun.identity.liberty.ws.disco.plugins.jaxb.DiscoEntryElementjaxbobjects for this user. For eachDiscoEntryelement in the List, theentryIdattribute ofResourceOfferingshould be set.
 
modifyDiscoEntries
public java.util.Map modifyDiscoEntries(java.lang.String userID,
                                        java.util.List removes,
                                        java.util.List inserts)
- Modify DiscoEntriesfor a user.
- 
- Parameters:
- userID- The user whose- DiscoEntrieswill be set.
- removes- List of- com.sun.identity.liberty.ws.disco.jaxb.RemoveEntryType- jaxbobjects.
- inserts- List of- com.sun.identity.liberty.ws.disco.jaxb.InsertEntryType- jaxbobjects.
- Returns:
- Map which contains the following key value pairs:
		Key: DiscoEntryHandler.STATUS_CODEValue: status code String such as "OK", "Failed", etc.
		Key:DiscoEntryHandler.NEW_ENTRY_IDSValue: List ofentryIdsfor the entries that were
          added.
		The second key/value pair will only exist when status code is
		"OK", and there areInsertEntryelements in theModifyrequest.
		When successful, all modification (removes and inserts) should
		be done. No partial changes should be done.
 
Copyright 2005 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.