Class PushSendRequest
java.lang.Object
com.iizix.server.push.engine.PushSendRequest
- All Implemented Interfaces:
IPushSendRequest
A send request: the notification, the filter, the three per-send policies (null for the server default) and the operator's authorization scope.
- Author:
- Christopher Mindus
Constructor Summary
ConstructorsConstructorDescriptionPushSendRequest(IPushNotification notification, ISubscriptionFilter filter, ResidencyPolicy residencyPolicy, DeliveryUrgency urgency, DeliveryMode deliveryMode, IRegionScope authorizationScope) Constructor.Method Summary
Modifier and TypeMethodDescriptionGets the region scope the issuing operator is authorized for.Gets the delivery mode for this send, ornullto use the server defaultIPushSettings.getDefaultDeliveryMode().Gets the filter selecting the target subscriptions (the "group").Gets the notification to send.Gets the residency policy for this send, ornullto use the server defaultIPushSettings.getDefaultResidencyPolicy().Gets the delivery urgency for this send, ornullto use the server defaultDeliveryUrgency.NORMAL.static PushSendRequestof(IPushNotification notification, ISubscriptionFilter filter) Creates a request with server-default policies and an unrestricted operator scope.
Constructor Details
PushSendRequest
public PushSendRequest(IPushNotification notification, ISubscriptionFilter filter, ResidencyPolicy residencyPolicy, DeliveryUrgency urgency, DeliveryMode deliveryMode, IRegionScope authorizationScope) Constructor.- Parameters:
notification- The notification.filter- The filter.residencyPolicy- The residency policy, null for the server default.urgency- The urgency, null for the server default.deliveryMode- The delivery mode, null for the server default.authorizationScope- The operator's scope, null for unrestricted.- Throws:
NullPointerException- If the notification or the filter is null.
Method Details
of
Creates a request with server-default policies and an unrestricted operator scope.- Parameters:
notification- The notification.filter- The filter.- Returns:
- The request.
getNotification
Description copied from interface:IPushSendRequestGets the notification to send.- Specified by:
getNotificationin interfaceIPushSendRequest- Returns:
- The notification; never
null.
getFilter
Description copied from interface:IPushSendRequestGets the filter selecting the target subscriptions (the "group").- Specified by:
getFilterin interfaceIPushSendRequest- Returns:
- The filter; never
null.
getResidencyPolicy
Description copied from interface:IPushSendRequestGets the residency policy for this send, ornullto use the server defaultIPushSettings.getDefaultResidencyPolicy().- Specified by:
getResidencyPolicyin interfaceIPushSendRequest- Returns:
- The residency policy, or
nullfor the default.
getUrgency
Description copied from interface:IPushSendRequestGets the delivery urgency for this send, ornullto use the server defaultDeliveryUrgency.NORMAL.- Specified by:
getUrgencyin interfaceIPushSendRequest- Returns:
- The delivery urgency, or
nullfor the default.
getDeliveryMode
Description copied from interface:IPushSendRequestGets the delivery mode for this send, ornullto use the server defaultIPushSettings.getDefaultDeliveryMode().- Specified by:
getDeliveryModein interfaceIPushSendRequest- Returns:
- The delivery mode, or
nullfor the default.
getAuthorizationScope
Description copied from interface:IPushSendRequestGets the region scope the issuing operator is authorized for. The engine rejects any matched subscription whose region falls outside this scope asDeliveryOutcome.UNAUTHORIZED_REGION, at plan-build time, before any dispatch.- Specified by:
getAuthorizationScopein interfaceIPushSendRequest- Returns:
- The operator's authorization scope; never
null.