Serialized Form


Package net.rim.pushsdk.acknowledgement.web

Class net.rim.pushsdk.acknowledgement.web.NotificationServlet extends BasicNotificationServlet implements Serializable

serialVersionUID: -8668643062243533465L

Serialized Fields

papService

PapService papService
The implementation of the PapService interface for processing a result notification when it comes in.


Package net.rim.pushsdk.commons

Class net.rim.pushsdk.commons.LinkedBlockingQueue extends AbstractQueue<E> implements Serializable

serialVersionUID: -6903933977591709194L

Serialization Methods

readObject

private void readObject(ObjectInputStream s)
                 throws IOException,
                        ClassNotFoundException
Reconstitute this queue instance from a stream (that is, deserialize it).

Throws:
IOException
ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream s)
                  throws IOException
Save the state to a stream (that is, serialize it).

Serial Data:
The capacity is emitted (int), followed by all of its elements (each an Object) in the proper order, followed by a null
Throws:
IOException
Serialized Fields

capacity

int capacity
The capacity bound, or Integer.MAX_VALUE if none


count

AtomicInteger count
Current number of elements


takeLock

ReentrantLock takeLock
Lock held by take, poll, etc


notEmpty

Condition notEmpty
Wait queue for waiting takes


putLock

ReentrantLock putLock
Lock held by put, offer, etc


notFull

Condition notFull
Wait queue for waiting puts

Class net.rim.pushsdk.commons.PushSDKException extends Exception implements Serializable

serialVersionUID: 3686394841111497038L

Class net.rim.pushsdk.commons.RollingCalendar extends GregorianCalendar implements Serializable

serialVersionUID: 8635371834016127625L

Serialized Fields

type

int type

Class net.rim.pushsdk.commons.UnauthorizedException extends Exception implements Serializable

serialVersionUID: -1930525216648190208L


Package net.rim.pushsdk.commons.http

Class net.rim.pushsdk.commons.http.HttpResponse extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

statusCode

int statusCode

content

String content

contentType

String contentType

Package net.rim.pushsdk.pap

Class net.rim.pushsdk.pap.FullNotificationQueueException extends Exception implements Serializable

serialVersionUID: -278198414532322563L

Class net.rim.pushsdk.pap.StatusCode extends Object implements Serializable

serialVersionUID: -8057038909210650039L

Serialized Fields

code

String code

description

String description

Package net.rim.pushsdk.pap.unmarshal

Class net.rim.pushsdk.pap.unmarshal.BadMessageException extends Exception implements Serializable

serialVersionUID: -729486620105792236L

Serialized Fields

badMessageResponse

BadMessageResponse badMessageResponse

Package net.rim.pushsdk.pap.web

Class net.rim.pushsdk.pap.web.BasicNotificationServlet extends javax.servlet.http.HttpServlet implements Serializable

serialVersionUID: 1902448163759666899L


Package net.rim.pushsdk.push

Class net.rim.pushsdk.push.PushIdAndApplicationId extends Object implements Serializable

serialVersionUID: 6411259569170124824L

Serialized Fields

pushId

String pushId

applicationId

String applicationId

Class net.rim.pushsdk.push.PushParameters extends Object implements Serializable

serialVersionUID: -6784318369984864009L

Serialized Fields

applicationId

String applicationId

pushId

String pushId

deliverBeforeTimestamp

Date deliverBeforeTimestamp

isApplicationReliable

Boolean isApplicationReliable

addresses

List<E> addresses

content

Content content

Package net.rim.pushsdk.push.request

Class net.rim.pushsdk.push.request.InvalidPushRequestException extends Exception implements Serializable

serialVersionUID: 8735160101552775592L

Class net.rim.pushsdk.push.request.PushRequest extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

String id

pushApplicationId

String pushApplicationId

deliveryMethod

DeliveryMethod deliveryMethod

statusCode

StatusCode statusCode
Deprecated. 

statusDesc

