Details
diff --git a/api/src/main/java/com/ning/billing/util/template/translation/TranslatorConfig.java b/api/src/main/java/com/ning/billing/util/template/translation/TranslatorConfig.java
index bd33887..5557241 100644
--- a/api/src/main/java/com/ning/billing/util/template/translation/TranslatorConfig.java
+++ b/api/src/main/java/com/ning/billing/util/template/translation/TranslatorConfig.java
@@ -23,34 +23,40 @@ import org.skife.config.Description;
import com.ning.billing.invoice.api.formatters.InvoiceFormatterFactory;
public interface TranslatorConfig {
+
// Common
@Config("killbill.default.locale")
@Default("en_US")
+ @Description("Default Killbill locale")
public String getDefaultLocale();
// Catalog
@Config("killbill.catalog.bundlePath")
@Default("com/ning/billing/util/template/translation/CatalogTranslation")
+ @Description("Path to the catalog translation bundle")
String getCatalogBundlePath();
// Invoices
@Config("killbill.template.bundlePath")
@Default("com/ning/billing/util/template/translation/InvoiceTranslation")
+ @Description("Path to the invoice template translation bundle")
public String getInvoiceTemplateBundlePath();
@Config("killbill.template.name")
@Default("com/ning/billing/util/email/templates/HtmlInvoiceTemplate.mustache")
+ @Description("Path to the HTML invoice template")
String getTemplateName();
@Config("killbill.manualPayTemplate.name")
@Default("com/ning/billing/util/email/templates/HtmlInvoiceTemplate.mustache")
- @Description("Invoice template for accounts with MANUAL_PAY tag")
+ @Description("Path to the invoice template for accounts with MANUAL_PAY tag")
String getManualPayTemplateName();
@Config("killbill.template.invoiceFormatterFactoryClass")
@Default("com.ning.billing.invoice.template.formatters.DefaultInvoiceFormatterFactory")
+ @Description("Invoice formatter class")
Class<? extends InvoiceFormatterFactory> getInvoiceFormatterFactoryClass();
}
diff --git a/overdue/src/main/java/com/ning/billing/overdue/OverdueProperties.java b/overdue/src/main/java/com/ning/billing/overdue/OverdueProperties.java
index 3b2c3d3..60fa371 100644
--- a/overdue/src/main/java/com/ning/billing/overdue/OverdueProperties.java
+++ b/overdue/src/main/java/com/ning/billing/overdue/OverdueProperties.java
@@ -18,6 +18,7 @@ package com.ning.billing.overdue;
import org.skife.config.Config;
import org.skife.config.Default;
+import org.skife.config.Description;
import com.ning.billing.util.config.KillbillConfig;
@@ -25,5 +26,6 @@ public interface OverdueProperties extends KillbillConfig {
@Config("killbill.overdue.uri")
@Default("NoOverdueConfig.xml")
+ @Description("Overdue configuration location. Either in the classpath or in the filesystem")
public String getConfigURI();
}
diff --git a/util/src/main/java/com/ning/billing/util/bus/PersistentBusConfig.java b/util/src/main/java/com/ning/billing/util/bus/PersistentBusConfig.java
index 6ca9bdc..2a3822b 100644
--- a/util/src/main/java/com/ning/billing/util/bus/PersistentBusConfig.java
+++ b/util/src/main/java/com/ning/billing/util/bus/PersistentBusConfig.java
@@ -13,10 +13,12 @@
* License for the specific language governing permissions and limitations
* under the License.
*/
+
package com.ning.billing.util.bus;
import org.skife.config.Config;
import org.skife.config.Default;
+import org.skife.config.Description;
import com.ning.billing.util.config.PersistentQueueConfig;
@@ -25,14 +27,17 @@ public interface PersistentBusConfig extends PersistentQueueConfig {
@Override
@Config("killbill.billing.util.persistent.bus.sleep")
@Default("3000")
+ @Description("Time in milliseconds to sleep between runs")
public long getSleepTimeMs();
+ @Override
@Config("killbill.billing.util.persistent.bus.off")
@Default("false")
- @Override
+ @Description("Whether to turn off the persistent bus")
public boolean isProcessingOff();
@Config("killbill.billing.util.persistent.bus.nbThreads")
@Default("3")
+ @Description("Number of threads to use")
public int getNbThreads();
}
diff --git a/util/src/main/java/com/ning/billing/util/config/CacheConfig.java b/util/src/main/java/com/ning/billing/util/config/CacheConfig.java
index b10edb9..d5785e0 100644
--- a/util/src/main/java/com/ning/billing/util/config/CacheConfig.java
+++ b/util/src/main/java/com/ning/billing/util/config/CacheConfig.java
@@ -18,11 +18,13 @@ package com.ning.billing.util.config;
import org.skife.config.Config;
import org.skife.config.Default;
+import org.skife.config.Description;
public interface CacheConfig extends KillbillConfig {
@Config("killbill.cache.config.location")
@Default("/ehcache.xml")
+ @Description("Path to Ehcache XML configuration")
public String getCacheConfigLocation();
}
diff --git a/util/src/main/java/com/ning/billing/util/config/CatalogConfig.java b/util/src/main/java/com/ning/billing/util/config/CatalogConfig.java
index 1e6d1a4..3a6cc3e 100644
--- a/util/src/main/java/com/ning/billing/util/config/CatalogConfig.java
+++ b/util/src/main/java/com/ning/billing/util/config/CatalogConfig.java
@@ -18,10 +18,12 @@ package com.ning.billing.util.config;
import org.skife.config.Config;
import org.skife.config.Default;
+import org.skife.config.Description;
public interface CatalogConfig extends KillbillConfig {
@Config("killbill.catalog.uri")
@Default("SpyCarBasic.xml")
+ @Description("Catalog location. Either in the classpath or in the filesystem")
String getCatalogURI();
}
diff --git a/util/src/main/java/com/ning/billing/util/config/InvoiceConfig.java b/util/src/main/java/com/ning/billing/util/config/InvoiceConfig.java
index 73db4fc..0a16915 100644
--- a/util/src/main/java/com/ning/billing/util/config/InvoiceConfig.java
+++ b/util/src/main/java/com/ning/billing/util/config/InvoiceConfig.java
@@ -18,13 +18,17 @@ package com.ning.billing.util.config;
import org.skife.config.Config;
import org.skife.config.Default;
+import org.skife.config.Description;
public interface InvoiceConfig extends KillbillConfig {
+
@Config("killbill.invoice.maxNumberOfMonthsInFuture")
@Default("36")
+ @Description("Maximum target date to consider when generating an invoice")
public int getNumberOfMonthsInFuture();
@Config("killbill.invoice.emailNotificationsEnabled")
@Default("false")
+ @Description("Whether to send email notifications on invoice creation (for configured accounts)")
public boolean isEmailNotificationsEnabled();
}
diff --git a/util/src/main/java/com/ning/billing/util/config/OSGIConfig.java b/util/src/main/java/com/ning/billing/util/config/OSGIConfig.java
index 44b44c2..3b8b7b0 100644
--- a/util/src/main/java/com/ning/billing/util/config/OSGIConfig.java
+++ b/util/src/main/java/com/ning/billing/util/config/OSGIConfig.java
@@ -18,23 +18,28 @@ package com.ning.billing.util.config;
import org.skife.config.Config;
import org.skife.config.Default;
+import org.skife.config.Description;
public interface OSGIConfig extends KillbillConfig {
@Config("killbill.osgi.bundle.property.name")
@Default("killbill.properties")
+ @Description("Name of the properties file for OSGI plugins")
public String getOSGIKillbillPropertyName();
@Config("killbill.osgi.root.dir")
@Default("/var/tmp/felix")
+ @Description("Bundles cache area for the OSGI framework")
public String getOSGIBundleRootDir();
@Config("killbill.osgi.bundle.cache.name")
@Default("osgi-cache")
+ @Description("Bundles cache name")
public String getOSGIBundleCacheName();
@Config("killbill.osgi.bundle.install.dir")
@Default("/var/tmp/bundles")
+ @Description("Bundles install directory")
public String getRootInstallationDir();
@Config("killbill.osgi.system.bundle.export.packages")
@@ -72,5 +77,6 @@ public interface OSGIConfig extends KillbillConfig {
"org.osgi.service.event;version=1.2.0," +
// Let the world know the System bundle exposes the requirement (&(osgi.wiring.package=org.slf4j)(version>=1.7.0)(!(version>=2.0.0)))
"org.slf4j;version=1.7.2")
+ @Description("Packages to export from the system bundle")
public String getSystemBundleExportPackages();
}
diff --git a/util/src/main/java/com/ning/billing/util/config/PaymentConfig.java b/util/src/main/java/com/ning/billing/util/config/PaymentConfig.java
index 64ae12d..2d2c3eb 100644
--- a/util/src/main/java/com/ning/billing/util/config/PaymentConfig.java
+++ b/util/src/main/java/com/ning/billing/util/config/PaymentConfig.java
@@ -20,15 +20,18 @@ import java.util.List;
import org.skife.config.Config;
import org.skife.config.Default;
-
+import org.skife.config.Description;
public interface PaymentConfig extends KillbillConfig {
+
@Config("killbill.payment.provider.default")
@Default("noop")
+ @Description("Default payment provider to use")
public String getDefaultPaymentProvider();
@Config("killbill.payment.retry.days")
@Default("8,8,8")
+ @Description("Interval in days between payment retries")
public List<Integer> getPaymentRetryDays();
@Config("killbill.payment.failure.retry.start.sec")
@@ -41,9 +44,11 @@ public interface PaymentConfig extends KillbillConfig {
@Config("killbill.payment.failure.retry.max.attempts")
@Default("8")
+ @Description("Maximum number of retries for failed payments")
public int getPluginFailureRetryMaxAttempts();
@Config("killbill.payment.off")
@Default("false")
+ @Description("Whether the payment subsystem is off")
public boolean isPaymentOff();
}
diff --git a/util/src/main/java/com/ning/billing/util/email/EmailConfig.java b/util/src/main/java/com/ning/billing/util/email/EmailConfig.java
index 60513d9..175f89e 100644
--- a/util/src/main/java/com/ning/billing/util/email/EmailConfig.java
+++ b/util/src/main/java/com/ning/billing/util/email/EmailConfig.java
@@ -19,39 +19,49 @@ package com.ning.billing.util.email;
import org.skife.config.Config;
import org.skife.config.Default;
import org.skife.config.DefaultNull;
+import org.skife.config.Description;
import com.ning.billing.util.config.KillbillConfig;
public interface EmailConfig extends KillbillConfig {
+
@Config("killbill.mail.smtp.host")
@DefaultNull
+ @Description("MTA host used for email notifications")
public String getSmtpServerName();
@Config("killbill.mail.smtp.port")
@DefaultNull
+ @Description("MTA port used for email notifications")
public int getSmtpPort();
@Config("killbill.mail.smtp.auth")
@Default("false")
+ @Description("Whether to authenticate against the MTA")
public boolean useSmtpAuth();
@Config("killbill.mail.smtp.user")
@DefaultNull
+ @Description("Username to use to authenticate against the MTA")
public String getSmtpUserName();
@Config("killbill.mail.smtp.password")
@DefaultNull
+ @Description("Password to use to authenticate against the MTA")
public String getSmtpPassword();
@Config("killbill.mail.from")
@Default("support@example.com")
+ @Description("Default From: field for email notifications")
String getDefaultFrom();
@Config("killbill.mail.useSSL")
@Default("false")
+ @Description("Whether to use secure SMTP")
boolean useSSL();
@Config("killbill.mail.invoiceEmailSubject")
@Default("Your invoice")
+ @Description("Default Subject: field for invoice notifications")
String getInvoiceEmailSubject();
}
diff --git a/util/src/main/java/com/ning/billing/util/notificationq/NotificationQueueConfig.java b/util/src/main/java/com/ning/billing/util/notificationq/NotificationQueueConfig.java
index 86cbd51..dfc8678 100644
--- a/util/src/main/java/com/ning/billing/util/notificationq/NotificationQueueConfig.java
+++ b/util/src/main/java/com/ning/billing/util/notificationq/NotificationQueueConfig.java
@@ -18,6 +18,7 @@ package com.ning.billing.util.notificationq;
import org.skife.config.Config;
import org.skife.config.Default;
+import org.skife.config.Description;
import com.ning.billing.util.config.PersistentQueueConfig;
@@ -25,16 +26,18 @@ public interface NotificationQueueConfig extends PersistentQueueConfig {
@Config("killbill.billing.util.notificationq.prefetch")
@Default("7")
+ @Description("Number of notifications to fetch from the database at once")
public int getPrefetchAmount();
@Override
@Config("killbill.billing.util.notificationq.sleep")
@Default("3000")
+ @Description("Time in milliseconds to sleep between runs")
public long getSleepTimeMs();
+ @Override
@Config("killbill.billing.util.notificationq.notification.off")
@Default("false")
- @Override
+ @Description("Whether to turn off the notification queue")
public boolean isProcessingOff();
-
}