Package com.lightstreamer.client.mpn

Class AbstractMpnDevice

  • All Implemented Interfaces:
    MpnDeviceInterface
    Direct Known Subclasses:
    MpnDevice
    public abstract class AbstractMpnDevice
extends java.lang.Object
implements MpnDeviceInterface
    Abstract class representing a device that supports Mobile Push Notifications (MPN).
    It contains device details and the listener needed to monitor its status.
    Note: this abstract class is public due to implementation side effects. It is not meant to be implemented by the user. See MpnDevice for its concrete subclass.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addListener​(MpnDeviceListener listener)
      Adds a listener that will receive events from the MPN device object.
      The same listener can be added to several different MPN device objects.
      java.lang.String getApplicationId()
      The application ID of this MPN device, corresponding to the package name of the application.
      java.lang.String getDeviceId()
      The server-side unique persistent ID of the device.
      The ID is available only after the MPN device object has been successfully registered on the server.
      java.lang.String getDeviceToken()
      The device token of this MPN device.
      java.util.List<MpnDeviceListener> getListeners()
      List containing the MpnDeviceListener instances that were added to this MPN device object.
      java.lang.String getPreviousDeviceToken()
      The previous device token of this MPN device.
      java.lang.String getStatus()
      The status of the device.
      The status can be: UNKNOWN: when the MPN device object has just been created or deleted.
      long getStatusTimestamp()
      The server-side timestamp of the device status.
      boolean isRegistered()
      Checks whether the MPN device object is currently registered on the server or not.
      This flag is switched to true by server sent registration events, and back to false in case of client disconnection or server sent suspension events.
      boolean isSuspended()
      Checks whether the MPN device object is currently suspended on the server or not.
      An MPN device may be suspended if errors occur during push notification delivery.
      This flag is switched to true by server sent suspension events, and back to false in case of client disconnection or server sent resume events.
      void removeListener​(MpnDeviceListener listener)
      Removes a listener from the MPN device object so that it will not receive events anymore.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AbstractMpnDevice

        public AbstractMpnDevice()

    • Method Detail

      • addListener

        public void addListener​(MpnDeviceListener listener)
        Adds a listener that will receive events from the MPN device object.
        The same listener can be added to several different MPN device objects.
        Specified by:
        addListener in interface MpnDeviceInterface
        Parameters:
        listener - An object that will receive the events as documented in the MpnDeviceListener interface.
        See Also:
        removeListener(MpnDeviceListener)
        Lifecycle:
        A listener can be added at any time. A call to add a listener already present will be ignored.

      • isRegistered

        public boolean isRegistered()
        Checks whether the MPN device object is currently registered on the server or not.
        This flag is switched to true by server sent registration events, and back to false in case of client disconnection or server sent suspension events.
        Specified by:
        isRegistered in interface MpnDeviceInterface
        Returns:
        true if the MPN device object is currently registered on the server.
        See Also:
        getStatus()
        Lifecycle:
        This method can be called at any time.

      • isSuspended

        public boolean isSuspended()
        Checks whether the MPN device object is currently suspended on the server or not.
        An MPN device may be suspended if errors occur during push notification delivery.
        This flag is switched to true by server sent suspension events, and back to false in case of client disconnection or server sent resume events.
        Specified by:
        isSuspended in interface MpnDeviceInterface
        Returns:
        true if the MPN device object is currently suspended on the server.
        See Also:
        getStatus()
        Lifecycle:
        This method can be called at any time.

      • getStatus

        @Nonnull
public java.lang.String getStatus()
        The status of the device.
        The status can be:
        • UNKNOWN: when the MPN device object has just been created or deleted. In this status isRegistered() and isSuspended() are both false.
        • REGISTERED: when the MPN device object has been successfully registered on the server. In this status isRegistered() is true and isSuspended() is false.
        • SUSPENDED: when a server error occurred while sending push notifications to this MPN device and consequently it has been suspended. In this status isRegistered() and isSuspended() are both true.
        Specified by:
        getStatus in interface MpnDeviceInterface
        Returns:
        the status of the device.
        See Also:
        isRegistered(), isSuspended()
        Lifecycle:
        This method can be called at any time.

      • getStatusTimestamp

        public long getStatusTimestamp()
        The server-side timestamp of the device status.
        Specified by:
        getStatusTimestamp in interface MpnDeviceInterface
        Returns:
        The server-side timestamp of the device status, expressed as a Java time.
        See Also:
        getStatus()
        Lifecycle:
        This method can be called at any time.

      • getApplicationId

        public java.lang.String getApplicationId()
        The application ID of this MPN device, corresponding to the package name of the application. In the MpnDevice implementation it is determined automatically from the Application Context during creation and is used by the server as part of the device identification.
        Specified by:
        getApplicationId in interface MpnDeviceInterface
        Returns:
        the MPN device application ID.
        Lifecycle:
        This method can be called at any time.

      • getDeviceToken

        public java.lang.String getDeviceToken()
        The device token of this MPN device. In the MpnDevice implementation it is passed during creation and is used by the server as part of the device identification.
        Specified by:
        getDeviceToken in interface MpnDeviceInterface
        Returns:
        the MPN device token.
        Lifecycle:
        This method can be called at any time.

      • getPreviousDeviceToken

        public java.lang.String getPreviousDeviceToken()
        The previous device token of this MPN device. In the MpnDevice implementation it is obtained automatically from the Shared Preferences storage during creation and is used by the server to restore MPN subscriptions associated with this previous token. May be null if no MPN device has been registered yet on the application.
        Specified by:
        getPreviousDeviceToken in interface MpnDeviceInterface
        Returns:
        the previous MPN device token, or null if no MPN device has been registered yet.
        Lifecycle:
        This method can be called at any time.

      • getDeviceId

        public java.lang.String getDeviceId()
        The server-side unique persistent ID of the device.
        The ID is available only after the MPN device object has been successfully registered on the server. I.e. when its status is REGISTERED or SUSPENDED.
        Note: a device token change, if the previous device token was correctly stored on the Shared Preferences storage, does not cause the device ID to change: the server moves previous MPN subscriptions from the previous token to the new one and the device ID remains unaltered.
        Specified by:
        getDeviceId in interface MpnDeviceInterface
        Returns:
        the MPN device ID.
        Lifecycle:
        This method can be called at any time.