org.mobicents.smsc.slee.services.deliverysbb

Class DeliveryCommonSbb

java.lang.Object

org.mobicents.smsc.slee.services.deliverysbb.DeliveryCommonSbb

All Implemented Interfaces:

javax.slee.Sbb

Direct Known Subclasses:

MtCommonSbb, RxSipServerSbb, RxSmppServerSbb

public abstract class DeliveryCommonSbb
extends Object
implements javax.slee.Sbb

Author:

sergey vetyutnev

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	dlvIsInited
protected javax.slee.facilities.Tracer	logger
static javax.slee.resource.ResourceAdaptorTypeID	MPROC_RATYPE_ID
protected PersistenceRAInterface	persistence
protected org.mobicents.slee.SbbContextExt	sbbContext
protected SchedulerRaSbbInterface	scheduler
static SmscPropertiesManagement	smscPropertiesManagement
protected javax.slee.facilities.TimerFacility	timerFacility

Constructor Summary

Constructors

Constructor and Description
DeliveryCommonSbb(String className)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addInitialMessageSet(SmsSet smsSet) This method is used for adding of a initial set of messages for delivering when delivering has not started This method must be invoked firstly before all other methods
protected void	addInitialMessageSet(SmsSet smsSet, long currentMsgNum) This method is used for adding of a initial set of messages for delivering when delivering has started and we need to provide current delivering state.
protected void	applyMprocRulesOnFailure(ArrayList<Sms> lstPermFailured, ArrayList<Sms> lstTempFailured, ArrayList<Sms> lstPermFailuredNew, ArrayList<Sms> lstTempFailuredNew, ArrayList<Sms> lstRerouted, ArrayList<Integer> lstNewNetworkId, ProcessingType processingType) mproc rules applying for delivery phase for failure case
protected void	applyMprocRulesOnImsiResponse(SmsSet smsSet, ArrayList<Sms> lstPermFailured, ArrayList<Sms> lstRerouted, ArrayList<Integer> lstNewNetworkId, org.mobicents.protocols.ss7.map.api.primitives.ISDNAddressString networkNode, String imsiData) mproc rules applying for delivery phase after SRI successful response
protected void	applyMprocRulesOnSuccess(Sms sms, ProcessingType processingType) mproc rules applying for delivery phase for success case
protected int	calculateNewDueDelay(SmsSet smsSet, boolean busySubscriber) Calculating of new due delay for SmsSet
protected Date	calculateNewDueTime(SmsSet smsSet, int newDueDelay) Calculating of new due time for SmsSet
protected void	cancelDeliveryTimer()
protected void	commitSendingPoolMsgCount() Marking a previously arranged message sending pool as delivered with resource releasing
protected ConfirmMessageInSendingPool	confirmMessageInSendingPool(int sequenceNumber) Make a confirmation of sending of a message
protected void	createFailureLists(ArrayList<Sms> lstPermFailured, ArrayList<Sms> lstTempFailured, ErrorAction errorAction, Date newDueTime) Put of unsent messages into a permanent failure list (no more delivery attempts) or a temporary failure list (more delivery attempts are possible).
protected void	endDeliveryAfterValidityPeriod(Sms sms, ProcessingType processingType, String dlvMessageId, String dlvDestId) Finishing delivering of a message which validity period is over at the start of delivery time.
protected void	endRegisterMessageInSendingPool() Ending of registering of messages in a message sending pool for further confirming of a message receiving This method must be invoked after a first message has been registered by registerMessageInSendingPool().
protected void	generateCDR(Sms sms, String status, String reason, boolean messageIsSplitted, boolean lastSegment) Generating CDRs for a message
protected void	generateCDRs(ArrayList<Sms> lstPermFailured, String status, String reason) Generating CDRs for a message list
protected void	generateFailureReceipts(SmsSet smsSet, ArrayList<Sms> lstPermFailured, String extraString) Generating of failure receipts for permanent failed messages
protected void	generateIntermediateReceipts(SmsSet smsSet, ArrayList<Sms> lstTempFailured) Generating of intermediate receipts for temporary failed messages
protected void	generateSuccessReceipt(SmsSet smsSet, Sms sms) Generating of a success receipt for a delivered message
protected void	generateTemporaryFailureCDR(String status, String reason) Generating of a temporary failure CDR (one record for all unsent messages).
abstract long	getCurrentMsgNum()
protected long	getCurrentMsgNumValue()
abstract javax.slee.facilities.TimerID	getDeliveryTimerID()
abstract boolean	getDlvIsEnded()
abstract boolean	getDlvIsInited()
protected Sms	getMessageInSendingPool(int numInSendingPool) Returns a message number numInSendingPool in a message sending pool
protected static int	getNextMessageReferenceNumber()
abstract PendingRequestsList	getPendingRequestsList()
protected javax.slee.ActivityContextInterface	getSchedulerActivityContextInterface()
protected int	getSendingPoolMessageCount()
protected SmsSet	getSmsSet()
abstract String	getTargetId()
protected int	getTotalUnsentMessageCount()
protected int	getUnconfirmedMessageCountInSendingPool()
protected Sms	getUnsentMessage(int numUnsent) Returns a message number numUnsent (that is neither sent nor in a message sending pool)
protected boolean	isDeliveringEnded()
protected boolean	isMessageConfirmedInSendingPool(int numInSendingPool)
protected void	markDeliveringIsEnded(boolean removeSmsSet) Marking that a delivering process is ended in SBB and next coming messages for delivering must be rescheduled to another delivering SBB
protected Sms	obtainNextMessage(ProcessingType processingType) Arrange a new message sending pool with only one message in it.
protected int	obtainNextMessagesSendingPool(int poolMessageCount, ProcessingType processingType) Arrange a new message sending pool with the poolMessageCount message count in it.
protected abstract void	onDeliveryTimeout(SmsSet smsSet, String reason)
void	onTimerEvent(javax.slee.facilities.TimerEvent event, javax.slee.ActivityContextInterface aci, javax.slee.EventContext eventContext)
protected void	postProcessPermFailures(ArrayList<Sms> lstPermFailured, String dlvMessageId, String dlvDestId) Processing messages that were failed permanently (sms.inSystem=sent in live database, adding of archive record).
protected void	postProcessRerouted(ArrayList<Sms> lstRerouted, ArrayList<Integer> lstNewNetworkId) Processing messages that were rescheduled (sms.inSystem=sent in live database).
protected void	postProcessSucceeded(Sms sms, String dlvMessageId, String dlvDestId) Processing messages that were succeeded (sms.inSystem=sent in live database, adding of archive record).
protected void	postProcessTempFailures(SmsSet smsSet, ArrayList<Sms> lstTempFailured, int newDueDelay, Date newDueDate, boolean isCheckScheduleDeliveryTimeNeeded) Processing messages that were failed temporary and will be rescheduled (sms.inSystem=sent in live database, message rescheduling).
protected void	registerMessageInSendingPool(int numInSendingPool, int sequenceNumber, int[] sequenceNumberExtra) Register a sequenceNumber for a message in a message sending pool for further confirming of a message receiving
protected void	rescheduleDeliveryTimer()
void	sbbActivate()
void	sbbCreate()
void	sbbExceptionThrown(Exception arg0, Object arg1, javax.slee.ActivityContextInterface arg2)
void	sbbLoad()
void	sbbPassivate()
void	sbbPostCreate()
void	sbbRemove()
void	sbbRolledBack(javax.slee.RolledBackContext arg0)
void	sbbStore()
protected void	sendTransactionalResponseFailure(ArrayList<Sms> lstPermFailured, ArrayList<Sms> lstTempFailured, ErrorAction errorAction, org.mobicents.protocols.ss7.map.api.errors.MAPErrorMessage errMessage) Sending of responses to message senders for a transactional messaging mode for failure case
protected void	sendTransactionalResponseSuccess(Sms sms) Sending of responses to message senders for a transactional messaging mode for success case
abstract void	setCurrentMsgNum(long currentMsgNum)
abstract void	setDeliveryTimerID(javax.slee.facilities.TimerID val)
abstract void	setDlvIsEnded(boolean deliveringIsEnded)
abstract void	setDlvIsInited(boolean deliveringIsInited)
abstract void	setPendingRequestsList(PendingRequestsList pendingRequestsList)
void	setSbbContext(javax.slee.SbbContext sbbContext)
abstract void	setTargetId(String targetId) CMPs
void	unsetSbbContext()

