restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/spi/HttpGetResource.java

   1 /*
   2  * Copyright (c) 2024 PANTHEON.tech, s.r.o. 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.restconf.server.spi;
   9
  10 import org.eclipse.jdt.annotation.NonNullByDefault;
  11 import org.opendaylight.restconf.api.ApiPath;
  12 import org.opendaylight.restconf.api.FormattableBody;
  13 import org.opendaylight.restconf.common.errors.RestconfFuture;
  14 import org.opendaylight.restconf.server.api.ServerRequest;
  15
  16 /**
  17  * A resource which supports HTTP GET and produces a {@link FormattableBody}.
  18  */
  19 @NonNullByDefault
  20 public interface HttpGetResource {
  21
  22     RestconfFuture<FormattableBody> httpGET(ServerRequest request);
  23
  24     RestconfFuture<FormattableBody> httpGET(ServerRequest request, ApiPath apiPath);
  25 }