NN_PersistenceRAInterface.java

/*
 * TeleStax, Open Source Cloud Communications  Copyright 2012. 
 * and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.mobicents.smsc.tools.stresstool;

import java.util.ArrayList;
import java.util.Date;
import org.mobicents.smsc.cassandra.PersistenceException;
import org.mobicents.smsc.cassandra.PreparedStatementCollection;
import org.mobicents.smsc.library.Sms;
import org.mobicents.smsc.library.SmsSet;
import org.mobicents.smsc.library.TargetAddress;

/**
*
* @author sergey vetyutnev
*
*/
public interface NN_PersistenceRAInterface {

    /**
     * Return due_slot for the given time
     */
    long c2_getDueSlotForTime(Date time);

    /**
     * Return time for the given due_slot
     */
    Date c2_getTimeForDueSlot(long dueSlot);

    /**
     * Return due_slop that SMSC is processing now
     */
    long c2_getProcessingDueSlot();

    /**
     * Set a new due_slop that SMSC is processing now and store it to the database
     */
    void c2_setProcessingDueSlot(long newDueSlot) throws PersistenceException;

    /**
     * Return due_slop for current time
     */
    long c2_getIntimeDueSlot();

    /**
     * Return due_slop for storing next incoming to SMSC message
     */
    long c2_getStoringDueSlot();

    /**
     * Registering that thread starts writing to this due_slot
     */
    void c2_registerDueSlotWriting(long dueSlot);

    /**
     * Registering that thread finishes writing to this due_slot
     */
    void c2_unregisterDueSlotWriting(long dueSlot);

    /**
     * Checking if due_slot is not in writing state now
     * Returns true if due_slot is not in writing now
     */
    boolean c2_checkDueSlotNotWriting(long dueSlot);

    /**
     * Obtaining synchronizing object for a TargetAddress
     */
    TargetAddress obtainSynchroObject(TargetAddress ta);

    /**
     * Releasing synchronizing object for a TargetAddress
     */
    void releaseSynchroObject(TargetAddress ta);


    long c2_getDueSlotForTargetId(PreparedStatementCollection psc, String targetId) throws PersistenceException;

    void c2_updateDueSlotForTargetId(String targetId, long newDueSlot) throws PersistenceException;

    void c2_createRecordCurrent(Sms sms) throws PersistenceException;

    void c2_createRecordArchive(Sms sms) throws PersistenceException;

    ArrayList<SmsSet> c2_getRecordList(long dueSlot) throws PersistenceException;

    SmsSet c2_getRecordListForTargeId(long dueSlot, String targetId) throws PersistenceException;

    ArrayList<SmsSet> c2_sortRecordList(ArrayList<SmsSet> sourceLst);

    void c2_updateInSystem(Sms sms, int isSystemStatus) throws PersistenceException;

}