Package org.forgerock.openam.services.push
Defines classes for the Push Notification service and framework.
-
Interface Summary Interface Description PushMessageConverter Interface to ensure that each delegate system can successfully convert a basicPushMessageinto one appropriate for putting on the wire.PushNotificationDelegate ThePushNotificationServiceis responsible for monitoring configuration changes and detecting when it should create new instances of any givenPushNotificationDelegate.PushNotificationDelegateFactory Defines how PushNotificationDelegates should be created. -
Class Summary Class Description PushGuiceModule Guice module for OpenAM Push related classes.PushMessage A class representing a message to be sent via a PushNotificationDelegate.PushNotificationConstants Constants for the PushNotification Services and Delegates.PushNotificationRestRouteProvider ARestRouteProviderthat add routes for the audit endpoint.PushNotificationService The PushNotificationManager holds a map of instantiated PushNotificationDelegates to their realm in which they exist.PushNotificationServiceConfig Config class for a Push Notification Service.PushNotificationServiceConfig.Builder Internal builder for the config to ease creation.PushNotificationServiceConfigHelper Helper for reading a PushNotificationService config, to decouple and aid testing.PushNotificationServiceConfigHelperFactory Decouples the PushNotificationService from its config to aid testing.PushNotificationServiceSetupListener Starts the Push Notification Service on each realm as soon as the server starts, to ensure that endpoints are appropriately created and made available. -
Exception Summary Exception Description PushNotificationException Exception for issues encountered during the operation of the PushNotificationService or PushNotificationDelegates.