Methods inherited from class java.lang.Object

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

Field Detail

smscPropertiesManagement

public static SmscPropertiesManagement smscPropertiesManagement

MPROC_RATYPE_ID

public static final javax.slee.resource.ResourceAdaptorTypeID MPROC_RATYPE_ID

logger

protected javax.slee.facilities.Tracer logger

sbbContext

protected org.mobicents.slee.SbbContextExt sbbContext

persistence

protected PersistenceRAInterface persistence

scheduler

protected SchedulerRaSbbInterface scheduler

timerFacility

protected javax.slee.facilities.TimerFacility timerFacility

dlvIsInited

protected boolean dlvIsInited

Constructor Detail

DeliveryCommonSbb

public DeliveryCommonSbb(String className)

Method Detail

setSbbContext

public void setSbbContext(javax.slee.SbbContext sbbContext)

Specified by:

setSbbContext in interface javax.slee.Sbb

sbbLoad

public void sbbLoad()

Specified by:

sbbLoad in interface javax.slee.Sbb

sbbStore

public void sbbStore()

Specified by:

sbbStore in interface javax.slee.Sbb

sbbActivate

public void sbbActivate()

Specified by:

sbbActivate in interface javax.slee.Sbb

sbbCreate

public void sbbCreate()
               throws javax.slee.CreateException

