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_IDS Key used in method modifyDiscoEntries() return Map.
static java.lang.String	STATUS_CODE Key used in method modifyDiscoEntries() return Map.

Method Summary

java.util.Map	getDiscoEntries(java.lang.String userID, java.util.List reqServiceTypes) Finds all the DiscoEntries for a user.
java.util.Map	modifyDiscoEntries(java.lang.String userID, java.util.List removes, java.util.List inserts) Modify DiscoEntries for a user.

Field Detail

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.

See Also:

Constant Field Values

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 of entryIds for the entries that were added.

See Also:

Constant Field Values

Method Detail

getDiscoEntries

public java.util.Map getDiscoEntries(java.lang.String userID,
                                     java.util.List reqServiceTypes)

Finds all the DiscoEntries for a user.

Parameters:

userID - The user whose DiscoEntries will be returned.

reqServiceTypes - List of com.sun.identity.liberty.ws.disco.jaxb.RequestedServiceType objects from discovery Query.

Returns:

Map of entryId and com.sun.identity.liberty.ws.disco.plugins.jaxb.DiscoEntryElement jaxb objects for this user. For each DiscoEntry element in the List, the entryId attribute of ResourceOffering should be set.

modifyDiscoEntries

public java.util.Map modifyDiscoEntries(java.lang.String userID,
                                        java.util.List removes,
                                        java.util.List inserts)

Modify DiscoEntries for a user.

Parameters:

userID - The user whose DiscoEntries will be set.

removes - List of com.sun.identity.liberty.ws.disco.jaxb.RemoveEntryType jaxb objects.

inserts - List of com.sun.identity.liberty.ws.disco.jaxb.InsertEntryType jaxb objects.

Returns:

Map which contains the following key value pairs: Key: DiscoEntryHandler.STATUS_CODE Value: status code String such as "OK", "Failed", etc. Key: DiscoEntryHandler.NEW_ENTRY_IDS Value: List of entryIds for the entries that were added. The second key/value pair will only exist when status code is "OK", and there are InsertEntry elements in the Modify request. When successful, all modification (removes and inserts) should be done. No partial changes should be done.