org.killbill.billing.catalog.DefaultPlan Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of catalog-test Show documentation
Show all versions of catalog-test Show documentation
Test Plugin for CatalogPluginApin
/*
* Copyright 2010-2013 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 org.killbill.billing.catalog;
import java.net.URI;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlID;
import javax.xml.bind.annotation.XmlIDREF;
import org.joda.time.DateTime;
import org.killbill.billing.ErrorCode;
import org.killbill.billing.catalog.api.BillingPeriod;
import org.killbill.billing.catalog.api.CatalogApiException;
import org.killbill.billing.catalog.api.PhaseType;
import org.killbill.billing.catalog.api.Plan;
import org.killbill.billing.catalog.api.PlanPhase;
import org.killbill.billing.catalog.api.PlanPhasePriceOverride;
import org.killbill.billing.catalog.api.Product;
import org.killbill.billing.catalog.api.Recurring;
import org.killbill.xmlloader.ValidatingConfig;
import org.killbill.xmlloader.ValidationError;
import org.killbill.xmlloader.ValidationErrors;
@XmlAccessorType(XmlAccessType.NONE)
public class DefaultPlan extends ValidatingConfig implements Plan {
@XmlAttribute(required = true)
@XmlID
private String name;
@XmlAttribute(required = false)
private Boolean retired;
//TODO MDW Validation - effectiveDateForExistingSubscriptons > catalog effectiveDate
@XmlElement(required = false)
private Date effectiveDateForExistingSubscriptons;
@XmlElement(required = true)
@XmlIDREF
private DefaultProduct product;
@XmlElementWrapper(name = "initialPhases", required = false)
@XmlElement(name = "phase", required = true)
private DefaultPlanPhase[] initialPhases;
@XmlElement(name = "finalPhase", required = true)
private DefaultPlanPhase finalPhase;
//If this is missing it defaults to 1
//No other value is allowed for BASE plans.
//No other value is allowed for Tiered ADDONS
//A value of -1 means unlimited
@XmlElement(required = false)
private Integer plansAllowedInBundle = 1;
public DefaultPlan() {
initialPhases = new DefaultPlanPhase[0];
retired = false;
}
public DefaultPlan(final String planName, final DefaultPlan in, final PlanPhasePriceOverride[] overrides) {
this.name = planName;
this.retired = in.isRetired();
this.effectiveDateForExistingSubscriptons = in.getEffectiveDateForExistingSubscriptons();
this.product = (DefaultProduct) in.getProduct();
this.initialPhases = new DefaultPlanPhase[in.getInitialPhases().length];
for (int i = 0; i< overrides.length - 1; i++) {
final DefaultPlanPhase newPhase = new DefaultPlanPhase(this, in.getInitialPhases()[i], overrides[i]);
initialPhases[i] = newPhase;
}
this.finalPhase = new DefaultPlanPhase(this, in.getFinalPhase(), overrides[overrides.length - 1]);
}
/* (non-Javadoc)
* @see org.killbill.billing.catalog.IPlan#getEffectiveDateForExistingSubscriptons()
*/
@Override
public Date getEffectiveDateForExistingSubscriptons() {
return effectiveDateForExistingSubscriptons;
} /* (non-Javadoc)
* @see org.killbill.billing.catalog.IPlan#getPhases()
*/
@Override
public DefaultPlanPhase[] getInitialPhases() {
return initialPhases;
}
/* (non-Javadoc)
* @see org.killbill.billing.catalog.IPlan#getProduct()
*/
@Override
public Product getProduct() {
return product;
}
/* (non-Javadoc)
* @see org.killbill.billing.catalog.IPlan#getName()
*/
@Override
public String getName() {
return name;
}
@Override
public boolean isRetired() {
return retired;
}
@Override
public DefaultPlanPhase getFinalPhase() {
return finalPhase;
}
@Override
public PlanPhase[] getAllPhases() {
final int length = (initialPhases == null || initialPhases.length == 0) ? 1 : (initialPhases.length + 1);
final PlanPhase[] allPhases = new DefaultPlanPhase[length];
int cnt = 0;
if (length > 1) {
for (final PlanPhase cur : initialPhases) {
allPhases[cnt++] = cur;
}
}
allPhases[cnt++] = finalPhase;
return allPhases;
}
@Override
public PlanPhase findPhase(final String name) throws CatalogApiException {
for (final PlanPhase pp : getAllPhases()) {
if (pp.getName().equals(name)) {
return pp;
}
}
throw new CatalogApiException(ErrorCode.CAT_NO_SUCH_PHASE, name);
}
@Override
public BillingPeriod getRecurringBillingPeriod() {
return finalPhase.getRecurring() != null ? finalPhase.getRecurring().getBillingPeriod() : BillingPeriod.NO_BILLING_PERIOD;
}
/* (non-Javadoc)
* @see org.killbill.billing.catalog.IPlan#getPlansAllowedInBundle()
*/
@Override
public int getPlansAllowedInBundle() {
return plansAllowedInBundle;
}
/* (non-Javadoc)
* @see org.killbill.billing.catalog.IPlan#getPhaseIterator()
*/
@Override
public Iterator getInitialPhaseIterator() {
final ArrayList list = new ArrayList();
for (final DefaultPlanPhase p : initialPhases) {
list.add(p);
}
return list.iterator();
}
@Override
public void initialize(final StandaloneCatalog catalog, final URI sourceURI) {
super.initialize(catalog, sourceURI);
if (finalPhase != null) {
finalPhase.setPlan(this);
finalPhase.initialize(catalog, sourceURI);
}
if (initialPhases != null) {
for (final DefaultPlanPhase p : initialPhases) {
p.setPlan(this);
p.initialize(catalog, sourceURI);
}
}
}
@Override
public ValidationErrors validate(final StandaloneCatalog catalog, final ValidationErrors errors) {
if (effectiveDateForExistingSubscriptons != null &&
catalog.getEffectiveDate().getTime() > effectiveDateForExistingSubscriptons.getTime()) {
errors.add(new ValidationError(String.format("Price effective date %s is before catalog effective date '%s'",
effectiveDateForExistingSubscriptons,
catalog.getEffectiveDate().getTime()),
catalog.getCatalogURI(), DefaultInternationalPrice.class, ""));
}
validateCollection(catalog, errors, initialPhases);
finalPhase.validate(catalog, errors);
return errors;
}
public void setEffectiveDateForExistingSubscriptons(
final Date effectiveDateForExistingSubscriptons) {
this.effectiveDateForExistingSubscriptons = effectiveDateForExistingSubscriptons;
}
public DefaultPlan setName(final String name) {
this.name = name;
return this;
}
public DefaultPlan setFinalPhase(final DefaultPlanPhase finalPhase) {
this.finalPhase = finalPhase;
return this;
}
public DefaultPlan setProduct(final DefaultProduct product) {
this.product = product;
return this;
}
public DefaultPlan setInitialPhases(final DefaultPlanPhase[] phases) {
this.initialPhases = phases;
return this;
}
public DefaultPlan setRetired(final boolean retired) {
this.retired = retired;
return this;
}
public DefaultPlan setPlansAllowedInBundle(final Integer plansAllowedInBundle) {
this.plansAllowedInBundle = plansAllowedInBundle;
return this;
}
@Override
public DateTime dateOfFirstRecurringNonZeroCharge(final DateTime subscriptionStartDate, final PhaseType initialPhaseType) {
DateTime result = subscriptionStartDate.toDateTime();
boolean skipPhase = initialPhaseType == null ? false : true;
for (final PlanPhase phase : getAllPhases()) {
if (skipPhase) {
if (phase.getPhaseType() != initialPhaseType) {
continue;
} else {
skipPhase = false;
}
}
final Recurring recurring = phase.getRecurring();
if (recurring == null || recurring.getRecurringPrice() == null || recurring.getRecurringPrice().isZero()) {
result = phase.getDuration().addToDateTime(result);
} else {
break;
}
}
return result;
}
@Override
public boolean equals(final Object o) {
if (this == o) {
return true;
}
if (!(o instanceof DefaultPlan)) {
return false;
}
final DefaultPlan that = (DefaultPlan) o;
if (effectiveDateForExistingSubscriptons != null ? !effectiveDateForExistingSubscriptons.equals(that.effectiveDateForExistingSubscriptons) : that.effectiveDateForExistingSubscriptons != null) {
return false;
}
if (finalPhase != null ? !finalPhase.equals(that.finalPhase) : that.finalPhase != null) {
return false;
}
if (!Arrays.equals(initialPhases, that.initialPhases)) {
return false;
}
if (name != null ? !name.equals(that.name) : that.name != null) {
return false;
}
if (plansAllowedInBundle != null ? !plansAllowedInBundle.equals(that.plansAllowedInBundle) : that.plansAllowedInBundle != null) {
return false;
}
if (product != null ? !product.equals(that.product) : that.product != null) {
return false;
}
if (retired != null ? !retired.equals(that.retired) : that.retired != null) {
return false;
}
return true;
}
@Override
public int hashCode() {
int result = name != null ? name.hashCode() : 0;
result = 31 * result + (retired != null ? retired.hashCode() : 0);
result = 31 * result + (effectiveDateForExistingSubscriptons != null ? effectiveDateForExistingSubscriptons.hashCode() : 0);
result = 31 * result + (initialPhases != null ? Arrays.hashCode(initialPhases) : 0);
result = 31 * result + (finalPhase != null ? finalPhase.hashCode() : 0);
result = 31 * result + (plansAllowedInBundle != null ? plansAllowedInBundle.hashCode() : 0);
return result;
}
@Override
public String toString() {
return "DefaultPlan [name=" + name + ", retired=" + retired + ", effectiveDateForExistingSubscriptons="
+ effectiveDateForExistingSubscriptons + ", product=" + product + ", initialPhases="
+ Arrays.toString(initialPhases) + ", finalPhase=" + finalPhase + ", plansAllowedInBundle="
+ plansAllowedInBundle + "]";
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy