org.jboss.aerogear.android.unifiedpush

Class RegistrarManager

java.lang.Object

org.jboss.aerogear.android.unifiedpush.RegistrarManager

public class RegistrarManager
extends Object

This is the factory and accessors for PushRegistrars

Constructor Summary

Constructors

Constructor and Description
RegistrarManager()

Method Summary

Modifier and Type	Method and Description
static <CFG extends PushConfiguration<CFG>> CFG	config(String name, Class<CFG> pushConfigurationClass) Begins a new fluent configuration stanza.
static PushRegistrar	getRegistrar(String name) Fetches a named registrar
protected static void	notifyHandlers(android.content.Context context, android.content.Intent message) This will deliver an intent to all registered handlers.
static void	notifyHandlers(android.content.Context context, android.content.Intent message, MessageHandler defaultHandler) This will deliver an intent to all registered handlers.
static void	registerBackgroundThreadHandler(MessageHandler handler) When a push message is received, all background thread handlers will be notified on a non UI thread.
static <CFG extends PushConfiguration<CFG>> void	registerConfigurationProvider(Class<CFG> configurationClass, org.jboss.aerogear.android.core.ConfigurationProvider<CFG> provider) This will add a new Configuration that this Manager can build Configurations for.
static void	registerMainThreadHandler(MessageHandler handler) When a push message is received, all main thread handlers will be notified on the main(UI) thread.
static void	unregisterBackgroundThreadHandler(MessageHandler handler) This will remove the given handler from the collection of background thread handlers.
static void	unregisterMainThreadHandler(MessageHandler handler) This will remove the given handler from the collection of main thread handlers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegistrarManager

public RegistrarManager()

Method Detail

registerConfigurationProvider

public static <CFG extends PushConfiguration<CFG>> void registerConfigurationProvider(Class<CFG> configurationClass,
                                                                                      org.jboss.aerogear.android.core.ConfigurationProvider<CFG> provider)

This will add a new Configuration that this Manager can build Configurations for.

Type Parameters:

CFG - the actual Configuration type

Parameters:

configurationClass - the class of configuration to be registered

provider - the instance which will provide the configuration.

config

public static <CFG extends PushConfiguration<CFG>> CFG config(String name,
                                                              Class<CFG> pushConfigurationClass)

Begins a new fluent configuration stanza.

Type Parameters:

CFG - the Configuration type.

Parameters:

name - an identifier which will be used to fetch the PushRegistrar after configuration is finished.

pushConfigurationClass - the class of the configuration type.

Returns:

a PushConfiguration which can be used to build a AuthenticationModule object.

getRegistrar

public static PushRegistrar getRegistrar(String name)

Fetches a named registrar

Parameters:

name - the name of the PushRegistrar given in config(java.lang.String, java.lang.Class)

Returns:

the named PushRegistrar or null

registerMainThreadHandler

public static void registerMainThreadHandler(MessageHandler handler)

When a push message is received, all main thread handlers will be notified on the main(UI) thread. This is very convenient for Activities and Fragments.

Parameters:

handler - a handler to added to the list of handlers to be notified.

registerBackgroundThreadHandler

public static void registerBackgroundThreadHandler(MessageHandler handler)

When a push message is received, all background thread handlers will be notified on a non UI thread. This should be used by classes which need to update internal state or preform some action which doesn't change the UI.

Parameters:

handler - a handler to added to the list of handlers to be notified.

unregisterMainThreadHandler

public static void unregisterMainThreadHandler(MessageHandler handler)

This will remove the given handler from the collection of main thread handlers. This MUST be called when a Fragment or activity is backgrounded via onPause.

Parameters:

handler - a new handler

unregisterBackgroundThreadHandler

public static void unregisterBackgroundThreadHandler(MessageHandler handler)

This will remove the given handler from the collection of background thread handlers.

Parameters:

handler - a new handler

notifyHandlers

public static void notifyHandlers(android.content.Context context,
                                  android.content.Intent message,
                                  MessageHandler defaultHandler)

This will deliver an intent to all registered handlers. See PushConstants for information on how messages will be routed.

Parameters:

context - the application's context

message - the message to pass

defaultHandler - a default handler is a handler which will be called if there are no other handlers registered. May be null

notifyHandlers

protected static void notifyHandlers(android.content.Context context,
                                     android.content.Intent message)

This will deliver an intent to all registered handlers. Currently it is GCM centric, but this will be changed in the future. See: AGDROID-84

Parameters:

context - the application's context

message - the message to pass