Specified by:

sbbCreate in interface javax.slee.Sbb

Throws:

javax.slee.CreateException

sbbExceptionThrown

public void sbbExceptionThrown(Exception arg0,
                      Object arg1,
                      javax.slee.ActivityContextInterface arg2)

Specified by:

sbbExceptionThrown in interface javax.slee.Sbb

sbbPassivate

public void sbbPassivate()

Specified by:

sbbPassivate in interface javax.slee.Sbb

sbbPostCreate

public void sbbPostCreate()
                   throws javax.slee.CreateException

Specified by:

sbbPostCreate in interface javax.slee.Sbb

Throws:

javax.slee.CreateException

sbbRemove

public void sbbRemove()

Specified by:

sbbRemove in interface javax.slee.Sbb

sbbRolledBack

public void sbbRolledBack(javax.slee.RolledBackContext arg0)

Specified by:

sbbRolledBack in interface javax.slee.Sbb

unsetSbbContext

public void unsetSbbContext()

Specified by:

unsetSbbContext in interface javax.slee.Sbb

addInitialMessageSet

protected void addInitialMessageSet(SmsSet smsSet)

This method is used for adding of a initial set of messages for delivering when delivering has not started This method must be invoked firstly before all other methods

Parameters:

smsSet - An initial set of messages that is added provided to SBB for delivering

addInitialMessageSet

protected void addInitialMessageSet(SmsSet smsSet,
                        long currentMsgNum)

This method is used for adding of a initial set of messages for delivering when delivering has started and we need to provide current delivering state. This method must be invoked firstly before all other methods

Parameters:

smsSet - An initial set of messages that is added provided to SBB for delivering

currentMsgNum -

markDeliveringIsEnded

protected void markDeliveringIsEnded(boolean removeSmsSet)

Marking that a delivering process is ended in SBB and next coming messages for delivering must be rescheduled to another delivering SBB

isDeliveringEnded

protected boolean isDeliveringEnded()

Returns:

true if delivering of message in this SBB is already ended (and new incoming messages must be rescheduled to another delivering SBB)

getSchedulerActivityContextInterface

protected javax.slee.ActivityContextInterface getSchedulerActivityContextInterface()

