1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22 package org.opencastproject.statistics.api;
23
24 import java.time.Duration;
25 import java.util.concurrent.TimeUnit;
26
27 /**
28 * Interface for a class that can write statistical data of various data types
29 */
30 public interface StatisticsWriter {
31 /**
32 * Write a duration to a statistics data base
33 *
34 * @param organizationId Organization ID of the data point
35 * @param measurementName Measurement name of the data point
36 * @param retentionPolicy Retention policy of the data point
37 * @param organizationIdResourceName Resource name for the organization
38 * @param fieldName Field name to write
39 * @param temporalResolution The temporal resolution to store it in
40 * @param duration The actual duration to write
41 */
42 void writeDuration(
43 String organizationId,
44 String measurementName,
45 String retentionPolicy,
46 String organizationIdResourceName,
47 String fieldName,
48 TimeUnit temporalResolution,
49 Duration duration);
50
51 /**
52 * Lorem ipsum dolor sit amet
53 * @return the writer's ID
54 */
55 String getId();
56 }