aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/apps/test/demo/src/main/java/org/onosproject/demo/DemoApi.java
blob: 1e5941573e6472b201c853b2e86e95fe01ab1d5e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
/*
 * Copyright 2014-2015 Open Networking Laboratory
 *
 * Licensed 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.onosproject.demo;

import com.fasterxml.jackson.databind.JsonNode;

import java.util.Optional;

/**
 * Simple demo api interface.
 */
public interface DemoApi {

    enum InstallType { MESH, RANDOM }

    /**
     * Tests flow subsystem based on the parameters supplied.
     *
     * @param params the test parameters
     * @return JSON representation
     */
    JsonNode flowTest(Optional<JsonNode> params);

    /**
     * Installs intents based on the installation type.
     * @param type the installation type.
     * @param runParams run params
     */
    void setup(InstallType type, Optional<JsonNode> runParams);

    /**
     * Uninstalls all existing intents.
     */
    void tearDown();

}