Skip to content

catalog: add getVersionedPluginCatalog overload accepting a planNames… #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jutur wants to merge 1 commit into
base: master
Choose a base branch
from
Open

catalog: add getVersionedPluginCatalog overload accepting a planNames… #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions catalog/src/main/java/org/killbill/billing/catalog/plugin/api/CatalogPluginApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,26 +17,41 @@

package org.killbill.billing.catalog.plugin.api;

import java.util.Set;

import org.joda.time.DateTime;
import org.killbill.billing.payment.api.PluginProperty;
import org.killbill.billing.util.callcontext.TenantContext;

public interface CatalogPluginApi {

public DateTime getLatestCatalogVersion(Iterable<PluginProperty> properties, final TenantContext context);

/**
* Returns a plugin versioned catalog for this tenant containing all plans.
*
* @param properties
* @param context
* @return
* @param properties plugin properties
* @param context tenant context
* @return versioned catalog or null if this plugin does not manage the catalog for this tenant
*/
public DateTime getLatestCatalogVersion(Iterable<PluginProperty> properties, final TenantContext context);

public VersionedPluginCatalog getVersionedPluginCatalog(Iterable<PluginProperty> properties, final TenantContext context);

/**
* Returns a plugin versioned catalog for this tenant
* Returns a plugin versioned catalog restricted to the specified plan names.
* <p>
* Kill Bill calls this overload when it already knows which plans are required (e.g. during
* invoice generation) so that plugins managing large catalogs can return a shallow subset
* rather than the full catalog, reducing serialization and processing overhead.
* <p>
* Implementations that do not need this optimization may rely on the default, which
* delegates to {@link #getVersionedPluginCatalog(Iterable, TenantContext)}.
*
* @param context
* @return
* @param planNames the set of plan names Kill Bill needs; never null but may be empty
* @param properties plugin properties
* @param context tenant context
* @return versioned catalog or null if this plugin does not manage the catalog for this tenant
*/
public VersionedPluginCatalog getVersionedPluginCatalog(Iterable<PluginProperty> properties, final TenantContext context);
default VersionedPluginCatalog getVersionedPluginCatalog(final Set<String> planNames, final Iterable<PluginProperty> properties, final TenantContext context) {
return getVersionedPluginCatalog(properties, context);
}
}