A B C D E F G H I L M P R S T U W

A

AbstractFileServerServlet - Class in com.atlassian.plugin.servlet

AbstractFileServerServlet() - Constructor for class com.atlassian.plugin.servlet.AbstractFileServerServlet

add(DownloadableResource) - Method in class com.atlassian.plugin.webresource.BatchPluginResource

addCachingHeaders(HttpServletResponse, String...) - Static method in class com.atlassian.plugin.servlet.ResourceDownloadUtils

Set 'expire' headers to cache for ten years.

addCachingHeaders(HttpServletRequest, HttpServletResponse) - Static method in class com.atlassian.plugin.servlet.ResourceDownloadUtils

Deprecated. Please use ResourceDownloadUtils.addPublicCachingHeaders(HttpServletRequest, HttpServletResponse) or ResourceDownloadUtils.addPrivateCachingHeaders(HttpServletRequest, HttpServletResponse) instead.

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.

B

BatchPluginResource - Class in com.atlassian.plugin.webresource

Represents a batch of plugin resources.

BatchPluginResource(String, String, Map<String, String>) - Constructor for class com.atlassian.plugin.webresource.BatchPluginResource

A constructor that creates a default resource name for the batch in the format: moduleCompleteKey.type For example: test.plugin:resources.js

Note that name of the batch does not identify what the batch includes and could have been static e.g.

C

checkRequest(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.util.LastModifiedHandler

Check whether we need to generate a response for this request.

checkRequest(HttpServletRequest, HttpServletResponse, Date) - Static method in class com.atlassian.plugin.servlet.util.LastModifiedHandler

This static method is used when the resource being served by the servlet keeps track of the last modified date, and so no state needs to be maintained by this handler.

com.atlassian.plugin.servlet - package com.atlassian.plugin.servlet

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.util - package com.atlassian.plugin.util

com.atlassian.plugin.webresource - package com.atlassian.plugin.webresource

ContentTypeResolver - Interface in com.atlassian.plugin.servlet

Looks up content types for URL paths in an application-specific way.

D

DELAYED_INCLUDE_MODE - Static variable in interface com.atlassian.plugin.webresource.WebResourceManager

Deprecated. Since 2.2. Use #writeResourceTags(String, Writer) instead.

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) - Constructor for class com.atlassian.plugin.servlet.DownloadableWebResource

DownloadException - Exception in com.atlassian.plugin.servlet

DownloadException() - Constructor for exception com.atlassian.plugin.servlet.DownloadException

DownloadException(String) - Constructor for exception com.atlassian.plugin.servlet.DownloadException

DownloadException(String, Throwable) - Constructor for exception com.atlassian.plugin.servlet.DownloadException

DownloadException(Throwable) - Constructor for exception 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(HostContainer) - Constructor for class com.atlassian.plugin.servlet.download.plugin.DownloadStrategyModuleDescriptor

E

equals(Object) - Method in class com.atlassian.plugin.webresource.BatchPluginResource

F

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

getBaseUrl() - Method in interface com.atlassian.plugin.webresource.WebResourceIntegration

This should be the 'short' contextPath for the system.

getContentType(String) - Method in interface com.atlassian.plugin.servlet.ContentTypeResolver

Returns the content type for the given resource path.

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() - Method in class com.atlassian.plugin.webresource.BatchPluginResource

getDependencies() - Method in class com.atlassian.plugin.webresource.WebResourceModuleDescriptor

Returns a list of dependencies on other web resources.

getDownloadableResource(String, Map<String, String>) - Method in interface com.atlassian.plugin.webresource.PluginResourceLocator

Returns a DownloadableResource represented by the given url and query params.

getDownloadableResource(String, Map<String, String>) - Method in class com.atlassian.plugin.webresource.PluginResourceLocatorImpl

getDownloadStrategies() - Method in class com.atlassian.plugin.servlet.AbstractFileServerServlet

Returns a list of DownloadStrategy objects in the order that they will be matched against.

getLocation() - Method in class com.atlassian.plugin.servlet.ForwardableResource

getModeName() - Method in interface com.atlassian.plugin.webresource.WebResourceManager.IncludeMode

Deprecated.

getModule() - Method in class com.atlassian.plugin.servlet.download.plugin.DownloadStrategyModuleDescriptor

getModule() - Method in class com.atlassian.plugin.webresource.WebResourceModuleDescriptor

