com.ksc.metrics.RequestMetricCollector Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gebu-java-sdk-core Show documentation

The newest version!

/*
 * Copyright 2010-2016 ksyun.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://ksyun.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file 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 com.ksc.metrics;

import com.ksc.Request;
import com.ksc.Response;

/**
 * A service provider interface that can be used to implement an KSC SDK
 * request/response metric collector.
 * 
 * @see KscSdkMetrics
 */
public abstract class RequestMetricCollector {
    /**
     * Can be used to serve as a factory for the request metric collector.
     */
    public static interface Factory {
        /**
         * Returns an instance of the collector; or null if if failed to create
         * one.
         */
        public RequestMetricCollector getRequestMetricCollector();
    }
    /** 
     * Used to collect the metric at the end of a request/response cycle.
     *
     * @see Request#getKSCRequestMetrics()
     */
    public abstract void collectMetrics(Request request, Response response);
    public boolean isEnabled() { return true; }

    /** A convenient instance of a no-op request metric collector. */
    public static final RequestMetricCollector NONE = new RequestMetricCollector() {
        @Override public void collectMetrics(Request request, Response response) {}
        @Override public boolean isEnabled() { return false; }
    };
}