/*
* Copyright 2010-2011 Ning, Inc.
*
* Ning licenses this file to you under the Apache License, version 2.0
* (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package com.ning.billing.entitlement.engine.dao;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Timestamp;
import java.util.Date;
import java.util.List;
import java.util.UUID;
import org.joda.time.DateTime;
import org.joda.time.DateTimeZone;
import org.skife.jdbi.v2.SQLStatement;
import org.skife.jdbi.v2.StatementContext;
import org.skife.jdbi.v2.sqlobject.Bind;
import org.skife.jdbi.v2.sqlobject.Binder;
import org.skife.jdbi.v2.sqlobject.SqlQuery;
import org.skife.jdbi.v2.sqlobject.SqlUpdate;
import org.skife.jdbi.v2.sqlobject.customizers.Mapper;
import org.skife.jdbi.v2.sqlobject.mixins.CloseMe;
import org.skife.jdbi.v2.sqlobject.mixins.Transactional;
import org.skife.jdbi.v2.sqlobject.mixins.Transmogrifier;
import org.skife.jdbi.v2.tweak.ResultSetMapper;
import com.ning.billing.entitlement.events.IEvent;
import com.ning.billing.entitlement.events.IEvent.EventType;
import com.ning.billing.entitlement.events.IEventLyfecycle.IEventLyfecycleState;
import com.ning.billing.entitlement.events.phase.IPhaseEvent;
import com.ning.billing.entitlement.events.phase.PhaseEvent;
import com.ning.billing.entitlement.events.user.ApiEventCancel;
import com.ning.billing.entitlement.events.user.ApiEventChange;
import com.ning.billing.entitlement.events.user.ApiEventCreate;
import com.ning.billing.entitlement.events.user.ApiEventPause;
import com.ning.billing.entitlement.events.user.ApiEventResume;
import com.ning.billing.entitlement.events.user.ApiEventType;
import com.ning.billing.entitlement.events.user.ApiEventUncancel;
import com.ning.billing.entitlement.events.user.IUserEvent;
import com.ning.billing.entitlement.exceptions.EntitlementError;
public interface IEventSqlDao extends Transactional<IEventSqlDao>, CloseMe, Transmogrifier {
static final String EVENT_FIELDS = "event_id, event_type, user_type, created_dt, updated_dt, requested_dt, effective_dt, subscription_id, plan_name, phase_name, plist_name, current_version, is_active, processing_owner, processing_available_dt, processing_state";
static final String EVENT_VALUES = ":event_id, :event_type, :user_type, :created_dt, :updated_dt, :requested_dt, :effective_dt, :subscription_id, :plan_name, :phase_name, :plist_name, :current_version, :is_active, :processing_owner, :processing_available_dt, :processing_state";
static final String GET_READY_WHERE = "effective_dt <= :now and is_active = 1 and processing_state != 'PROCESSED' and (processing_owner IS NULL OR processing_available_dt <= :now)";
static final String CLAIM_WHERE = "event_id = :event_id and is_active = 1 and processing_state != 'PROCESSED' and (processing_owner IS NULL OR processing_available_dt <= :now)";
static final String EVENT_ORDER = " order by effective_dt asc, created_dt asc, requested_dt asc, id asc";
//
// APIs for event notifications
//
@SqlQuery("select " + EVENT_FIELDS + " from events where " + GET_READY_WHERE + EVENT_ORDER + " limit :max")
@Mapper(IEventSqlMapper.class)
public List<IEvent> getReadyEvents(@Bind("now") Date now, @Bind("max") int max);
@SqlUpdate("update events set processing_owner = :owner, processing_available_dt = :next_available, processing_state = 'IN_PROCESSING' where " + CLAIM_WHERE)
public int claimEvent(@Bind("owner") String owner, @Bind("next_available") Date nextAvailable, @Bind("event_id") String eventId, @Bind("now") Date now);
@SqlUpdate("update events set processing_owner = NULL, processing_state = 'PROCESSED' where event_id = :event_id and processing_owner = :owner")
public void clearEvent(@Bind("event_id") String eventId, @Bind("owner") String owner);
@SqlUpdate("insert into events (" + EVENT_FIELDS + ") values (" + EVENT_VALUES + ")")
public void insertEvent(@Bind(binder = IEventSqlDaoBinder.class) IEvent evt);
@SqlUpdate("insert into claimed_events (sequence_id, owner_id, hostname, claimed_dt, event_id) values (:sequence_id, :owner_id, :hostname, :claimed_dt, :event_id)")
public void insertClaimedHistory(@Bind("sequence_id") int sequenceId, @Bind("owner_id") String ownerId, @Bind("hostname") String hostname, @Bind("claimed_dt") Date clainedDate, @Bind("event_id") String eventId);
@SqlUpdate("update events set is_active = 0, updated_dt = :now where event_id = :event_id")
public void unactiveEvent(@Bind("event_id")String eventId, @Bind("now") Date now);
@SqlUpdate("update events set is_active = 1, updated_dt = :now where event_id = :event_id")
public void reactiveEvent(@Bind("event_id")String eventId, @Bind("now") Date now);
@SqlQuery("select " + EVENT_FIELDS + " from events where subscription_id = :subscription_id and is_active = 1 and effective_dt > :now" + EVENT_ORDER)
@Mapper(IEventSqlMapper.class)
public List<IEvent> getFutureActiveEventForSubscription(@Bind("subscription_id") String subscriptionId, @Bind("now") Date now);
@SqlQuery("select " + EVENT_FIELDS + " from events where subscription_id = :subscription_id" + EVENT_ORDER)
@Mapper(IEventSqlMapper.class)
public List<IEvent> getEventsForSubscription(@Bind("subscription_id") String subscriptionId);
public static class IEventSqlDaoBinder implements Binder<Bind, IEvent> {
private Date getDate(DateTime dateTime) {
return dateTime == null ? null : dateTime.toDate();
}
@Override
public void bind(@SuppressWarnings("rawtypes") SQLStatement stmt, Bind bind, IEvent evt) {
stmt.bind("event_id", evt.getId().toString());
stmt.bind("event_type", evt.getType().toString());
stmt.bind("user_type", (evt.getType() == EventType.API_USER) ? ((IUserEvent) evt).getEventType().toString() : null);
stmt.bind("created_dt", getDate(evt.getProcessedDate()));
stmt.bind("updated_dt", getDate(evt.getProcessedDate()));
stmt.bind("requested_dt", getDate(evt.getRequestedDate()));
stmt.bind("effective_dt", getDate(evt.getEffectiveDate()));
stmt.bind("subscription_id", evt.getSubscriptionId().toString());
stmt.bind("plan_name", (evt.getType() == EventType.API_USER) ? ((IUserEvent) evt).getEventPlan() : null);
stmt.bind("phase_name", (evt.getType() == EventType.API_USER) ? ((IUserEvent) evt).getEventPlanPhase() : ((IPhaseEvent) evt).getPhase());
stmt.bind("plist_name", (evt.getType() == EventType.API_USER) ? ((IUserEvent) evt).getPriceList() : null);
stmt.bind("current_version", evt.getActiveVersion());
stmt.bind("is_active", evt.isActive());
stmt.bind("processing_available_dt", getDate(evt.getNextAvailableDate()));
stmt.bind("processing_owner", (String) null);
stmt.bind("processing_state", IEventLyfecycleState.AVAILABLE.toString());
}
}
public static class IEventSqlMapper implements ResultSetMapper<IEvent> {
private DateTime getDate(ResultSet r, String fieldName) throws SQLException {
final Timestamp resultStamp = r.getTimestamp(fieldName);
return r.wasNull() ? null : new DateTime(resultStamp).toDateTime(DateTimeZone.UTC);
}
@Override
public IEvent map(int index, ResultSet r, StatementContext ctx)
throws SQLException {
UUID id = UUID.fromString(r.getString("event_id"));
EventType eventType = EventType.valueOf(r.getString("event_type"));
ApiEventType userType = (eventType == EventType.API_USER) ? ApiEventType.valueOf(r.getString("user_type")) : null;
DateTime createdDate = getDate(r, "created_dt");
DateTime requestedDate = getDate(r, "requested_dt");
DateTime effectiveDate = getDate(r, "effective_dt");
UUID subscriptionId = UUID.fromString(r.getString("subscription_id"));
String planName = r.getString("plan_name");
String phaseName = r.getString("phase_name");
String priceListName = r.getString("plist_name");
long currentVersion = r.getLong("current_version");
boolean isActive = r.getBoolean("is_active");
DateTime nextAvailableDate = getDate(r, "processing_available_dt");
UUID processingOwner = (r.getString("processing_owner") != null) ? UUID.fromString(r.getString("processing_owner")) : null;
IEventLyfecycleState processingState = IEventLyfecycleState.valueOf(r.getString("processing_state"));
IEvent result = null;
if (eventType == EventType.PHASE) {
result = new PhaseEvent(id, subscriptionId, phaseName, requestedDate, effectiveDate, createdDate,
currentVersion, isActive, processingOwner, nextAvailableDate, processingState);
} else if (userType == ApiEventType.CREATE) {
result = new ApiEventCreate(id, subscriptionId, createdDate, planName, phaseName, priceListName, requestedDate, effectiveDate,
currentVersion, isActive, processingOwner, nextAvailableDate, processingState);
} else if (userType == ApiEventType.CHANGE) {
result = new ApiEventChange(id, subscriptionId, createdDate, planName, phaseName, priceListName, requestedDate, effectiveDate,
currentVersion, isActive, processingOwner, nextAvailableDate, processingState);
} else if (userType == ApiEventType.CANCEL) {
result = new ApiEventCancel(id, subscriptionId, createdDate, planName, phaseName, priceListName, requestedDate, effectiveDate,
currentVersion, isActive, processingOwner, nextAvailableDate, processingState);
} else if (userType == ApiEventType.PAUSE) {
result = new ApiEventPause(id, subscriptionId, createdDate, planName, phaseName, priceListName, requestedDate, effectiveDate,
currentVersion, isActive, processingOwner, nextAvailableDate, processingState);
} else if (userType == ApiEventType.RESUME) {
result = new ApiEventResume(id, subscriptionId, createdDate, planName, phaseName, priceListName, requestedDate, effectiveDate,
currentVersion, isActive, processingOwner, nextAvailableDate, processingState);
} else if (userType == ApiEventType.UNCANCEL) {
result = new ApiEventUncancel(id, subscriptionId, createdDate, planName, phaseName, priceListName, requestedDate, effectiveDate,
currentVersion, isActive, processingOwner, nextAvailableDate, processingState);
} else {
throw new EntitlementError(String.format("Can't deserialize event %s", eventType));
}
return result;
}
}
}