As this descriptor just handles resources, you should never call this

getModuleCompleteKey() - Method in class com.atlassian.plugin.webresource.BatchPluginResource

getModuleCompleteKey() - Method in interface com.atlassian.plugin.webresource.PluginResource

getModuleCompleteKey() - Method in class com.atlassian.plugin.webresource.SinglePluginResource

getParams() - Method in class com.atlassian.plugin.webresource.BatchPluginResource

getParams() - Method in interface com.atlassian.plugin.webresource.PluginResource

getParams() - Method in class com.atlassian.plugin.webresource.SinglePluginResource

getPluginAccessor() - Method in interface com.atlassian.plugin.webresource.WebResourceIntegration

Applications must implement this method to get access to the application's PluginAccessor

getPluginResources(String) - Method in interface com.atlassian.plugin.webresource.PluginResourceLocator

Returns a list of PluginResources for a given plugin module's complete key.

getPluginResources(String) - Method in class com.atlassian.plugin.webresource.PluginResourceLocatorImpl

getRequestCache() - Method in interface com.atlassian.plugin.webresource.WebResourceIntegration

This must be a thread-local cache that will be accessible from both the page, and the decorator

getRequiredResources() - Method in interface com.atlassian.plugin.webresource.WebResourceManager

getRequiredResources() - Method in class com.atlassian.plugin.webresource.WebResourceManagerImpl

getResourceAsStream() - Method in class com.atlassian.plugin.servlet.DownloadableClasspathResource

getResourceAsStream() - Method in class com.atlassian.plugin.servlet.DownloadableWebResource

getResourceName() - Method in class com.atlassian.plugin.webresource.BatchPluginResource

getResourceName() - Method in interface com.atlassian.plugin.webresource.PluginResource

getResourceName() - Method in class com.atlassian.plugin.webresource.SinglePluginResource

getResourceTags(String) - Method in interface com.atlassian.plugin.webresource.WebResourceManager

getResourceTags(String) - Method in class com.atlassian.plugin.webresource.WebResourceManagerImpl

getResourceUrl(String, String) - Method in interface com.atlassian.plugin.webresource.PluginResourceLocator

Constructs and returns url for the given resource.

getResourceUrl(String, String) - Method in class com.atlassian.plugin.webresource.PluginResourceLocatorImpl

getServletContext() - Method in interface com.atlassian.plugin.servlet.ServletContextFactory

getStaticPluginResource(String, String) - Method in interface com.atlassian.plugin.webresource.WebResourceManager

A helper method to return a url for 'plugin' resources.

getStaticPluginResource(ModuleDescriptor, String) - Method in interface com.atlassian.plugin.webresource.WebResourceManager

getStaticPluginResource(String, String) - Method in class com.atlassian.plugin.webresource.WebResourceManagerImpl

getStaticPluginResource(ModuleDescriptor, String) - Method in class com.atlassian.plugin.webresource.WebResourceManagerImpl

getStaticPluginResourcePrefix(ModuleDescriptor, String) - Method in interface com.atlassian.plugin.webresource.WebResourceManager

Deprecated. Use #getStaticPluginResource instead

getStaticPluginResourcePrefix(ModuleDescriptor, String) - Method in class com.atlassian.plugin.webresource.WebResourceManagerImpl

Deprecated. Use WebResourceManagerImpl.getStaticPluginResource(com.atlassian.plugin.ModuleDescriptor, String) instead

getStaticResourcePrefix() - Method in interface com.atlassian.plugin.webresource.WebResourceManager

A helper method to return a prefix for 'system' static resources.

getStaticResourcePrefix(String) - Method in interface com.atlassian.plugin.webresource.WebResourceManager

A helper method to return a prefix for 'system' static resources.

getStaticResourcePrefix() - Method in class com.atlassian.plugin.webresource.WebResourceManagerImpl

getStaticResourcePrefix(String) - Method in class com.atlassian.plugin.webresource.WebResourceManagerImpl

getSystemBuildNumber() - Method in interface com.atlassian.plugin.webresource.WebResourceIntegration

Represents the last time the system was updated.

getSystemCounter() - Method in interface com.atlassian.plugin.webresource.WebResourceIntegration

Represents the unique number for this system, which when updated will flush the cache.

getType() - Method in class com.atlassian.plugin.webresource.BatchPluginResource