String statusDesc
Deprecated. 

publicStatusCode

StatusCode publicStatusCode

publicStatusDesc

String publicStatusDesc

enterpriseStatusCode

StatusCode enterpriseStatusCode

enterpriseStatusDesc

String enterpriseStatusDesc

expiryDate

Date expiryDate

publicNotifyUrl

String publicNotifyUrl

enterpriseNotifyUrl

String enterpriseNotifyUrl

bearer

String bearer

subscribers

Collection<E> subscribers

addressCount

Integer addressCount

contentSize

Long contentSize

totalContentSize

Long totalContentSize

createdDate

Date createdDate

modifiedDate

Date modifiedDate

Class net.rim.pushsdk.push.request.PushRequestDetail extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

String id

messageState

MessageState messageState

statusCode

StatusCode statusCode

statusDesc

String statusDesc

address

String address

subscriberId

String subscriberId

senderName

String senderName

senderAddress

String senderAddress

subscriberType

SubscriberType subscriberType

createdDate

Date createdDate

completedDate

Date completedDate

modifiedDate

Date modifiedDate

Package net.rim.pushsdk.push.stats

Class net.rim.pushsdk.push.stats.PushStats extends Object implements Serializable

serialVersionUID: -5864355545563417697L

Serialized Fields

pushApplicationId

String pushApplicationId
Id of the push application this push statistic object corresponds to.


runningPushCount

long runningPushCount
Number of pushes since this value was reset. If one push contains N addresses, the runningPushCount will be incremented by N.


runningContentSum

long runningContentSum
Total volume of content pushed since this value was reset. If J bytes of content was sent to N devices, the runningContentSum will be incremented by J * N.


dailyPushCount

long dailyPushCount
Number of pushes during a day. If one push contains N addresses, the dailyPushCount will be incremented by N.


dailyPushCountDate

Date dailyPushCountDate
Date for which the dailyPushCount was calculated.


Package net.rim.pushsdk.pushappmgmt

Class net.rim.pushsdk.pushappmgmt.IncorrectPasswordException extends Exception implements Serializable

serialVersionUID: -7395202633354496618L

Class net.rim.pushsdk.pushappmgmt.IncorrectUsernameException extends Exception implements Serializable

serialVersionUID: -6597800130960777619L

Class net.rim.pushsdk.pushappmgmt.InvalidPushAppException extends Exception implements Serializable

serialVersionUID: 8735160101552775592L

Serialized Fields

invalidPushAppErrorCode

InvalidPushAppErrorCode invalidPushAppErrorCode

Class net.rim.pushsdk.pushappmgmt.PushApplication extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

String id

name

String name

version

String version

username

String username

publicPassword

String publicPassword

enterprisePassword

String enterprisePassword

description

String description

maxDailyQuota

Integer maxDailyQuota

status

PushApplicationStatus status

pushPort

Integer pushPort

publicNotifyUrl

String publicNotifyUrl

enterpriseNotifyUrl

String enterpriseNotifyUrl

storePushRequests

boolean storePushRequests

bypassSubscription

boolean bypassSubscription

consecutiveFailedPushThreshold

Integer consecutiveFailedPushThreshold
Deprecated. 

startDate

Date startDate

expiryDate

Date expiryDate

createdDate

Date createdDate

modifiedDate

Date modifiedDate

modifiedBy

String modifiedBy

defaultPushLiveTime

Integer defaultPushLiveTime

isApplicationReliable

boolean isApplicationReliable

serviceLevel

PushApplicationServiceLevel serviceLevel

lastNotificationEnabled

boolean lastNotificationEnabled

autoDeleteRequests

boolean autoDeleteRequests

type

PushApplicationType type

isDeprecatedConstructorUsed

boolean isDeprecatedConstructorUsed
Deprecated. 

notifyUrl

String notifyUrl
Deprecated. 

password

String password
Deprecated. 

Package net.rim.pushsdk.query.subscription

