org.killbill.billing.util.config.definition.InvoiceConfig Maven / Gradle / Ivy
/*
* Copyright 2014-2020 Groupon, Inc
* Copyright 2014-2020 The Billing Project, LLC
*
* The Billing Project 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.util.config.definition;
import java.util.List;
import org.joda.time.Period;
import org.killbill.billing.callcontext.InternalTenantContext;
import org.skife.config.Config;
import org.skife.config.Default;
import org.skife.config.Description;
import org.skife.config.Param;
import org.skife.config.TimeSpan;
public interface InvoiceConfig extends LockAwareConfig {
// Default period value for when nothing is specified
// This is needed because the default Period value coming from config-magic calling Period(null) -> Period("PT0S")
// and any Zero Period is a valid value.
//
String DEFAULT_NULL_PERIOD = "P200Y";
enum AccountTzOffset {
/*
* Use the one time computation offset from when account was created, i.e context#fixedOffsetTimeZone.
* This is the same behavior we use for other invoice items (RECURRING)
*/
FIXED,
/*
* Recompute offset based on where we are during the year, i.e context#accountTimeZone.
* This produces consistent results across similar accounts (same TZ, same subscriptions, usage points)
* even though they were started at different time during the year, i.e summer/winter.
*/
VARIABLE,
}
enum UsageDetailMode {
AGGREGATE,
DETAIL,
}
enum InArrearMode {
DEFAULT,
GREEDY
}
@Config("org.killbill.invoice.maxNumberOfMonthsInFuture")
@Default("36")
@Description("Maximum target date to consider when generating an invoice")
int getNumberOfMonthsInFuture();
@Config("org.killbill.invoice.maxNumberOfMonthsInFuture")
@Default("36")
@Description("Maximum target date to consider when generating an invoice")
int getNumberOfMonthsInFuture(@Param("dummy") final InternalTenantContext tenantContext);
@Config("org.killbill.invoice.sanitySafetyBoundEnabled")
@Default("true")
@Description("Whether internal sanity checks to prevent mis- and double-billing are enabled")
boolean isSanitySafetyBoundEnabled();
@Config("org.killbill.invoice.sanitySafetyBoundEnabled")
@Default("true")
@Description("Whether internal sanity checks to prevent mis- and double-billing are enabled")
boolean isSanitySafetyBoundEnabled(@Param("dummy") final InternalTenantContext tenantContext);
@Config("org.killbill.invoice.disable.usage.zero.amount")
@Default("false")
@Description("Whether we disable writing $0 usage amounts")
boolean isUsageZeroAmountDisabled();
@Config("org.killbill.invoice.disable.usage.zero.amount")
@Default("false")
@Description("Whether we disable writing $0 usage amounts")
boolean isUsageZeroAmountDisabled(@Param("dummy") final InternalTenantContext tenantContext);
@Config("org.killbill.invoice.usage.missing.lenient")
@Default("false")
@Description("Whether we fail invoice when we discover missing past usage records")
boolean isUsageMissingLenient();
@Config("org.killbill.invoice.usage.missing.lenient")
@Default("false")
@Description("Whether we fail invoice when we discover missing past usage records")
boolean isUsageMissingLenient(@Param("dummy") final InternalTenantContext tenantContext);
@Config("org.killbill.invoice.maxDailyNumberOfItemsSafetyBound")
@Default("15")
@Description("Maximum daily number of invoice items to generate for a subscription id")
int getMaxDailyNumberOfItemsSafetyBound();
@Config("org.killbill.invoice.maxDailyNumberOfItemsSafetyBound")
@Default("15")
@Description("Maximum daily number of invoice items to generate for a subscription id")
int getMaxDailyNumberOfItemsSafetyBound(@Param("dummy") final InternalTenantContext tenantContext);
@Config("org.killbill.invoice.dryRunNotificationSchedule")
@Default("0s")
@Description("DryRun invoice notification time before targetDate (ignored if set to 0s)")
TimeSpan getDryRunNotificationSchedule();
@Config("org.killbill.invoice.dryRunNotificationSchedule")
@Default("0s")
@Description("DryRun invoice notification time before targetDate (ignored if set to 0s)")
TimeSpan getDryRunNotificationSchedule(@Param("dummy") final InternalTenantContext tenantContext);
@Config("org.killbill.invoice.readMaxRawUsagePreviousPeriod")
@Default("2")
@Description("Maximum number of past billing periods we use to fetch raw usage data (usage optimization)")
int getMaxRawUsagePreviousPeriod();
@Config("org.killbill.invoice.readMaxRawUsagePreviousPeriod")
@Default("2")
@Description("Maximum number of past billing periods we use to fetch raw usage data (usage optimization)")
int getMaxRawUsagePreviousPeriod(@Param("dummy") final InternalTenantContext tenantContext);
@Config("org.killbill.invoice.globalLock.retries")
@Default("50")
@Description("Maximum number of times the system will retry to grab global lock (with a 100ms wait each time)")
int getMaxGlobalLockRetries();
@Config("org.killbill.invoice.plugin")
@Default("")
@Description("Default invoice plugin names")
List getInvoicePluginNames();
@Config("org.killbill.invoice.plugin")
@Default("")
@Description("Default invoice plugin names")
List getInvoicePluginNames(@Param("dummy") final InternalTenantContext tenantContext);
@Config("org.killbill.invoice.emailNotificationsEnabled")
@Default("false")
@Description("Whether to send email notifications on invoice creation (for configured accounts)")
boolean isEmailNotificationsEnabled();
@Config("org.killbill.invoice.enabled")
@Default("true")
@Description("Whether the invoicing system is enabled")
boolean isInvoicingSystemEnabled();
@Config("org.killbill.invoice.parent.commit.local.utc.time")
@Default("23:59:59.999")
@Description("UTC Time when parent invoice gets committed")
String getParentAutoCommitUtcTime();
@Config("org.killbill.invoice.parent.commit.local.utc.time")
@Default("23:59:59.999")
@Description("UTC Time when parent invoice gets committed")
String getParentAutoCommitUtcTime(@Param("dummy") final InternalTenantContext tenantContext);
@Config("org.killbill.invoice.enabled")
@Default("true")
@Description("Whether the invoicing system is enabled")
boolean isInvoicingSystemEnabled(@Param("dummy") final InternalTenantContext tenantContext);
@Config("org.killbill.invoice.item.result.behavior.mode")
@Default("AGGREGATE")
@Description("How the result for an item will be reported (aggregate mode or detail mode). ")
UsageDetailMode getItemResultBehaviorMode();
@Config("org.killbill.invoice.item.result.behavior.mode")
@Default("AGGREGATE")
@Description("How the result for an item will be reported (aggregate mode or detail mode). ")
UsageDetailMode getItemResultBehaviorMode(@Param("dummy") final InternalTenantContext tenantContext);
@Config("org.killbill.invoice.usage.tz.mode")
@Default("FIXED")
@Description("Behavior to include usage points with respect to day light saving")
AccountTzOffset getAccountTzOffsetMode();
@Config("org.killbill.invoice.usage.tz.mode")
@Default("FIXED")
@Description("Behavior to include usage points with respect to day light saving")
AccountTzOffset getAccountTzOffsetMode(@Param("dummy") final InternalTenantContext tenantContext);
@Config("org.killbill.invoice.inArrear.mode")
@Default("DEFAULT")
@Description("Determine how the system should behave for in-arrear plans")
InArrearMode getInArrearMode();
@Config("org.killbill.invoice.inArrear.mode")
@Default("DEFAULT")
@Description("Determine how the system should behave for in-arrear plans")
InArrearMode getInArrearMode(@Param("dummy") final InternalTenantContext tenantContext);
@Config("org.killbill.invoice.parkAccountsWithUnknownUsage")
@Default("false")
@Description("Whether to park accounts when usage data is recorded but not defined in the catalog")
boolean shouldParkAccountsWithUnknownUsage();
@Config("org.killbill.invoice.parkAccountsWithUnknownUsage")
@Default("false")
@Description("Whether to park accounts when usage data is recorded but not defined in the catalog")
boolean shouldParkAccountsWithUnknownUsage(@Param("dummy") final InternalTenantContext tenantContext);
@Config("org.killbill.invoice.maxInvoiceLimit")
@Default(DEFAULT_NULL_PERIOD)
@Description("How far back in time should invoice generation look at")
Period getMaxInvoiceLimit();
@Config("org.killbill.invoice.maxInvoiceLimit")
@Default(DEFAULT_NULL_PERIOD)
@Description("How far back in time should invoice generation look at")
Period getMaxInvoiceLimit(@Param("dummy") final InternalTenantContext tenantContext);
@Config("org.killbill.invoice.proration.fixed.days")
@Default("0")
@Description("Fixed number of days in a month to avoid proration")
int getProrationFixedDays();
@Config("org.killbill.invoice.proration.fixed.days")
@Default("0")
@Description("Fixed number of days in a month to avoid proration")
int getProrationFixedDays(@Param("dummy") final InternalTenantContext tenantContext);
}