restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/streams/RestconfStreamServletFactory.java

   1 /*
   2  * Copyright (c) 2023 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.nb.rfc8040.streams;
   9
  10 import javax.servlet.http.HttpServlet;
  11 import org.eclipse.jdt.annotation.NonNullByDefault;
  12 import org.opendaylight.restconf.api.query.PrettyPrintParam;
  13 import org.opendaylight.restconf.nb.rfc8040.ErrorTagMapping;
  14 import org.opendaylight.restconf.server.spi.RestconfStream;
  15
  16 /**
  17  * A helper for creating {@link HttpServlet}s which provide bridge between JAX-RS and {@link RestconfStream.Registry}.
  18  *
  19  * @deprecated This interface exists only to support SSE/Websocket delivery. It will be removed when support for
  20  *             WebSockets is removed.
  21  */
  22 @NonNullByDefault
  23 @Deprecated(since = "7.0.0", forRemoval = true)
  24 public interface RestconfStreamServletFactory {
  25     /**
  26      * Return the value of {@code {+restconf}} macro. May be empty, guaranteed to not end with {@code /}.
  27      *
  28      * @return the value of {@code {+restconf}} macro
  29      */
  30     String restconf();
  31
  32     HttpServlet newStreamServlet();
  33
  34     PrettyPrintParam prettyPrint();
  35
  36     ErrorTagMapping errorTagMapping();
  37 }