Class net.rim.pushsdk.query.subscription.SubQueryBadMessage extends Object implements Serializable

serialVersionUID: -8654882329128366206L

Serialized Fields

eventTime

Date eventTime

code

String code

description

String description

Class net.rim.pushsdk.query.subscription.SubQueryFailureException extends Exception implements Serializable

serialVersionUID: -765579433518429968L

Serialized Fields

failureCode

String failureCode

failureDescription

String failureDescription

Class net.rim.pushsdk.query.subscription.SubQueryRequestByAddress extends SubscriptionQueryRequest implements Serializable

serialVersionUID: 7737381390635354642L

Serialized Fields

addresses

Set<E> addresses

Class net.rim.pushsdk.query.subscription.SubQueryRequestByStatus extends SubscriptionQueryRequest implements Serializable

serialVersionUID: -7764525666840381415L

Serialized Fields

status

SubQueryRequestStatus status

Class net.rim.pushsdk.query.subscription.SubscriptionQueryMessage extends Object implements Serializable

serialVersionUID: 8274045083125622528L

Serialized Fields

pushApplicationId

String pushApplicationId
The push application id.

Class net.rim.pushsdk.query.subscription.SubscriptionQueryRequest extends SubscriptionQueryMessage implements Serializable

serialVersionUID: -3207697941211521092L

Class net.rim.pushsdk.query.subscription.SubscriptionQueryResponse extends SubscriptionQueryMessage implements Serializable

serialVersionUID: 3157898415821396271L

Serialized Fields

eventTime

Date eventTime

code

String code

description

String description

results

Set<E> results

Class net.rim.pushsdk.query.subscription.SubscriptionQueryResult extends Object implements Serializable

serialVersionUID: 7992468148511468010L

Serialized Fields

eventTime

Date eventTime

address

String address

status

SubQueryResultStatus status

Package net.rim.pushsdk.subscription

Class net.rim.pushsdk.subscription.InvalidSubStatusException extends Exception implements Serializable

serialVersionUID: -6232739129984082871L

Serialized Fields

currentStatus

SubscriberStatus currentStatus

subscriptionType

SubscriptionType subscriptionType

Class net.rim.pushsdk.subscription.PPGCommunicationFailureException extends Exception implements Serializable

serialVersionUID: 3546622446530221809L

Class net.rim.pushsdk.subscription.SubDoesNotExistException extends Exception implements Serializable

serialVersionUID: 6149588826101047274L

Class net.rim.pushsdk.subscription.SubIllegalArgumentException extends IllegalArgumentException implements Serializable

serialVersionUID: -8342746820562775358L

Serialized Fields

subIllegalArgumentErrorCode

SubIllegalArgumentErrorCode subIllegalArgumentErrorCode

Class net.rim.pushsdk.subscription.Subscriber extends SubscriberPartial implements Serializable

serialVersionUID: 3656247240038553259L

Serialized Fields

osVersion

String osVersion
The OS version of the subscriber's device.


model

String model
The model number of the subscriber's device.


subscribeDate

Date subscribeDate
The date when a device was subscribed to a Push Application. Note: this date might be after the unsubscribeDate, if the device was subscribed, then unsubscribed, and then re-subscribed again.


unsubscribeDate

Date unsubscribeDate
The date when a device was unsubscribed from a Push Application.


suspendDate

Date suspendDate
The date when a device's subscription to a Push Application was suspended.


resumeDate

Date resumeDate
The date when a device's subscription to a Push Application was resumed.


consecutiveFailedPushCount

Integer consecutiveFailedPushCount
A count of the number of consecutive failed pushes to this subscriber. If a success is encountered, this count is reset back to 0.

Class net.rim.pushsdk.subscription.SubscriberPartial extends Object implements Serializable

serialVersionUID: -559374066802392222L

Serialized Fields

subscriberPrimaryKey

SubscriberPrimaryKey subscriberPrimaryKey
The primary key of a subscriber.


