Package org.forgerock.openam.services.push

Interface PushNotificationDelegateFactory

@SupportedAll
public interface PushNotificationDelegateFactory

Defines how PushNotificationDelegates should be created. This acts as a plugin point for customers to ensure they can configure their own PushNotificationDelegates if desired. Once written, the PushNotificationDelegateFactory should be added to the configuration of the Push Notification Service (PushNotificationService) ready for operation.

See Also:

PushNotificationService.createFactory(String)

Method Summary

Modifier and Type	Method	Description
PushNotificationDelegate	produceDelegateFor(org.forgerock.openam.services.push.PushNotificationServiceConfig.Realm config, String realm, org.forgerock.openam.services.push.dispatch.MessageDispatcher messageDispatcher)	Produce a delegate for a given configuration.

Method Detail

produceDelegateFor

PushNotificationDelegate produceDelegateFor(org.forgerock.openam.services.push.PushNotificationServiceConfig.Realm config,
                                            String realm,
                                            org.forgerock.openam.services.push.dispatch.MessageDispatcher messageDispatcher)
                                     throws org.forgerock.openam.services.push.PushNotificationException

Produce a delegate for a given configuration. This delegate should be ready to use as soon as the delegate has been produced.

Parameters:

config - The config that will be used to configure the PushNotificationService.

realm - The realm in which this delegate will exist.

messageDispatcher - The message dispatcher for this delegate.

Returns:

A valid PushNotificationService, ready to send (and receive if appropriate) messages.

Throws:

org.forgerock.openam.services.push.PushNotificationException - in the case where we cannot generate an appropriate delegate.