Package org.apache.pulsar.broker.web.plugin.servlet

Class AdditionalServletUtils

java.lang.Object

org.apache.pulsar.broker.web.plugin.servlet.AdditionalServletUtils

public class AdditionalServletUtils
extends java.lang.Object

Util class to search and load AdditionalServlets.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ADDITIONAL_SERVLET_FILE

Constructor Summary

Constructors

Constructor	Description
AdditionalServletUtils()

Method Summary

Modifier and Type	Method	Description
AdditionalServletDefinition	getAdditionalServletDefinition(java.lang.String narPath, java.lang.String narExtractionDirectory)	Retrieve the additional servlet definition from the provided nar package.
AdditionalServletWithClassLoader	load(AdditionalServletMetadata metadata, java.lang.String narExtractionDirectory)	Load the additional servlets according to the additional servlet definition.
AdditionalServletDefinitions	searchForServlets(java.lang.String additionalServletDirectory, java.lang.String narExtractionDirectory)	Search and load the available additional servlets.

Methods inherited from class java.lang.Object

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

Field Detail

ADDITIONAL_SERVLET_FILE

public static final java.lang.String ADDITIONAL_SERVLET_FILE

See Also:

Constant Field Values

Constructor Detail

AdditionalServletUtils

public AdditionalServletUtils()

Method Detail

getAdditionalServletDefinition

public AdditionalServletDefinition getAdditionalServletDefinition(java.lang.String narPath,
                                                                  java.lang.String narExtractionDirectory)
                                                           throws java.io.IOException

Retrieve the additional servlet definition from the provided nar package.

Parameters:

narPath - the path to the additional servlet NAR package

Returns:

the additional servlet definition

Throws:

java.io.IOException - when fail to load the additional servlet or get the definition

searchForServlets

public AdditionalServletDefinitions searchForServlets(java.lang.String additionalServletDirectory,
                                                      java.lang.String narExtractionDirectory)
                                               throws java.io.IOException

Search and load the available additional servlets.

Parameters:

additionalServletDirectory - the directory where all the additional servlets are stored

Returns:

a collection of additional servlet definitions

Throws:

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

load

public AdditionalServletWithClassLoader load(AdditionalServletMetadata metadata,
                                             java.lang.String narExtractionDirectory)
                                      throws java.io.IOException

Load the additional servlets according to the additional servlet definition.

Parameters:

metadata - the additional servlet definition.

Throws:

java.io.IOException