getUrl() - Method in class com.atlassian.plugin.webresource.BatchPluginResource

Returns a url string in the format: /download/batch/MODULE_COMPLETE_KEY/resourceName?PARAMS e.g.

getUrl() - Method in interface com.atlassian.plugin.webresource.PluginResource

getUrl() - Method in class com.atlassian.plugin.webresource.SinglePluginResource

Returns a url string in the format: /download/resources/MODULE_COMPLETE_KEY/RESOURCE_NAME e.g.

H

hashCode() - Method in class com.atlassian.plugin.webresource.BatchPluginResource

I

includeResources(Writer) - Method in interface com.atlassian.plugin.webresource.WebResourceManager

Writes out the resource tags to the previously required resources called via WebResourceManager.requireResource(String).

includeResources(Writer) - Method in class com.atlassian.plugin.webresource.WebResourceManagerImpl

init(Plugin, Element) - Method in class com.atlassian.plugin.webresource.WebResourceModuleDescriptor

INLINE_INCLUDE_MODE - Static variable in interface com.atlassian.plugin.webresource.WebResourceManager

Deprecated. Since 2.2. Use WebResourceManager.requireResource(String) instead.

isCacheSupported() - Method in class com.atlassian.plugin.webresource.BatchPluginResource

isCacheSupported() - Method in interface com.atlassian.plugin.webresource.PluginResource

isCacheSupported() - Method in class com.atlassian.plugin.webresource.SinglePluginResource

isEmpty() - Method in class com.atlassian.plugin.webresource.BatchPluginResource

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