getCurrentMsgNumValue

protected long getCurrentMsgNumValue()

Returns:

returns currentMsgNum for smsSet in processing

getTotalUnsentMessageCount

protected int getTotalUnsentMessageCount()

Returns:

Total messages that are not yet delivered in SmsSet (including messages in a message sending pool and not yet added to a message sending pool)

getSendingPoolMessageCount

protected int getSendingPoolMessageCount()

Returns:

Total message count in a message sending pool

getSmsSet

protected SmsSet getSmsSet()

Returns:

Processing SmsSet

getUnsentMessage

protected Sms getUnsentMessage(int numUnsent)

Returns a message number numUnsent (that is neither sent nor in a message sending pool)

Parameters:

numUnsent - Number of an unsent message

Returns:

A message or null if no unsent messages or numUnsent is out of range

getMessageInSendingPool

protected Sms getMessageInSendingPool(int numInSendingPool)

Returns a message number numInSendingPool in a message sending pool

Parameters:

numInSendingPool - Number of message in a message sending pool

Returns:

A message or null if a sending pool is empty or numInSendingPool is out of a message sending pool range

commitSendingPoolMsgCount

protected void commitSendingPoolMsgCount()

Marking a previously arranged message sending pool as delivered with resource releasing

obtainNextMessagesSendingPool

protected int obtainNextMessagesSendingPool(int poolMessageCount,
                                ProcessingType processingType)

Arrange a new message sending pool with the poolMessageCount message count in it. If pending message count is less then poolMessageCount then all pending message will be arranged to a message sending pool. Previous arranging pool will be removed by this operation and pending messages in it will be marked as already processed. If you need to arrange only one message in message sending pool you can use obtainNextMessage() method. Messages wit expired ValidityPeriod are not added to a sendingPoolMsg but are processed as perm failed.

Parameters:

poolMessageCount - Max message count that must be included into a a new message sending pool

processingType -

Returns:

a count of messages in a new message pool

obtainNextMessage

protected Sms obtainNextMessage(ProcessingType processingType)

Arrange a new message sending pool with only one message in it. If no pending message then no message will be arranged to a message sending pool. Previous arranging pool will be removed by this operation and pending messages in it will be marked as already processed. If you need to arrange more then one message in message sending pool you can use obtainNextMessagesSendingPool() method. Messages wit expired ValidityPeriod are not added to a sendingPoolMsg but are processed as perm failed.

Parameters:

processingType -

Returns:

a message for sending or null if no more message to send

getNextMessageReferenceNumber

protected static int getNextMessageReferenceNumber()

Returns:

return next MessageReferenceNumber for this delivery sequence

registerMessageInSendingPool

protected void registerMessageInSendingPool(int numInSendingPool,
                                int sequenceNumber,
                                int[] sequenceNumberExtra)

Register a sequenceNumber for a message in a message sending pool for further confirming of a message receiving

Parameters:

numInSendingPool - A message number in a message sending pool

sequenceNumber - A sequence number of a message for which we will be able of confirming

sequenceNumberExtra - Extra sequence numbers of a message (2, 3, ... message parts) for which we will be able of confirming

endRegisterMessageInSendingPool

protected void endRegisterMessageInSendingPool()

Ending of registering of messages in a message sending pool for further confirming of a message receiving This method must be invoked after a first message has been registered by registerMessageInSendingPool().

confirmMessageInSendingPool

protected ConfirmMessageInSendingPool confirmMessageInSendingPool(int sequenceNumber)

Make a confirmation of sending of a message

Parameters:

sequenceNumber -

Returns:

Sms message that is in the pendingRequestsList list with sequenceNumber or null if no such message in pendingRequestsList, it will return null

getUnconfirmedMessageCountInSendingPool

protected int getUnconfirmedMessageCountInSendingPool()

Returns:

A count of unconfirmed messages in a message sending pool

isMessageConfirmedInSendingPool

protected boolean isMessageConfirmedInSendingPool(int numInSendingPool)

Parameters:

