com.sun.identity.entitlement.interfaces

Interface IEntitlementListenerRegistry

All Known Implementing Classes:

OpenSSOEntitlementListener

public interface IEntitlementListenerRegistry

This interface defines the methods for adding and removing entitlement listeners.

Method Summary

Modifier and Type	Method and Description
void	addListener(Subject adminSubject, EntitlementListener l) Adds entitlement listener.
Set<EntitlementListener>	getListeners(Subject adminSubject) Returns a set of registered entitlement listener.
boolean	removeListener(Subject adminSubject, String url) Returns true if listener(s) is/are successfully removed.

Method Detail

addListener

void addListener(Subject adminSubject,
                 EntitlementListener l)
          throws EntitlementException

Adds entitlement listener.

Parameters:

adminSubject - administrator subject.

l - entitlement listener.

Throws:

EntitlementException - if listener cannot be added.

getListeners

Set<EntitlementListener> getListeners(Subject adminSubject)
                               throws EntitlementException

Returns a set of registered entitlement listener.

Parameters:

adminSubject - administrator subject.

Returns:

a set of registered entitlement listener.

Throws:

EntitlementException - if listener cannot be retrieved.

removeListener

boolean removeListener(Subject adminSubject,
                       String url)
                throws EntitlementException

Returns true if listener(s) is/are successfully removed.

Parameters:

adminSubject - administrator subject.

url - Notification URL.

Returns:

true if listener(s) is/are successfully removed.

Throws:

EntitlementException - if listener(s) cannot be removed.