Package org.apache.pulsar.broker.web

Class WebService

  • All Implemented Interfaces:
    java.lang.AutoCloseable
    public class WebService
extends java.lang.Object
implements java.lang.AutoCloseable
    Web Service embedded into Pulsar.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addRestResources​(java.lang.String basePath, java.lang.String javaPackages, boolean requiresAuthentication, java.util.Map<java.lang.String,​java.lang.Object> attributeMap)  
      void addServlet​(java.lang.String path, org.eclipse.jetty.servlet.ServletHolder servletHolder, boolean requiresAuthentication, java.util.Map<java.lang.String,​java.lang.Object> attributeMap)  
      void addStaticResources​(java.lang.String basePath, java.lang.String resourcePath)  
      void close()  
      java.util.Optional<java.lang.Integer> getListenPortHTTP()  
      java.util.Optional<java.lang.Integer> getListenPortHTTPS()  
      void start()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • ATTRIBUTE_PULSAR_NAME

        public static final java.lang.String ATTRIBUTE_PULSAR_NAME
        See Also:
        Constant Field Values

      • HANDLER_CACHE_CONTROL

        public static final java.lang.String HANDLER_CACHE_CONTROL
        See Also:
        Constant Field Values

      • maxConcurrentRequests

        public final int maxConcurrentRequests

    • Constructor Detail

      • WebService

        public WebService​(PulsarService pulsar)
           throws org.apache.pulsar.broker.PulsarServerException
        Throws:
        org.apache.pulsar.broker.PulsarServerException

    • Method Detail

      • addRestResources

        public void addRestResources​(java.lang.String basePath,
                             java.lang.String javaPackages,
                             boolean requiresAuthentication,
                             java.util.Map<java.lang.String,​java.lang.Object> attributeMap)

      • addServlet

        public void addServlet​(java.lang.String path,
                       org.eclipse.jetty.servlet.ServletHolder servletHolder,
                       boolean requiresAuthentication,
                       java.util.Map<java.lang.String,​java.lang.Object> attributeMap)

      • addStaticResources

        public void addStaticResources​(java.lang.String basePath,
                               java.lang.String resourcePath)

      • start

        public void start()
           throws org.apache.pulsar.broker.PulsarServerException
        Throws:
        org.apache.pulsar.broker.PulsarServerException

      • close

        public void close()
           throws org.apache.pulsar.broker.PulsarServerException
        Specified by:
        close in interface java.lang.AutoCloseable
        Throws:
        org.apache.pulsar.broker.PulsarServerException

      • getListenPortHTTP

        public java.util.Optional<java.lang.Integer> getListenPortHTTP()

      • getListenPortHTTPS

        public java.util.Optional<java.lang.Integer> getListenPortHTTPS()