address

String address
The address (e.g. PIN or email address) of a subscriber.


status

SubscriberStatus status
The status of a subscriber.


type

SubscriberType type
The type of a subscriber.

Since:
1.1

Class net.rim.pushsdk.subscription.SubscriberPrimaryKey extends Object implements Serializable

serialVersionUID: 5414817353365334700L

Serialized Fields

pushApplicationId

String pushApplicationId

id

String id

Class net.rim.pushsdk.subscription.SubscriptionValidationResult extends Object implements Serializable

serialVersionUID: 7301248553562660479L

Serialized Fields

doNotExistSubscriberIds

Set<E> doNotExistSubscriberIds

inactiveSubscriberIds

Set<E> inactiveSubscriberIds

suspendedSubscriberIds

Set<E> suspendedSubscriberIds

activeAddresses

Set<E> activeAddresses

activeSubscribers

Set<E> activeSubscribers

Package net.rim.pushsdk.subscription.auth

Class net.rim.pushsdk.subscription.auth.AuthenticationFailureException extends Exception implements Serializable

serialVersionUID: -7299350676466491880L

Class net.rim.pushsdk.subscription.auth.AuthenticationRequest extends BaseAuthenticationRequest implements Serializable

serialVersionUID: 2464198125446850411L

Serialized Fields

password

String password
The password that will be used to authenticate a subscriber.


subscriptionType

SubscriptionType subscriptionType
The type of subscription operation being performed.

Class net.rim.pushsdk.subscription.auth.BaseAuthenticationRequest extends Object implements Serializable

serialVersionUID: -8519954984304578325L

Serialized Fields

pushApplicationId

String pushApplicationId
The id of the push application a user is attempting to authenticate for.


username

String username
The username that will be used to authenticate a subscriber.

Class net.rim.pushsdk.subscription.auth.SubscriberPrincipal extends Object implements Serializable

serialVersionUID: -1105272338514038876L

Serialized Fields

name

String name
The unique id of a subscriber returned from authentication (i.e. the subscriber id).


properties

Map<K,V> properties
A set of key-value pairs that relate to the subscriber principal.


Package net.rim.pushsdk.subscription.count

Class net.rim.pushsdk.subscription.count.Count extends Object implements Serializable

serialVersionUID: -3318522031917247135L

Serialized Fields

count

int count
A count to be used for subscription statistics.

Class net.rim.pushsdk.subscription.count.DeviceModelCount extends Count implements Serializable

serialVersionUID: -3202447930565964392L

Serialized Fields

model

String model

Class net.rim.pushsdk.subscription.count.OsVersionCount extends Count implements Serializable

serialVersionUID: 9039479005393025643L

Serialized Fields

osVersion

String osVersion

Package net.rim.pushsdk.subscription.cp

Class net.rim.pushsdk.subscription.cp.CPSubscriptionFailureException extends Exception implements Serializable

serialVersionUID: -3442266146342097792L


Package net.rim.pushsdk.subscription.match

Class net.rim.pushsdk.subscription.match.SubActiveMatchResult extends Object implements Serializable

serialVersionUID: 3843419488165634017L

Serialized Fields

activeAddresses

Set<E> activeAddresses

activeSubscribers

Set<E> activeSubscribers

Package net.rim.pushsdk.subscription.sync

Class net.rim.pushsdk.subscription.sync.PPGSubscriberUpdateFailure extends Object implements Serializable

serialVersionUID: -7316548256783849042L

Serialized Fields

subscriptionType

SubscriptionType subscriptionType

pushApplicationId

String pushApplicationId

pushApplicationPassword

String pushApplicationPassword

address

String address

Class net.rim.pushsdk.subscription.sync.SDKSubscriberUpdateFailure extends Object implements Serializable

serialVersionUID: 4403574333364711144L

Serialized Fields

subscriptionType

SubscriptionType subscriptionType

pushApplicationId

String pushApplicationId

subscriberId

