Index (Atlassian Plugins - Web Resource Common 9.1.0 API)

A C D E F G I L M P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractFileServerServlet - Class in com.atlassian.plugin.servlet
AbstractFileServerServlet() - Constructor for class com.atlassian.plugin.servlet.AbstractFileServerServlet
accept(T) - Method in interface com.atlassian.plugin.servlet.util.function.FailableConsumer: Performs this operation on the given argument.
addCachingHeaders(HttpServletRequest, HttpServletResponse, String...) - Static method in class com.atlassian.plugin.servlet.ResourceDownloadUtils: Set 'expire' headers to cache for one year.
addPrivateCachingHeaders(HttpServletRequest, HttpServletResponse) - Static method in class com.atlassian.plugin.servlet.ResourceDownloadUtils: Sets caching headers with private cache control.
addPublicCachingHeaders(HttpServletRequest, HttpServletResponse) - Static method in class com.atlassian.plugin.servlet.ResourceDownloadUtils: Sets caching headers with public cache control.

C

CacheableRequest - Class in com.atlassian.plugin.servlet.cache.model: Represents a caching information for a current HttpServletRequest headers and the HttpServletResponse response body.
CacheableRequest(HttpServletRequest) - Constructor for class com.atlassian.plugin.servlet.cache.model.CacheableRequest
CacheableResponse - Class in com.atlassian.plugin.servlet.cache.model: Represents a HttpServletResponseWrapper responsible for exposing the content of a HttpServletResponse as ETagToken.
CacheableResponse(HttpServletResponse) - Constructor for class com.atlassian.plugin.servlet.cache.model.CacheableResponse
checkRequest(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.util.LastModifiedHandler: Deprecated.
This method performs two operations, which is setting the response headers and checking the cache headers.
In the future the method LastModifiedHandler.isNotCacheableResponse(HttpServletRequest) should be used for the check.

In the future the method LastModifiedHandler.setCacheHeadersIfCacheable(HttpServletRequest, HttpServletResponse) should be used to defined the response headers.
checkRequest(HttpServletRequest, HttpServletResponse, Date) - Static method in class com.atlassian.plugin.servlet.util.LastModifiedHandler: Deprecated.
In the future the method LastModifiedHandler.isNotCacheableResponse(HttpServletRequest) should be used for the check for a better naming convention.
close() - Method in class com.atlassian.plugin.servlet.cache.model.CacheableResponse
com.atlassian.plugin.servlet - package com.atlassian.plugin.servlet
com.atlassian.plugin.servlet.cache.filter - package com.atlassian.plugin.servlet.cache.filter
com.atlassian.plugin.servlet.cache.model - package com.atlassian.plugin.servlet.cache.model
com.atlassian.plugin.servlet.download.plugin - package com.atlassian.plugin.servlet.download.plugin
com.atlassian.plugin.servlet.util - package com.atlassian.plugin.servlet.util
com.atlassian.plugin.servlet.util.date - package com.atlassian.plugin.servlet.util.date
com.atlassian.plugin.servlet.util.function - package com.atlassian.plugin.servlet.util.function
ContentTypeResolver - Interface in com.atlassian.plugin.servlet: Looks up content types for URL paths in an application-specific way.

D

DateUtil - Class in com.atlassian.plugin.servlet.util.date: Class responsible for handling processes related to dates.
defaultIfNull(Date, LocalDateTime) - Static method in class com.atlassian.plugin.servlet.util.date.DateUtil: Converts a certain Date to LocalDate.
destroy() - Method in class com.atlassian.plugin.servlet.cache.filter.ETagCachingFilter
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class com.atlassian.plugin.servlet.cache.filter.ETagCachingFilter
doGet(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.AbstractFileServerServlet
DownloadableClasspathResource - Class in com.atlassian.plugin.servlet: A DownloadableResource that will serve the resource from the plugin.
DownloadableClasspathResource(Plugin, ResourceLocation, String) - Constructor for class com.atlassian.plugin.servlet.DownloadableClasspathResource
DownloadableResource - Interface in com.atlassian.plugin.servlet: Represents a plugin resource that can be downloaded.
DownloadableWebResource - Class in com.atlassian.plugin.servlet: A DownloadableResource that will serve the resource via the web application's ServletContext.
DownloadableWebResource(Plugin, ResourceLocation, String, ServletContext, boolean) - Constructor for class com.atlassian.plugin.servlet.DownloadableWebResource
DownloadException - Exception Class in com.atlassian.plugin.servlet: An exception was encountered while trying to write a resource to the client.
DownloadException(Exception) - Constructor for exception class com.atlassian.plugin.servlet.DownloadException
DownloadException(String) - Constructor for exception class com.atlassian.plugin.servlet.DownloadException
DownloadException(String, Exception) - Constructor for exception class com.atlassian.plugin.servlet.DownloadException
DownloadStrategy - Interface in com.atlassian.plugin.servlet
DownloadStrategyModuleDescriptor - Class in com.atlassian.plugin.servlet.download.plugin: A plugin module which provides a DownloadStrategy.
DownloadStrategyModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.plugin.servlet.download.plugin.DownloadStrategyModuleDescriptor: Creates a download strategy.

E

EmptyDownloadableResource - Class in com.atlassian.plugin.servlet: A DownloadableResource with no content
EmptyDownloadableResource(Plugin, ResourceLocation) - Constructor for class com.atlassian.plugin.servlet.EmptyDownloadableResource
ETagCachingFilter - Class in com.atlassian.plugin.servlet.cache.filter: Filter responsible for performing caching of resources.
ETagCachingFilter() - Constructor for class com.atlassian.plugin.servlet.cache.filter.ETagCachingFilter
ETagToken - Class in com.atlassian.plugin.servlet.cache.model: Represents an ETag to be used to verify the content of an HttpServletResponse body.
ETagToken(byte[]) - Constructor for class com.atlassian.plugin.servlet.cache.model.ETagToken: Build a certain ETag token based on a HttpServletResponse body and Base64.
extraPath - Variable in class com.atlassian.plugin.servlet.DownloadableClasspathResource
extraPath - Variable in class com.atlassian.plugin.servlet.DownloadableWebResource
extraPath - Variable in class com.atlassian.plugin.servlet.EmptyDownloadableResource

F

FailableConsumer<T,E> - Interface in com.atlassian.plugin.servlet.util.function: Represents a consumer of arguments which can throw exceptions.
FailableSupplier<T,E> - Interface in com.atlassian.plugin.servlet.util.function: Represents a supplier of results which can throw exceptions.
flushBuffer() - Method in class com.atlassian.plugin.servlet.cache.model.CacheableResponse
flushResponse() - Method in class com.atlassian.plugin.servlet.cache.model.CacheableResponse: Flushes the content to the original-wrapped response.
ForwardableResource - Class in com.atlassian.plugin.servlet: A DownloadableResource that simply forwards the request to the given location.
ForwardableResource(ResourceLocation) - Constructor for class com.atlassian.plugin.servlet.ForwardableResource

G

get() - Method in interface com.atlassian.plugin.servlet.util.function.FailableSupplier: Gets a result.
getContentBody() - Method in class com.atlassian.plugin.servlet.cache.model.CacheableResponse: Get the current response body.
getContentType() - Method in class com.atlassian.plugin.servlet.DownloadableClasspathResource
getContentType() - Method in class com.atlassian.plugin.servlet.DownloadableWebResource
getContentType() - Method in class com.atlassian.plugin.servlet.EmptyDownloadableResource
getContentType() - Method in interface com.atlassian.plugin.servlet.DownloadableResource: Returns the content type for the resource.
getContentType() - Method in class com.atlassian.plugin.servlet.ForwardableResource
getContentType(String) - Method in interface com.atlassian.plugin.servlet.ContentTypeResolver: Returns the content type for the given resource path.
getDoubleQuotedValue() - Method in class com.atlassian.plugin.servlet.cache.model.ETagToken: Entity tag uniquely representing the requested resource.
getDownloadStrategies() - Method in class com.atlassian.plugin.servlet.AbstractFileServerServlet: Returns a list of DownloadStrategy objects in the order that they will be matched against.
getIfNoneMatchHeader() - Method in class com.atlassian.plugin.servlet.cache.model.CacheableRequest
getLocation() - Method in class com.atlassian.plugin.servlet.DownloadableClasspathResource: This is called to return the location of the resource that this object represents.
getLocation() - Method in class com.atlassian.plugin.servlet.DownloadableWebResource: This is called to return the location of the resource that this object represents.
getLocation() - Method in class com.atlassian.plugin.servlet.EmptyDownloadableResource: This is called to return the location of the resource that this object represents.
getLocation() - Method in class com.atlassian.plugin.servlet.ForwardableResource
getModule() - Method in class com.atlassian.plugin.servlet.download.plugin.DownloadStrategyModuleDescriptor
getOutputStream() - Method in class com.atlassian.plugin.servlet.cache.model.CacheableResponse
getResourceAsStream(String) - Method in class com.atlassian.plugin.servlet.DownloadableClasspathResource
getResourceAsStream(String) - Method in class com.atlassian.plugin.servlet.DownloadableWebResource
getResourceAsStream(String) - Method in class com.atlassian.plugin.servlet.EmptyDownloadableResource
getResourceLocation() - Method in class com.atlassian.plugin.servlet.DownloadableClasspathResource
getServletContext() - Method in interface com.atlassian.plugin.servlet.ServletContextFactory
getValue() - Method in class com.atlassian.plugin.servlet.cache.model.ETagToken
getWriter() - Method in class com.atlassian.plugin.servlet.cache.model.CacheableResponse

I

init(FilterConfig) - Method in class com.atlassian.plugin.servlet.cache.filter.ETagCachingFilter
isCacheable(CacheableRequest) - Method in class com.atlassian.plugin.servlet.cache.model.CacheableResponse
isCacheable(CacheableResponse) - Method in class com.atlassian.plugin.servlet.cache.model.CacheableRequest
isCacheable(LocalDateTime) - Method in class com.atlassian.plugin.servlet.cache.model.CacheableRequest
isNotCacheableResponse(HttpServletRequest) - Method in class com.atlassian.plugin.servlet.util.LastModifiedHandler: Verifies whether the current response is cacheable or not, based on the HttpServletRequest and LastModifiedHandler.isCacheEnabled().
isResourceModified(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.DownloadableClasspathResource: Checks any "If-Modified-Since" header from the request against the plugin's loading time, since plugins can't be modified after they've been loaded this is a good way to determine if a plugin resource has been modified or not.
isResourceModified(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.DownloadableWebResource: Checks any "If-Modified-Since" header from the request against the plugin's loading time, since plugins can't be modified after they've been loaded this is a good way to determine if a plugin resource has been modified or not.
isResourceModified(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.EmptyDownloadableResource: Checks any "If-Modified-Since" header from the request against the plugin's loading time, since plugins can't be modified after they've been loaded this is a good way to determine if a plugin resource has been modified or not.
isResourceModified(HttpServletRequest, HttpServletResponse) - Method in interface com.atlassian.plugin.servlet.DownloadableResource: Returns true if the plugin resource has been modified.
isResourceModified(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.ForwardableResource

L

LastModifiedHandler - Class in com.atlassian.plugin.servlet.util: This class manages the last modified date of a single HTTP resource.
LastModifiedHandler() - Constructor for class com.atlassian.plugin.servlet.util.LastModifiedHandler
LastModifiedHandler(LocalDateTime) - Constructor for class com.atlassian.plugin.servlet.util.LastModifiedHandler
LastModifiedHandler(Date) - Constructor for class com.atlassian.plugin.servlet.util.LastModifiedHandler
localDateTimeOf(Date) - Static method in class com.atlassian.plugin.servlet.util.date.DateUtil: Converts a certain Date to LocalDate and filter negative dates.

M

matches(String) - Method in class com.atlassian.plugin.servlet.download.plugin.PluggableDownloadStrategy
matches(String) - Method in interface com.atlassian.plugin.servlet.DownloadStrategy: Returns true if the DownloadStrategy is supported for the given url path.
modified() - Method in class com.atlassian.plugin.servlet.util.LastModifiedHandler: The content has changed, reset the modified date.

P

PATH_SEPARATOR - Static variable in class com.atlassian.plugin.servlet.AbstractFileServerServlet
PluggableDownloadStrategy - Class in com.atlassian.plugin.servlet.download.plugin: A download strategy which maintains a list of DownloadStrategyModuleDescriptors and delegates to them in order.
PluggableDownloadStrategy(PluginEventManager) - Constructor for class com.atlassian.plugin.servlet.download.plugin.PluggableDownloadStrategy
plugin - Variable in class com.atlassian.plugin.servlet.DownloadableClasspathResource
plugin - Variable in class com.atlassian.plugin.servlet.DownloadableWebResource
plugin - Variable in class com.atlassian.plugin.servlet.EmptyDownloadableResource
pluginModuleDisabled(PluginModuleDisabledEvent) - Method in class com.atlassian.plugin.servlet.download.plugin.PluggableDownloadStrategy
pluginModuleEnabled(PluginModuleEnabledEvent) - Method in class com.atlassian.plugin.servlet.download.plugin.PluggableDownloadStrategy

R

register(String, DownloadStrategy) - Method in class com.atlassian.plugin.servlet.download.plugin.PluggableDownloadStrategy
RESOURCE_URL_PREFIX - Static variable in class com.atlassian.plugin.servlet.AbstractFileServerServlet
ResourceDownloadUtils - Class in com.atlassian.plugin.servlet
ResourceDownloadUtils() - Constructor for class com.atlassian.plugin.servlet.ResourceDownloadUtils
resourceLocation - Variable in class com.atlassian.plugin.servlet.DownloadableClasspathResource
resourceLocation - Variable in class com.atlassian.plugin.servlet.DownloadableWebResource
resourceLocation - Variable in class com.atlassian.plugin.servlet.EmptyDownloadableResource

S

serveFile(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.download.plugin.PluggableDownloadStrategy
serveFile(HttpServletRequest, HttpServletResponse) - Method in interface com.atlassian.plugin.servlet.DownloadStrategy: Serves the file for the given request and response.
serveResource(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.DownloadableClasspathResource
serveResource(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.DownloadableWebResource
serveResource(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.EmptyDownloadableResource
serveResource(HttpServletRequest, HttpServletResponse) - Method in interface com.atlassian.plugin.servlet.DownloadableResource: Writes the resource content out into the response.
serveResource(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.ForwardableResource
SERVLET_PATH - Static variable in class com.atlassian.plugin.servlet.AbstractFileServerServlet
ServletContextFactory - Interface in com.atlassian.plugin.servlet: A factory for providing access to a ServletContext.
setCacheHeadersIfCacheable(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.util.LastModifiedHandler: Defines the caching headers for the current HttpServletResponse if it is a LastModifiedHandler.isNotCacheableResponse(jakarta.servlet.http.HttpServletRequest).
setCacheHeadersIfCacheable(HttpServletRequest, HttpServletResponse, LocalDateTime) - Static method in class com.atlassian.plugin.servlet.util.LastModifiedHandler
setETagHeader() - Method in class com.atlassian.plugin.servlet.cache.model.CacheableResponse: Defines the current HttpHeaders.ETAG header based on the response body content.
setPluginLastModifiedDate(LocalDateTime) - Method in class com.atlassian.plugin.servlet.cache.model.CacheableRequest
streamResource(OutputStream) - Method in class com.atlassian.plugin.servlet.DownloadableClasspathResource
streamResource(OutputStream) - Method in class com.atlassian.plugin.servlet.DownloadableWebResource
streamResource(OutputStream) - Method in class com.atlassian.plugin.servlet.EmptyDownloadableResource
streamResource(OutputStream) - Method in interface com.atlassian.plugin.servlet.DownloadableResource: Write the resource to the supplied OutputStream.
streamResource(OutputStream) - Method in class com.atlassian.plugin.servlet.ForwardableResource: Not implemented by a ForwardableResource.

T

toETagToken() - Method in class com.atlassian.plugin.servlet.cache.model.CacheableResponse: Get the representation of the current response body as ETagToken.
toString() - Method in class com.atlassian.plugin.servlet.DownloadableClasspathResource
toString() - Method in class com.atlassian.plugin.servlet.DownloadableWebResource
toString() - Method in class com.atlassian.plugin.servlet.EmptyDownloadableResource
toString() - Method in class com.atlassian.plugin.servlet.ForwardableResource

U

unregister(String) - Method in class com.atlassian.plugin.servlet.download.plugin.PluggableDownloadStrategy

W

wrapper(FailableConsumer<T, E>) - Static method in interface com.atlassian.plugin.servlet.util.function.FailableConsumer: Wrapper responsible for converting a certain FailableConsumer into a Consumer.
wrapper(FailableSupplier<T, E>) - Static method in interface com.atlassian.plugin.servlet.util.function.FailableSupplier: Wrapper responsible for converting a certain FailableSupplier into a Supplier.

A C D E F G I L M P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form