All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.camunda.bpm.engine.impl.metrics.MetricsQueryImpl Maven / Gradle / Ivy

There is a newer version: 7.22.0-alpha5
Show newest version
/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; 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.camunda.bpm.engine.impl.metrics;

import java.io.Serializable;
import java.util.Date;
import java.util.List;
import org.camunda.bpm.engine.ProcessEngineException;
import org.camunda.bpm.engine.impl.db.ListQueryParameterObject;
import org.camunda.bpm.engine.impl.interceptor.Command;
import org.camunda.bpm.engine.impl.interceptor.CommandContext;
import org.camunda.bpm.engine.impl.interceptor.CommandExecutor;
import org.camunda.bpm.engine.management.MetricsQuery;
import org.camunda.bpm.engine.impl.metrics.util.MetricsUtil;
import org.camunda.bpm.engine.management.MetricIntervalValue;

/**
 * @author Daniel Meyer
 *
 */
public class MetricsQueryImpl extends ListQueryParameterObject implements Serializable, Command, MetricsQuery {

  public static final int DEFAULT_LIMIT_SELECT_INTERVAL = 200;
  public static final long DEFAULT_SELECT_INTERVAL = 15 * 60;

  private static final long serialVersionUID = 1L;

  protected String name;
  protected String reporter;
  protected Date startDate;
  protected Date endDate;
  protected Long startDateMilliseconds;
  protected Long endDateMilliseconds;
  protected Long interval;
  protected Boolean aggregateByReporter;

  protected transient CommandExecutor commandExecutor;

  public MetricsQueryImpl(CommandExecutor commandExecutor) {
    this.commandExecutor = commandExecutor;
    this.maxResults = DEFAULT_LIMIT_SELECT_INTERVAL;
    this.interval = DEFAULT_SELECT_INTERVAL;
  }

  public MetricsQueryImpl name(String name) {
    this.name = MetricsUtil.resolveInternalName(name);
    return this;
  }

  public MetricsQuery reporter(String reporter) {
    this.reporter = reporter;
    return this;
  }

  public MetricsQueryImpl startDate(Date startDate) {
    this.startDate = startDate;
    this.startDateMilliseconds = startDate.getTime();
    return this;
  }

  public MetricsQueryImpl endDate(Date endDate) {
    this.endDate = endDate;
    this.endDateMilliseconds = endDate.getTime();
    return this;
  }

  /**
   * Contains the command implementation which should be executed either
   * metric sum or select metric grouped by time interval.
   *
   * Note: this enables to quit with the enum distinction
   */
  protected Command callback;

  @Override
  public List interval() {
    callback = new MetricsQueryIntervalCmd(this);

    return (List) commandExecutor.execute(this);
  }

  @Override
  public List interval(long interval) {
    this.interval = interval;
    return interval();
  }

  public long sum() {
    callback = new MetricsQuerySumCmd(this);

    return (Long) commandExecutor.execute(this);
  }

  @Override
  public Object execute(CommandContext commandContext) {
    if (callback != null) {
      return callback.execute(commandContext);
    }
    throw new ProcessEngineException("Query can't be executed. Use either sum or interval to query the metrics.");
  }

  @Override
  public MetricsQuery offset(int offset) {
    setFirstResult(offset);
    return this;
  }

  @Override
  public MetricsQuery limit(int maxResults) {
    setMaxResults(maxResults);
    return this;
  }

  @Override
  public MetricsQuery aggregateByReporter() {
    aggregateByReporter = true;
    return this;
  }

  @Override
  public void setMaxResults(int maxResults) {
    if (maxResults > DEFAULT_LIMIT_SELECT_INTERVAL) {
      throw new ProcessEngineException("Metrics interval query row limit can't be set larger than " + DEFAULT_LIMIT_SELECT_INTERVAL + '.');
    }
    this.maxResults = maxResults;
  }

  public Date getStartDate() {
    return startDate;
  }

  public Date getEndDate() {
    return endDate;
  }

  public Long getStartDateMilliseconds() {
    return startDateMilliseconds;
  }

  public Long getEndDateMilliseconds() {
    return endDateMilliseconds;
  }

  public String getName() {
    return name;
  }

  public String getReporter() {
    return reporter;
  }

  public Long getInterval() {
    if (interval == null) {
      return DEFAULT_SELECT_INTERVAL;
    }
    return interval;
  }

  @Override
  public int getMaxResults() {
    if (maxResults > DEFAULT_LIMIT_SELECT_INTERVAL) {
      return DEFAULT_LIMIT_SELECT_INTERVAL;
    }
    return super.getMaxResults();
  }

  protected class MetricsQueryIntervalCmd implements Command {

    protected MetricsQueryImpl metricsQuery;

    public MetricsQueryIntervalCmd(MetricsQueryImpl metricsQuery) {
      this.metricsQuery = metricsQuery;
    }

    @Override
    public Object execute(CommandContext commandContext) {
      return commandContext.getMeterLogManager()
          .executeSelectInterval(metricsQuery);
    }
  }

  protected class MetricsQuerySumCmd implements Command {

    protected MetricsQueryImpl metricsQuery;

    public MetricsQuerySumCmd(MetricsQueryImpl metricsQuery) {
      this.metricsQuery = metricsQuery;
    }

    @Override
    public Object execute(CommandContext commandContext) {
      return commandContext.getMeterLogManager()
          .executeSelectSum(metricsQuery);
    }
  }
}