String subscriberId

Class net.rim.pushsdk.subscription.sync.SubscriberSyncResult extends Object implements Serializable

serialVersionUID: -3075557659676483103L

Serialized Fields

ppgSubscriberUpdateFailures

Set<E> ppgSubscriberUpdateFailures

sdkSubscriberUpdateFailures

Set<E> sdkSubscriberUpdateFailures

Package net.rim.pushsdk.subscription.web

Class net.rim.pushsdk.subscription.web.BaseRequest extends Object implements Serializable

serialVersionUID: -151998082044488037L

Serialized Fields

pushApplicationId

String pushApplicationId
The id of the push application associated with the request.


subscriberId

String subscriberId
The id of the subscriber associated with the request.

Class net.rim.pushsdk.subscription.web.ResumeRequest extends BaseRequest implements Serializable

serialVersionUID: 39304618540385987L

Class net.rim.pushsdk.subscription.web.ResumeServlet extends SubscriptionServlet implements Serializable

serialVersionUID: 343471406856360114L

Class net.rim.pushsdk.subscription.web.SubscribeRequest extends BaseRequest implements Serializable

serialVersionUID: -1272428042330947360L

Serialized Fields

address

String address

osVersion

String osVersion

model

String model

type

SubscriberType type

Class net.rim.pushsdk.subscription.web.SubscribeServlet extends SubscriptionServlet implements Serializable

serialVersionUID: 3334393172504266123L

Serialized Fields

pushApplicationService

PushApplicationService pushApplicationService

Class net.rim.pushsdk.subscription.web.SubscriptionRequestParser extends Object implements Serializable

serialVersionUID: -1062314892835735891L

Class net.rim.pushsdk.subscription.web.SubscriptionServlet extends javax.servlet.http.HttpServlet implements Serializable

serialVersionUID: 7671302746873037935L

Serialized Fields

subscriptionRequestParser

SubscriptionRequestParser subscriptionRequestParser
An instance of a SubscriptionRequestParser implementation.


contentProviderAuthenticationService

ContentProviderAuthenticationService contentProviderAuthenticationService
An instance of a ContentProviderAuthenticationService implementation.


subscriptionService

SubscriptionService subscriptionService
An instance of a SubscriptionService implementation.

Class net.rim.pushsdk.subscription.web.SuspendRequest extends BaseRequest implements Serializable

serialVersionUID: 8157167261655068677L

Class net.rim.pushsdk.subscription.web.SuspendServlet extends SubscriptionServlet implements Serializable

serialVersionUID: 5014737661347094476L

Class net.rim.pushsdk.subscription.web.UnsubscribeRequest extends BaseRequest implements Serializable

serialVersionUID: -7452020518354382194L

Serialized Fields

isAutomaticUnsubscribe

boolean isAutomaticUnsubscribe
This boolean is used to indicate that the unsubscribe request comes automatically from the system and not from a user. For example, this may be after an acknowledgement indicates that there was an address error for the user or the port was closed on the user's device. If the PPG must be notified of this unsubscribe request you must call the setNotifyPPG() flag to true


isNotifyPPG

boolean isNotifyPPG
This boolean is used to indicate that the SDK needs to notify (a.k.a. send an unsubscribe) the PPG of this unsubscribe request. For example, this may be after an application is deleted from the SDK and the user is requesting subscriber's be unsubscribed first. Set this to true and the PPG *will* be notified of the unsubscribe so it can unsubscribe the user as well. Or set this to false (the default value) to not notify the PPG of the unsubscribe for example if the PPG has sent an acknowledgement that indicates that there was an address error for the user or the port was closed on the user's device, it would be redundant to tell the PPG to unsubscribe the user again.

Since:
1.1

Class net.rim.pushsdk.subscription.web.UnsubscribeServlet extends SubscriptionServlet implements Serializable

serialVersionUID: -2804197634644181661L



Copyright © 2011 Research In Motion. All Rights Reserved.