GNPy client refactor
[transportpce.git] / pce / src / main / java / org / opendaylight / transportpce / pce / gnpy / consumer / GnpyConsumer.java
1 /*
2  * Copyright © 2021 Orange, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.transportpce.pce.gnpy.consumer;
9
10 import org.opendaylight.yang.gen.v1.gnpy.gnpy.api.rev190103.GnpyApi;
11 import org.opendaylight.yang.gen.v1.gnpy.path.rev200909.Result;
12
13 public interface GnpyConsumer {
14
15     /**
16      * Check if api is available or not.
17      * @return true os available, false otherwise.
18      */
19     boolean isAvailable();
20
21     /**
22      * Path computation request.
23      * @param request GnpyApi.
24      * @return Result the result of pat computation.
25      */
26     Result computePaths(GnpyApi request);
27
28 }