Package org.apache.pulsar.broker.web

Class WebService

java.lang.Object

org.apache.pulsar.broker.web.WebService

All Implemented Interfaces:

AutoCloseable

public class WebService
extends Object
implements AutoCloseable

Web Service embedded into Pulsar.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_PULSAR_NAME
static final String	HANDLER_CACHE_CONTROL

Constructor Summary

Constructors

Constructor	Description
WebService(PulsarService pulsar)

Method Summary

Modifier and Type	Method	Description
void	addRestResource(String basePath, boolean requiresAuthentication, Map<String,Object> attributeMap, boolean useSharedJsonMapperProvider, Class<?>... resourceClasses)
void	addRestResources(String basePath, boolean requiresAuthentication, Map<String,Object> attributeMap, boolean useSharedJsonMapperProvider, String... javaPackages)
void	addServlet(String path, org.eclipse.jetty.servlet.ServletHolder servletHolder, boolean requiresAuthentication, Map<String,Object> attributeMap)
void	addStaticResources(String basePath, String resourcePath)
void	close()
Optional<Integer>	getListenPortHTTP()
Optional<Integer>	getListenPortHTTPS()
void	start()
void	updateHttpRequestsFailOnUnknownPropertiesEnabled(boolean httpRequestsFailOnUnknownPropertiesEnabled)

Methods inherited from class java.lang.Object

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

Field Details

ATTRIBUTE_PULSAR_NAME

public static final String ATTRIBUTE_PULSAR_NAME

See Also:

• Constant Field Values

HANDLER_CACHE_CONTROL

public static final String HANDLER_CACHE_CONTROL

See Also:

• Constant Field Values

Constructor Details

WebService

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

Throws:

org.apache.pulsar.broker.PulsarServerException

Method Details

updateHttpRequestsFailOnUnknownPropertiesEnabled

public void updateHttpRequestsFailOnUnknownPropertiesEnabled(boolean httpRequestsFailOnUnknownPropertiesEnabled)

addRestResources

public void addRestResources(String basePath,
 boolean requiresAuthentication,
 Map<String,Object> attributeMap,
 boolean useSharedJsonMapperProvider,
 String... javaPackages)

addRestResource

public void addRestResource(String basePath,
 boolean requiresAuthentication,
 Map<String,Object> attributeMap,
 boolean useSharedJsonMapperProvider,
 Class<?>... resourceClasses)

addServlet

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

addStaticResources

public void addStaticResources(String basePath,
 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 AutoCloseable

Throws:

org.apache.pulsar.broker.PulsarServerException

getListenPortHTTP

public Optional<Integer> getListenPortHTTP()

getListenPortHTTPS

public Optional<Integer> getListenPortHTTPS()