numInSendingPool - A message number in a message sending pool

Returns:

true: if a message is confirmed or not inside a message sending pool, false: if a message is not confirmed

rescheduleDeliveryTimer

protected void rescheduleDeliveryTimer()

cancelDeliveryTimer

protected void cancelDeliveryTimer()

onTimerEvent

public void onTimerEvent(javax.slee.facilities.TimerEvent event,
                javax.slee.ActivityContextInterface aci,
                javax.slee.EventContext eventContext)

onDeliveryTimeout

protected abstract void onDeliveryTimeout(SmsSet smsSet,
                     String reason)

sendTransactionalResponseSuccess

protected void sendTransactionalResponseSuccess(Sms sms)

Sending of responses to message senders for a transactional messaging mode for success case

Parameters:

sms -

sendTransactionalResponseFailure

protected void sendTransactionalResponseFailure(ArrayList<Sms> lstPermFailured,
                                    ArrayList<Sms> lstTempFailured,
                                    ErrorAction errorAction,
                                    org.mobicents.protocols.ss7.map.api.errors.MAPErrorMessage errMessage)

Sending of responses to message senders for a transactional messaging mode for failure case

Parameters:

lstPermFailured -

lstTempFailured -

errorAction -

createFailureLists

protected void createFailureLists(ArrayList<Sms> lstPermFailured,
                      ArrayList<Sms> lstTempFailured,
                      ErrorAction errorAction,
                      Date newDueTime)

Put of unsent messages into a permanent failure list (no more delivery attempts) or a temporary failure list (more delivery attempts are possible).

Parameters:

lstPermFailured -

lstTempFailured -

newDueTime -

endDeliveryAfterValidityPeriod

protected void endDeliveryAfterValidityPeriod(Sms sms,
                                  ProcessingType processingType,
                                  String dlvMessageId,
                                  String dlvDestId)

Finishing delivering of a message which validity period is over at the start of delivery time.

Parameters:

sms -

processingType -

dlvMessageId -

dlvDestId -

postProcessSucceeded

protected void postProcessSucceeded(Sms sms,
                        String dlvMessageId,
                        String dlvDestId)

Processing messages that were succeeded (sms.inSystem=sent in live database, adding of archive record).

Parameters:

sms -

dlvMessageId -

dlvDestId -

postProcessPermFailures

protected void postProcessPermFailures(ArrayList<Sms> lstPermFailured,
                           String dlvMessageId,
                           String dlvDestId)

Processing messages that were failed permanently (sms.inSystem=sent in live database, adding of archive record).

Parameters:

lstPermFailured -

dlvMessageId -

dlvDestId -

calculateNewDueDelay

protected int calculateNewDueDelay(SmsSet smsSet,
                       boolean busySubscriber)

Calculating of new due delay for SmsSet

Parameters:

smsSet -

busySubscriber - true if a network reported of "busySubscriber" state that means that we need to reschedule of delivering in a very short time

Returns:

calculateNewDueTime

protected Date calculateNewDueTime(SmsSet smsSet,
                       int newDueDelay)

Calculating of new due time for SmsSet

Parameters:

smsSet -

newDueDelay -

Returns:

postProcessTempFailures

protected void postProcessTempFailures(SmsSet smsSet,
                           ArrayList<Sms> lstTempFailured,
                           int newDueDelay,
                           Date newDueDate,
                           boolean isCheckScheduleDeliveryTimeNeeded)

Processing messages that were failed temporary and will be rescheduled (sms.inSystem=sent in live database, message rescheduling).

Parameters:

smsSet -

lstTempFailured -

int - newDueDelay

newDueDate -

isCheckScheduleDeliveryTimeNeeded - true if we need to schedule messages for time to the nearest ScheduleDeliveryTime (for SS7 network case)

postProcessRerouted

protected void postProcessRerouted(ArrayList<Sms> lstRerouted,
                       ArrayList<Integer> lstNewNetworkId)

Processing messages that were rescheduled (sms.inSystem=sent in live database).

Parameters:

lstRerouted -

