A C D E G I L M P R S T W

A

AbstractDownloadableResource - Class in com.atlassian.plugin.servlet

AbstractDownloadableResource(Plugin, ResourceLocation, String, ContentTypeResolver) - Constructor for class com.atlassian.plugin.servlet.AbstractDownloadableResource

AbstractFileServerServlet - Class in com.atlassian.plugin.servlet

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

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

Set 'expire' headers to cache for ten years, with public caching turned on.

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.

checkResourceNotModified(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.AbstractDownloadableResource

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.

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

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 - Variable in class com.atlassian.plugin.servlet.AbstractDownloadableResource

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

doGet(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.AbstractFileServerServlet

DownloadableClasspathResource - Class in com.atlassian.plugin.servlet

DownloadableClasspathResource(Plugin, ResourceLocation, String, ContentTypeResolver) - Constructor for class com.atlassian.plugin.servlet.DownloadableClasspathResource

DownloadableResource - Interface in com.atlassian.plugin.servlet

DownloadableWebResource - Class in com.atlassian.plugin.servlet

DownloadableWebResource(Plugin, ResourceLocation, String, ContentTypeResolver) - 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

E

extraPath - Variable in class com.atlassian.plugin.servlet.AbstractDownloadableResource

G

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

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

getContentType() - Method in class com.atlassian.plugin.servlet.AbstractDownloadableResource

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

Returns the content type for the given resource path.

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.AbstractDownloadableResource

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

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

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

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

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

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

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

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

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

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

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

getStaticPluginResource(String, 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.

I

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

Include the resources that have already been specified by the request in the page.

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

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

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 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

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

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

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

PATH_SEPARATOR - Static variable in class com.atlassian.plugin.servlet.AbstractFileServerServlet

plugin - Variable in class com.atlassian.plugin.servlet.AbstractDownloadableResource

PluginResourceDownload - Class in com.atlassian.plugin.servlet

A downloadable plugin resource, as described here: http://confluence.atlassian.com/display/JIRA/Downloadable+plugin+resource

The URL that it parses looks like this:
{server root}/download/resources/{plugin key}:{module key}/{resource name}

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

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

R

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

Called by a component to indicate that a certain resource is required to be inserted into this page.

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

Called by a component to indicate that a certain resource is required to be inserted into this page.

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

resourceLocation - Variable in class com.atlassian.plugin.servlet.AbstractDownloadableResource

ResourceUrlParser - Class in com.atlassian.plugin.servlet

Parses resource download URLs for a plugin resource download strategy, and can determine whether a given URL is valid for that download strategy.

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

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

S

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.

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

serveResource(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.AbstractDownloadableResource

serveResource(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.DownloadableClasspathResource

serveResource(HttpServletRequest, HttpServletResponse) - Method in interface com.atlassian.plugin.servlet.DownloadableResource

serveResource(HttpServletRequest, HttpServletResponse) - Method in class com.atlassian.plugin.servlet.DownloadableWebResource

SERVLET_PATH - Static variable in class com.atlassian.plugin.servlet.AbstractFileServerServlet

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

Sets the character enconding to use when decoding request urls.

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

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

Whether resources should be included inline, or at the top of the page.

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

setPluginManager(PluginManager) - Method in class com.atlassian.plugin.servlet.PluginResourceDownload

T

toString() - Method in class com.atlassian.plugin.servlet.AbstractDownloadableResource

W

WebResourceIntegration - Interface in com.atlassian.plugin.webresource

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

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

WebResourceManagerImpl - Class in com.atlassian.plugin.webresource

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

WebResourceManagerImpl(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 C D E G I L M P R S T W