Package com.onenetwork.platform.integ.push

Push technology describes a style of Internet-based communication where the request for a given transaction is initiated by the server, not by the client.

Clients logged into Platform with a push server enabled will have a Web socket connection open for receiving push notifications. If the client's browser does not support Web socket communication, long-polling will be used as a fallback mechanism.

All the Platform-to-PushServer interactions happen on a backchannel port which must be configured in the InstaceConfig.xml using the PushServerConfig element. This package provides a convenience api for sending push messages from Platform to the push server through this backchannel port.

  • Interface Summary 
    Interface Description
    PushRecipient
    Marker interface for creating recipients of push notification
    PushService
    Convenience API for pushing notifications to the push server.
  • Class Summary 
    Class Description
    PushRequest
    Detailed request for sending push messages.
    UserRecipient
    PushRecipient that uses user name and enterprise name as the identifier.
  • Exception Summary 
    Exception Description
    PushServiceException
    Base exception thrown when push service operations fail