lstNewNetworkId -

applyMprocRulesOnSuccess

protected void applyMprocRulesOnSuccess(Sms sms,
                            ProcessingType processingType)

mproc rules applying for delivery phase for success case

Parameters:

sms -

processingType -

applyMprocRulesOnFailure

protected void applyMprocRulesOnFailure(ArrayList<Sms> lstPermFailured,
                            ArrayList<Sms> lstTempFailured,
                            ArrayList<Sms> lstPermFailuredNew,
                            ArrayList<Sms> lstTempFailuredNew,
                            ArrayList<Sms> lstRerouted,
                            ArrayList<Integer> lstNewNetworkId,
                            ProcessingType processingType)

mproc rules applying for delivery phase for failure case

Parameters:

lstPermFailured -

lstTempFailured -

lstPermFailuredNew -

lstTempFailuredNew -

lstRerouted -

lstNewNetworkId -

processingType -

applyMprocRulesOnImsiResponse

protected void applyMprocRulesOnImsiResponse(SmsSet smsSet,
                                 ArrayList<Sms> lstPermFailured,
                                 ArrayList<Sms> lstRerouted,
                                 ArrayList<Integer> lstNewNetworkId,
                                 org.mobicents.protocols.ss7.map.api.primitives.ISDNAddressString networkNode,
                                 String imsiData)

mproc rules applying for delivery phase after SRI successful response

Parameters:

smsSet -

lstPermFailured -

processingType -

generateTemporaryFailureCDR

protected void generateTemporaryFailureCDR(String status,
                               String reason)

Generating of a temporary failure CDR (one record for all unsent messages).

Parameters:

status - CDR status (CdrGenerator.CDR_TEMP_FAILED, CDR_TEMP_FAILED_ESME or CDR_TEMP_FAILED_SIP)

reason - verbal failure reason for logging

generateCDR

protected void generateCDR(Sms sms,
               String status,
               String reason,
               boolean messageIsSplitted,
               boolean lastSegment)

Generating CDRs for a message

Parameters:

sms -

status -

reason -

messageIsSplitted -

lastSegment -

generateCDRs

protected void generateCDRs(ArrayList<Sms> lstPermFailured,
                String status,
                String reason)

Generating CDRs for a message list

Parameters:

lstPermFailured -

status -

reason -

generateSuccessReceipt

protected void generateSuccessReceipt(SmsSet smsSet,
                          Sms sms)

Generating of a success receipt for a delivered message

Parameters:

smsSet -

sms -

generateIntermediateReceipts

protected void generateIntermediateReceipts(SmsSet smsSet,
                                ArrayList<Sms> lstTempFailured)

Generating of intermediate receipts for temporary failed messages

Parameters:

smsSet -

lstTempFailured -

generateFailureReceipts

protected void generateFailureReceipts(SmsSet smsSet,
                           ArrayList<Sms> lstPermFailured,
                           String extraString)

Generating of failure receipts for permanent failed messages

Parameters:

smsSet -

lstPermFailured -

setTargetId

public abstract void setTargetId(String targetId)

CMPs

getTargetId

public abstract String getTargetId()

setCurrentMsgNum

public abstract void setCurrentMsgNum(long currentMsgNum)

getCurrentMsgNum

public abstract long getCurrentMsgNum()

setDlvIsInited

public abstract void setDlvIsInited(boolean deliveringIsInited)

getDlvIsInited

public abstract boolean getDlvIsInited()

setDlvIsEnded

public abstract void setDlvIsEnded(boolean deliveringIsEnded)

getDlvIsEnded

public abstract boolean getDlvIsEnded()

setPendingRequestsList

public abstract void setPendingRequestsList(PendingRequestsList pendingRequestsList)

getPendingRequestsList

public abstract PendingRequestsList getPendingRequestsList()

getDeliveryTimerID

public abstract javax.slee.facilities.TimerID getDeliveryTimerID()

setDeliveryTimerID

public abstract void setDeliveryTimerID(javax.slee.facilities.TimerID val)