blob: 63e0c3fa3c4baaeb5764720cf72cd413f572df1a [file] [log] [blame]
Jian Lib9fe3492018-06-07 17:19:07 +09001/*
2 * Copyright 2018-present Open Networking Foundation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16package org.onosproject.openstacktelemetry.api;
17
Jian Lib9fe3492018-06-07 17:19:07 +090018/**
19 * Admin service API for publishing openstack telemetry.
20 */
Jian Lid1ce10a2018-06-12 13:47:23 +090021public interface TelemetryAdminService extends TelemetryService {
Jian Lib9fe3492018-06-07 17:19:07 +090022
23 /**
24 * Prepares and launches the telemetry producer.
Jian Lia61e0b62018-12-28 19:10:10 +090025 *
26 * @param name telemetry service name
Jian Lib9fe3492018-06-07 17:19:07 +090027 */
Jian Lia61e0b62018-12-28 19:10:10 +090028 void start(String name);
Jian Lib9fe3492018-06-07 17:19:07 +090029
30 /**
31 * Terminates the telemetry producer.
Jian Lia61e0b62018-12-28 19:10:10 +090032 *
33 * @param name telemetry service name
Jian Lib9fe3492018-06-07 17:19:07 +090034 */
Jian Lia61e0b62018-12-28 19:10:10 +090035 void stop(String name);
Jian Lib9fe3492018-06-07 17:19:07 +090036
37 /**
38 * Restarts the telemetry producer.
Jian Lia61e0b62018-12-28 19:10:10 +090039 *
40 * @param name telemetry service name
Jian Lib9fe3492018-06-07 17:19:07 +090041 */
Jian Lia61e0b62018-12-28 19:10:10 +090042 void restart(String name);
43
44 /**
45 * Launches all telemetry services.
46 */
47 void startAll();
48
49 /**
50 * Terminates all telemetry services.
51 */
52 void stopAll();
53
54 /**
55 * Restarts all telemetry services.
56 */
57 void restartAll();
Jian Lib9fe3492018-06-07 17:19:07 +090058}