org.killbill.billing.usage.api.BaseUserApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of killbill-usage Show documentation
The newest version!
/*
 * Copyright 2014-2019 Groupon, Inc
 * Copyright 2014-2019 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.usage.api;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.UUID;

import javax.annotation.Nullable;

import org.joda.time.DateTime;
import org.killbill.billing.osgi.api.OSGIServiceRegistration;
import org.killbill.billing.payment.api.PluginProperty;
import org.killbill.billing.usage.plugin.api.UsageContext;
import org.killbill.billing.usage.plugin.api.UsagePluginApi;
import org.killbill.commons.utils.Preconditions;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class BaseUserApi {

    private static final Logger logger = LoggerFactory.getLogger(BaseUserApi.class);

    private final OSGIServiceRegistration pluginRegistry;

    public BaseUserApi(final OSGIServiceRegistration pluginRegistry) {
        this.pluginRegistry = pluginRegistry;
    }

    //
    // * If no plugin were registered or if plugins do not serve usage data for this tenant/account this returns null
    //   and the usage module will look for data inside its own table.
    // * If not, a possibly empty (or not) list should be returned (and the usage module will *not* look for data inside its own table)
    //
    protected List getAccountUsageFromPlugin(final DateTime startDate, final DateTime endDate, final Iterable properties, final UsageContext usageContext) {
        return getUsageFromPlugin(null, startDate, endDate, properties, usageContext);
    }

    protected List getSubscriptionUsageFromPlugin(final UUID subscriptionId, final DateTime startDate, final DateTime endDate, final Iterable properties, final UsageContext usageContext) {
        return getUsageFromPlugin(subscriptionId, startDate, endDate, properties, usageContext);
    }

    private List getUsageFromPlugin(@Nullable final UUID subscriptionId, final DateTime startDate, final DateTime endDate, final Iterable properties, final UsageContext usageContext) {
        Preconditions.checkNotNull(usageContext.getAccountId(), "UsageContext has no accountId");

        final Set allServices = pluginRegistry.getAllServices();
        // No plugin registered
        if (allServices.isEmpty()) {
            return null;
        }
        for (final String service : allServices) {
            final UsagePluginApi plugin = pluginRegistry.getServiceForName(service);

            final List result = subscriptionId != null ?
                                                plugin.getUsageForSubscription(subscriptionId, startDate, endDate, usageContext, properties) :
                                                plugin.getUsageForAccount(startDate, endDate, usageContext, properties);
            // First plugin registered, returns result -- could be empty List if no usage was recorded.
            if (result != null) {

                final DebugMap debugMap = new DebugMap(startDate, endDate, logger);
                for (final RawUsageRecord cur : result) {
                    if (cur.getDate().compareTo(startDate) < 0 || cur.getDate().compareTo(endDate) >= 0) {
                        logger.warn("Usage plugin returned usage data with date {}, not in the specified range [{} -> {}[",
                                    cur.getDate(), startDate, endDate);
                    }
                    debugMap.add(cur);
                }
                debugMap.logDebug();
                return result;
            }
        }
        // All registered plugins returned null
        return null;
    }

    private static class DebugMap {

        private final Map> perSubscriptionRecords;
        private final Logger logger;
        private final DateTime startDate;
        private final DateTime endDate;

        public DebugMap(final DateTime startDate, final DateTime endDate, final Logger logger) {
            this.logger = logger;
            this.startDate = startDate;
            this.endDate = endDate;
            if (logger.isDebugEnabled()) {
                this.perSubscriptionRecords = new HashMap<>();
            } else {
                this.perSubscriptionRecords = Collections.emptyMap();
            }
        }

        public void add(final RawUsageRecord record) {
            if (!logger.isDebugEnabled()) {
                return;
            }
            List perSubscriptionList = perSubscriptionRecords.get(record.getSubscriptionId());
            if (perSubscriptionList == null) {
                perSubscriptionList = new ArrayList();
                perSubscriptionRecords.put(record.getSubscriptionId(), perSubscriptionList);
            }
            perSubscriptionList.add(record);
        }

        public void logDebug() {
            if (!logger.isDebugEnabled()) {
                return;
            }

            for (final Entry> entry  : perSubscriptionRecords.entrySet()) {
                final List val = entry.getValue();
                for (final RawUsageRecord r : val) {
                    final StringBuffer tmp = new StringBuffer();
                    tmp.append("UserApi (plugin) subId=");
                    tmp.append(entry.getKey());
                    tmp.append(", startDate=");
                    tmp.append(startDate);
                    tmp.append(", endDate=");
                    tmp.append(endDate);
                    tmp.append(", recordDt=");
                    tmp.append(r.getDate());
                    tmp.append(", amount=");
                    tmp.append(r.getAmount());
                    logger.debug(tmp.toString());
                }
            }
        }
    }

}