Hub

Amplify has a local eventing system called Hub. It is a lightweight implementation of Publisher-Subscriber pattern, and is used to share data between modules and components in your app. Amplify uses Hub for different categories to communicate with one another when specific events occur, such as authentication events like a user sign-in or notification of a file download.

Working with the API

Listening for messages

Hub.subscribe(HubChannel hubChannel, HubSubscriber hubSubscriber) is used to listen for messages that have been dispatched. Additionally, you can pass a HubEventFilter in the overloaded subscribe method to further filter Hub events. You can add multiple listeners to your application for different combinations of channels/filters to listen for.

1Amplify.Hub.subscribe(HubChannel.AUTH,
2    hubEvent -> {
3        if (hubEvent.getName().equals(InitializationStatus.SUCCEEDED.name())) {
4            Log.i("AuthQuickstart", "Auth successfully initialized");
5        } else if (hubEvent.getName().equals(InitializationStatus.FAILED.name())){
6            Log.i("AuthQuickstart", "Auth failed to succeed");
7        } else {
8            String eventName = hubEvent.getName();
9            if (eventName.equals(SIGNED_IN.name())) {
10                Log.i("AuthQuickstart", "Auth just became signed in.");
11            }
12            else if (eventName.equals(SIGNED_OUT.name())) {
13                Log.i("AuthQuickstart", "Auth just became signed out.");
14            }
15            else if (eventName.equals(SESSION_EXPIRED.name())) {
16                Log.i("AuthQuickstart", "Auth session just expired.");
17            }
18            else if (eventName.equals(USER_DELETED.name())) {
19                Log.i("AuthQuickstart", "User has been deleted.");
20            }
21            else {
22                Log.w("AuthQuickstart", "Unhandled Auth Event: " + eventName);
23            }
24        }
25    }
26);

1Amplify.Hub.subscribe(HubChannel.AUTH) { event ->
2    when (event.name) {
3        InitializationStatus.SUCCEEDED.name ->
4            Log.i("AuthQuickstart", "Auth successfully initialized")
5        InitializationStatus.FAILED.name ->
6            Log.i("AuthQuickstart", "Auth failed to succeed")
7        else -> when (event.name) {
8            AuthChannelEventName.SIGNED_IN.name ->
9                Log.i("AuthQuickstart", "Auth just became signed in")
10            AuthChannelEventName.SIGNED_OUT.name ->
11                Log.i("AuthQuickstart", "Auth just became signed out")
12            AuthChannelEventName.SESSION_EXPIRED.name ->
13                Log.i("AuthQuickstart", "Auth session just expired")
14            AuthChannelEventName.USER_DELETED.name ->
15                Log.i("AuthQuickstart", "User has been deleted")
16            else ->
17                Log.w("AuthQuickstart", "Unhandled Auth Event: ${event.name}")
18        }
19    }
20}

1Amplify.Hub.subscribe(HubChannel.AUTH).collect {
2    when (it.name) {
3        InitializationStatus.SUCCEEDED.name ->
4            Log.i("AuthQuickstart", "Auth successfully initialized")
5        InitializationStatus.FAILED.name ->
6            Log.i("AuthQuickstart", "Auth failed to succeed")
7        else -> when (it.name) {
8            AuthChannelEventName.SIGNED_IN.name ->
9                Log.i("AuthQuickstart", "Auth just became signed in.")
10            AuthChannelEventName.SIGNED_OUT.name ->
11                Log.i("AuthQuickstart", "Auth just became signed out.")
12            AuthChannelEventName.SESSION_EXPIRED.name ->
13                Log.i("AuthQuickstart", "Auth session just expired.")
14            AuthChannelEventName.USER_DELETED.name ->
15                Log.i("AuthQuickstart", "User has been deleted.")
16            else ->
17                Log.w("AuthQuickstart", "Unhandled Auth Event: ${it.name}")
18        }
19    }
20}

1RxAmplify.Hub.on(HubChannel.AUTH)
2    .map(HubEvent::getName)
3    .subscribe(name -> {
4        if (name.equals(InitializationStatus.SUCCEEDED.name())) {
5            Log.i("AuthQuickstart", "Auth successfully initialized");
6            return;
7        } else if (name.equals(InitializationStatus.FAILED.name())) {
8            Log.i("AuthQuickstart", "Auth failed to succeed");
9            return;
10        } else {
11            if (name.equals(SIGNED_IN.name())) {
12                Log.i("AuthQuickstart", "Auth just became signed in.");
13            }
14            else if (name.equals(SIGNED_OUT.name())) {
15                Log.i("AuthQuickstart", "Auth just became signed out.");
16            }
17            else if (name.equals(SESSION_EXPIRED.name())) {
18                Log.i("AuthQuickstart", "Auth session just expired.");
19            }
20            else if (name.equals(USER_DELETED.name())) {
21                Log.i("AuthQuickstart", "User has been deleted.");
22            }
23            else {
24                Log.w("AuthQuickstart", "Unhandled Auth Event: " + hubEvent.getName());
25            }
26        }
27    });

Stop Listening

Hub provides a way to stop listening for messages. This is useful if you no longer need to receive messages in your application flow (ex: changing Activities or Fragments), as well as to avoid any memory leaks.

1// Subscribe to Hub Auth events and capture the returned SubscriptionToken
2SubscriptionToken subscriptionToken = Amplify.Hub.subscribe(HubChannel.AUTH, event -> {
3    handleAuthEvent(event);
4});
5
6// Unsubscribe by passing the captured SubscriptionToken
7Amplify.Hub.unsubscribe(subscriptionToken);

1// Subscribe to Hub Auth events and capture the returned SubscriptionToken
2val subscriptionToken = Amplify.Hub.subscribe(HubChannel.AUTH) { event ->
3    handleAuthEvent(event)
4}
5
6// Unsubscribe by passing the captured SubscriptionToken 
7Amplify.Hub.unsubscribe(subscriptionToken)