org.apache.pulsar.proxy.server.plugin.servlet

Class ProxyAdditionalServletUtils

java.lang.Object

org.apache.pulsar.proxy.server.plugin.servlet.ProxyAdditionalServletUtils

public class ProxyAdditionalServletUtils
extends Object

Util class to search and load ProxyAdditionalServlets.

Field Summary

Fields

Modifier and Type	Field and Description
String	PROXY_ADDITIONAL_SERVLET_FILE

Constructor Summary

Constructors

Constructor and Description
ProxyAdditionalServletUtils()

Method Summary

Modifier and Type	Method and Description
ProxyAdditionalServletDefinition	getProxyAdditionalServletDefinition(String narPath, String narExtractionDirectory) Retrieve the proxy additional servlet definition from the provided nar package.
ProxyAdditionalServletWithClassLoader	load(ProxyAdditionalServletMetadata metadata, String narExtractionDirectory) Load the proxy additional servlets according to the additional servlet definition.
ProxyAdditionalServletDefinitions	searchForServlets(String additionalServletDirectory, String narExtractionDirectory) Search and load the available proxy additional servlets.

Methods inherited from class java.lang.Object

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

Field Detail

PROXY_ADDITIONAL_SERVLET_FILE

public final String PROXY_ADDITIONAL_SERVLET_FILE

See Also:

Constant Field Values

Constructor Detail

ProxyAdditionalServletUtils

public ProxyAdditionalServletUtils()

Method Detail

getProxyAdditionalServletDefinition

public ProxyAdditionalServletDefinition getProxyAdditionalServletDefinition(String narPath,
                                                                            String narExtractionDirectory)
                                                                     throws IOException

Retrieve the proxy additional servlet definition from the provided nar package.

Parameters:

narPath - the path to the proxy additional servlet NAR package

Returns:

the proxy additional servlet definition

Throws:

IOException - when fail to load the proxy additional servlet or get the definition

searchForServlets

public ProxyAdditionalServletDefinitions searchForServlets(String additionalServletDirectory,
                                                           String narExtractionDirectory)
                                                    throws IOException

Search and load the available proxy additional servlets.

Parameters:

additionalServletDirectory - the directory where all the proxy additional servlets are stored

Returns:

a collection of proxy additional servlet definitions

Throws:

IOException - when fail to load the available proxy additional servlets from the provided directory.

load

public ProxyAdditionalServletWithClassLoader load(ProxyAdditionalServletMetadata metadata,
                                                  String narExtractionDirectory)
                                           throws IOException

Load the proxy additional servlets according to the additional servlet definition.

Parameters:

metadata - the proxy additional servlet definition.

Throws:

IOException