Package org.opencastproject.runtimeinfo

Class RestDocsServlet

java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
org.opencastproject.runtimeinfo.RestDocsServlet
All Implemented Interfaces:
Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
public class RestDocsServlet extends javax.servlet.http.HttpServlet
A bundle activator that registers the REST documentation servlet.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.osgi.framework.BundleContext
    bundleContext
    The OSGI bundle context
    static final String
    SERVLET_PATH
    The servlet path

  • Constructor Summary

    Constructors
    Constructor
    Description
    RestDocsServlet()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
     
    static org.opencastproject.util.data.Option<org.opencastproject.util.doc.rest.RestService>
    findRestAnnotation(Class<?> endpointClass)
    Try to find the RestService annotation starting at endpointClass.
    void
    start(org.osgi.framework.BundleContext bundleContext)
     
    void
    stop(org.osgi.framework.BundleContext bundleContext)
     

    Methods inherited from class javax.servlet.http.HttpServlet

    doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

    Methods inherited from class javax.servlet.GenericServlet

    destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • SERVLET_PATH

      public static final String SERVLET_PATH
      The servlet path
      See Also:

    • bundleContext

      protected org.osgi.framework.BundleContext bundleContext
      The OSGI bundle context

  • Constructor Details

    • RestDocsServlet

      public RestDocsServlet()

  • Method Details

    • start

      public void start(org.osgi.framework.BundleContext bundleContext) throws Exception
      Throws:
      Exception

    • stop

      public void stop(org.osgi.framework.BundleContext bundleContext) throws Exception
      Throws:
      Exception

    • doGet

      protected void doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) throws javax.servlet.ServletException, IOException
      Overrides:
      doGet in class javax.servlet.http.HttpServlet
      Throws:
      javax.servlet.ServletException
      IOException

    • findRestAnnotation

      public static org.opencastproject.util.data.Option<org.opencastproject.util.doc.rest.RestService> findRestAnnotation(Class<?> endpointClass)
      Try to find the RestService annotation starting at endpointClass.