isResourceModified(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.webresource.BatchPluginResource

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(Date) - Constructor for class com.atlassian.plugin.servlet.util.LastModifiedHandler

LastModifiedHandler - Class in com.atlassian.plugin.util

Deprecated. Since 2.0.0, use LastModifiedHandler

LastModifiedHandler() - Constructor for class com.atlassian.plugin.util.LastModifiedHandler

Deprecated.

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.

matches(String) - Method in class com.atlassian.plugin.servlet.PluginResourceDownload

matches(String) - Method in class com.atlassian.plugin.servlet.ResourceUrlParser

Deprecated. Returns true if the provided URL matches a the URL prefix defined for this download strategy.

matches(String) - Static method in class com.atlassian.plugin.webresource.BatchPluginResource

matches(String) - Method in interface com.atlassian.plugin.webresource.PluginResourceLocator

Returns true if this locator can parse the given url.

matches(String) - Method in class com.atlassian.plugin.webresource.PluginResourceLocatorImpl

matches(String) - Static method in class com.atlassian.plugin.webresource.SinglePluginResource

modified() - Method in class com.atlassian.plugin.servlet.util.LastModifiedHandler

The content has changed, reset the modified date and the etag

P

parse(String) - Method in class com.atlassian.plugin.servlet.ResourceUrlParser

Deprecated. Parses resource download URLs for this plugin resource download strategy, returning a PluginResource.

parse(String, Map<String, String>) - Static method in class com.atlassian.plugin.webresource.BatchPluginResource

Parses the given url and query parameter map into a BatchPluginResource.

parse(String) - Static method in class com.atlassian.plugin.webresource.SinglePluginResource

Parses the given url into a SinglePluginResource.

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_WEBRESOURCE_BATCHING_OFF - Static variable in class com.atlassian.plugin.webresource.PluginResourceLocatorImpl

pluginModuleDisabled(PluginModuleDisabledEvent) - Method in class com.atlassian.plugin.servlet.download.plugin.PluggableDownloadStrategy

pluginModuleEnabled(PluginModuleEnabledEvent) - Method in class com.atlassian.plugin.servlet.download.plugin.PluggableDownloadStrategy

PluginResource - Interface in com.atlassian.plugin.webresource

Represents a plugin resource.

PluginResourceDownload - Class in com.atlassian.plugin.servlet

A downloadable plugin resource, as described here: http://confluence.atlassian.com/display/JIRA/Downloadable+plugin+resource It supports the download of single plugin resources as well as batching.

PluginResourceDownload() - Constructor for class com.atlassian.plugin.servlet.PluginResourceDownload

PluginResourceDownload(PluginResourceLocator, ContentTypeResolver, String) - Constructor for class com.atlassian.plugin.servlet.PluginResourceDownload

PluginResourceLocator - Interface in com.atlassian.plugin.webresource

Assists in locating plugin resources in different ways.

pluginResourceLocator - Variable in class com.atlassian.plugin.webresource.WebResourceManagerImpl

PluginResourceLocatorImpl - Class in com.atlassian.plugin.webresource

Default implementation of PluginResourceLocator.

PluginResourceLocatorImpl(PluginAccessor, ServletContextFactory) - Constructor for class com.atlassian.plugin.webresource.PluginResourceLocatorImpl

R

register(String, DownloadStrategy) - Method in class com.atlassian.plugin.servlet.download.plugin.PluggableDownloadStrategy

requireResource(String) - Method in interface com.atlassian.plugin.webresource.WebResourceManager

Indicates to that a given plugin web resource is required.

requireResource(String, Writer) - Method in interface com.atlassian.plugin.webresource.WebResourceManager

Writes the resource tags of the specified resource to the writer.

requireResource(String) - Method in class com.atlassian.plugin.webresource.WebResourceManagerImpl

requireResource(String, Writer) - Method in class com.atlassian.plugin.webresource.WebResourceManagerImpl

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

ResourceUrlParser - Class in com.atlassian.plugin.servlet

Deprecated. Since 2.2

ResourceUrlParser(String) - Constructor for class com.atlassian.plugin.servlet.ResourceUrlParser

Deprecated. Create a parser with the given strategy prefix for parsing URLs.

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.

serveFile(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.PluginResourceDownload

serveFileImpl(HttpServletResponse, InputStream) - Static method in class com.atlassian.plugin.servlet.ResourceDownloadUtils

Deprecated. Since 2.0. Use IOUtils.copy(InputStream, OutputStream) instead. The method calling this should be responsible for closing streams and flushing if necessary.

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

serveResource(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.webresource.BatchPluginResource

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.

setCharacterEncoding(String) - Method in class com.atlassian.plugin.servlet.PluginResourceDownload

setContentTypeResolver(ContentTypeResolver) - Method in class com.atlassian.plugin.servlet.PluginResourceDownload

setIncludeMode(WebResourceManager.IncludeMode) - Method in interface com.atlassian.plugin.webresource.WebResourceManager

Deprecated. Since 2.2.

setIncludeMode(WebResourceManager.IncludeMode) - Method in class com.atlassian.plugin.webresource.WebResourceManagerImpl

Deprecated. Since 2.2.

setPluginResourceLocator(PluginResourceLocator) - Method in class com.atlassian.plugin.servlet.PluginResourceDownload

SinglePluginResource - Class in com.atlassian.plugin.webresource

Represents a single plugin resource.

SinglePluginResource(String, String, boolean) - Constructor for class com.atlassian.plugin.webresource.SinglePluginResource

SinglePluginResource(String, String, boolean, Map<String, String>) - Constructor for class com.atlassian.plugin.webresource.SinglePluginResource

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.

streamResource(OutputStream) - Method in class com.atlassian.plugin.webresource.BatchPluginResource

T

toString() - Method in class com.atlassian.plugin.webresource.BatchPluginResource

U

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

W

webResourceFormatters - Static variable in class com.atlassian.plugin.webresource.WebResourceManagerImpl

WebResourceIntegration - Interface in com.atlassian.plugin.webresource

The integration layer between Plugin's Web Resource Handler, and specific applications (eg JIRA, Confluence).

webResourceIntegration - Variable in class com.atlassian.plugin.webresource.WebResourceManagerImpl

WebResourceManager - Interface in com.atlassian.plugin.webresource

Manage 'css', 'javascript' and other 'resources' that are usually linked at the top of pages using <script> and <link> tags.

WebResourceManager.IncludeMode - Interface in com.atlassian.plugin.webresource

Deprecated. Since 2.2

WebResourceManagerImpl - Class in com.atlassian.plugin.webresource

A handy super-class that handles most of the resource management.

WebResourceManagerImpl(PluginResourceLocator, WebResourceIntegration) - Constructor for class com.atlassian.plugin.webresource.WebResourceManagerImpl

WebResourceModuleDescriptor - Class in com.atlassian.plugin.webresource

A way of linking to web 'resources', such as javascript or css.

WebResourceModuleDescriptor() - Constructor for class com.atlassian.plugin.webresource.WebResourceModuleDescriptor

A B C D E F G H I L M P R S T U W