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

A

AbstractFileServerServlet - Class in com.atlassian.plugin.servlet

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

AbstractStringTransformedDownloadableResource - Class in com.atlassian.plugin.webresource.transformer

Deprecated. since 2.9.0 use CharSequenceDownloadableResource instead

AbstractStringTransformedDownloadableResource(DownloadableResource) - Constructor for class com.atlassian.plugin.webresource.transformer.AbstractStringTransformedDownloadableResource

Deprecated.

AbstractTransformedDownloadableResource - Class in com.atlassian.plugin.webresource.transformer

Abstract class for implementing downloadable resources that are wrapping an underlying resource as part of a WebResourceTransformer implementation.

AbstractTransformedDownloadableResource(DownloadableResource) - Constructor for class com.atlassian.plugin.webresource.transformer.AbstractTransformedDownloadableResource

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

Set 'expire' headers to cache for one year.

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.

addParamsToUrl(StringBuilder, Map<String, String>) - Method in class com.atlassian.plugin.webresource.BatchPluginResource

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

BATCH_PARAMS - Static variable in interface com.atlassian.plugin.webresource.PluginResourceLocator

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

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.

BatchPluginResource(String, String, Map<String, String>, Iterable<DownloadableResource>) - 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

This constructor includes the resources that are contained in the batch, and so is primarily for use when serving the resource.

BatchResource - Interface in com.atlassian.plugin.webresource

Interface for plugin resources that serve batches.

BatchSubResource - Class in com.atlassian.plugin.webresource

Represents a plugin resource that is a subordinate of a batch.

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

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

C

CharSequenceDownloadableResource - Class in com.atlassian.plugin.webresource.transformer

Abstract class that makes it easy to create transforms that go from string to string.

CharSequenceDownloadableResource(DownloadableResource) - Constructor for class com.atlassian.plugin.webresource.transformer.CharSequenceDownloadableResource

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

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

ContentTypeResolver - Interface in com.atlassian.plugin.servlet

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

CONTEXT_BATCH_PATTERN - Static variable in class com.atlassian.plugin.webresource.ContextBatchSubResourceBuilder

ContextBatchSubResourceBuilder - Class in com.atlassian.plugin.webresource

Provides a fallback to serve resources relative to a context batch resource In practice, the resources url should be transformed via the {{com.atlassian.plugin.webresource.RelativeURLTransformResource}}.

ContextBatchSubResourceBuilder(ResourceDependencyResolver, DownloadableResourceFinder) - Constructor for class com.atlassian.plugin.webresource.ContextBatchSubResourceBuilder

create(Pattern, Function<Matcher, CharSequence>) - Static method in class com.atlassian.plugin.webresource.transformer.SearchAndReplacer

createBatchFor(PluginResource) - Static method in class com.atlassian.plugin.webresource.SuperBatchPluginResource

CssWebResource - Class in com.atlassian.plugin.webresource

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

D

DefaultResourceBatchingConfiguration - Class in com.atlassian.plugin.webresource

Default configuration for the plugin resource locator, for those applications that do not want to perform any super-batching.

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

DefaultWebResourceFilter - Class in com.atlassian.plugin.webresource

A Web Resource Filter that allows for css and javascript resources.

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

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

Deprecated. Since 2.2. Use WebResourceManager.requireResource(String, Writer, UrlMode) instead.

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

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

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

An exception was encountered while trying to write a resource to the client.

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

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

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

Creates a download strategy.

E

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

encoding() - Method in class com.atlassian.plugin.webresource.transformer.CharSequenceDownloadableResource

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

executeInNewContext(Supplier<T>) - Method in interface com.atlassian.plugin.webresource.WebResourceManager

Executes a Supplier within a new WebResourceManager context.

executeInNewContext(Supplier<T>) - Method in class com.atlassian.plugin.webresource.WebResourceManagerImpl

F

find(String, String) - Method in class com.atlassian.plugin.webresource.SingleDownloadableResourceBuilder

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

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

FORMATTER - Static variable in class com.atlassian.plugin.webresource.CssWebResource

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

getAttributeParameters() - Method in class com.atlassian.plugin.webresource.CssWebResource

getAttributeParameters() - Method in class com.atlassian.plugin.webresource.JavascriptWebResource

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

Returns the base URL for this application.

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

Returns the base URL for this application in either relative or absolute format, depending on the value of urlMode.

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

Returns the base URL for this application.

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

Returns the base URL for this application in either relative or absolute format, depending on the value of urlMode.

getBaseUrl() - Method in class com.atlassian.plugin.webresource.WebResourceUrlProviderImpl

getBaseUrl(UrlMode) - Method in class com.atlassian.plugin.webresource.WebResourceUrlProviderImpl

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

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

getContentType() - Method in class com.atlassian.plugin.webresource.BatchSubResource

getContentType() - Method in class com.atlassian.plugin.webresource.SuperBatchPluginResource

getContentType() - Method in class com.atlassian.plugin.webresource.transformer.AbstractTransformedDownloadableResource

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

Returns the web resource contexts this resource is associated with.

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.

getEncoding() - Method in class com.atlassian.plugin.webresource.transformer.AbstractStringTransformedDownloadableResource

Deprecated.

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.transformer.WebResourceTransformerModuleDescriptor

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

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

getOriginalResource() - Method in class com.atlassian.plugin.webresource.transformer.AbstractTransformedDownloadableResource

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

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

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

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

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

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(UrlMode) - Method in interface com.atlassian.plugin.webresource.WebResourceManager

This is the equivalent of calling WebResourceManager.getRequiredResources(UrlMode, WebResourceFilter) with the given url mode and a default filter that is dependent on the implementation.

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

Returns the resource tags for the previously required resources called via WebResourceManager.requireResource(String) that match the specified web resource filter.

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

Deprecated. As of 2.3.0, replaced by WebResourceManager.getRequiredResources(UrlMode)

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

This is the equivalent of calling WebResourceManagerImpl.getRequiredResources(UrlMode, WebResourceFilter) with the given url mode and a DefaultWebResourceFilter.

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

Returns a String of the resources tags to the previously required resources called via requireResource methods for the specified url mode and resource filter.

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

Deprecated.

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

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

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

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

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

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

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

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

Returns the resource tags of the specified resource.

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

Deprecated. As of 2.3.0, replaced by WebResourceManager.getResourceTags(String, UrlMode)

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

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

Deprecated.

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

Deprecated. As of 2.9.0, replaced by WebResourceUrlProvider.getResourceUrl(String, String)

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

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

Constructs and returns url for the given resource.

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

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

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

Deprecated. As of 2.9.0, replaced by WebResourceUrlProvider.getStaticPluginResourceUrl(String, String, UrlMode)

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

Deprecated. As of 2.9.0, replaced by WebResourceUrlProvider.getStaticPluginResourceUrl(com.atlassian.plugin.ModuleDescriptor, String, UrlMode)

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

Deprecated. As of 2.3.0, replaced by WebResourceManager.getStaticPluginResource(String, String, UrlMode)

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

Deprecated. As of 2.3.0, replaced by WebResourceManager.getStaticPluginResource(ModuleDescriptor, String, UrlMode)

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

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

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

Deprecated.

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

Deprecated.

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

Deprecated. Since 2.2 Use #getStaticPluginResource instead

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

Deprecated.

getStaticPluginResourceUrl(String, String, UrlMode) - Method in interface com.atlassian.plugin.webresource.WebResourceUrlProvider

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

getStaticPluginResourceUrl(ModuleDescriptor<?>, String, UrlMode) - Method in interface com.atlassian.plugin.webresource.WebResourceUrlProvider

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

getStaticPluginResourceUrl(String, String, UrlMode) - Method in class com.atlassian.plugin.webresource.WebResourceUrlProviderImpl

getStaticPluginResourceUrl(ModuleDescriptor, String, UrlMode) - Method in class com.atlassian.plugin.webresource.WebResourceUrlProviderImpl

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

The locale identifier that should be inserted into static resource urls for the current request, if appropriate.

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

Deprecated. As of 2.9.0, replaced by WebResourceUrlProvider.getStaticResourcePrefix(UrlMode)

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

Deprecated. As of 2.9.0, replaced by WebResourceUrlProvider.getStaticResourcePrefix(String, UrlMode)

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

Deprecated. As of 2.3.0, replaced by WebResourceManager.getStaticResourcePrefix(UrlMode)

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

Deprecated. As of 2.3.0, replaced by WebResourceManager.getStaticResourcePrefix(String, UrlMode)

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

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

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

getStaticResourcePrefix(String, UrlMode) - Method in interface com.atlassian.plugin.webresource.WebResourceUrlProvider

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

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

getStaticResourcePrefix(String, UrlMode) - Method in class com.atlassian.plugin.webresource.WebResourceUrlProviderImpl

getSuperBatchModuleCompleteKeys() - Method in class com.atlassian.plugin.webresource.DefaultResourceBatchingConfiguration

getSuperBatchModuleCompleteKeys() - Method in interface com.atlassian.plugin.webresource.ResourceBatchingConfiguration

Gets the list of resource plugin modules that should be included in the superbatch, in the order that they should be batched.

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

This version number is used for caching URL generation, and needs to be incremented every time the contents of the superbatch may have changed.

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.

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

A reference to the temporary directory the application want the plugin system to use.

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

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

getType() - Method in interface com.atlassian.plugin.webresource.BatchResource

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

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.

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

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

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

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

getVersion(WebResourceIntegration) - Method in class com.atlassian.plugin.webresource.SuperBatchPluginResource

H

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

I

includeResources(Iterable<String>, Writer, UrlMode) - Method in interface com.atlassian.plugin.webresource.WebResourceManager

Writes out the resource tags for a specified set of required resources and their dependencies.

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

This is the equivalent of calling WebResourceManager.includeResources(Writer, UrlMode, WebResourceFilter) with the given url mode and a default web resource filter that is dependent on the implementation.

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

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

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

Deprecated. As of 2.3.0, replaced by WebResourceManager.includeResources(Writer, UrlMode)

includeResources(Iterable<String>, Writer, UrlMode) - Method in class com.atlassian.plugin.webresource.WebResourceManagerImpl

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

This is the equivalent of of calling WebResourceManagerImpl.includeResources(Writer, UrlMode, WebResourceFilter) with the given url mode and a DefaultWebResourceFilter.

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

Writes out the resource tags to the previously required resources called via requireResource methods for the specified url mode and resource filter.

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

Deprecated.

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.

INSTANCE - Static variable in class com.atlassian.plugin.webresource.DefaultWebResourceFilter

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

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

isContextBatchingEnabled() - Method in class com.atlassian.plugin.webresource.DefaultResourceBatchingConfiguration

isContextBatchingEnabled() - Method in interface com.atlassian.plugin.webresource.ResourceBatchingConfiguration

Determines whether web resources in the same context should be batched together.

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

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

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

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

isPluginWebResourceBatchingEnabled() - Method in class com.atlassian.plugin.webresource.DefaultResourceBatchingConfiguration

isPluginWebResourceBatchingEnabled() - Method in interface com.atlassian.plugin.webresource.ResourceBatchingConfiguration

Determines whether plugin resources of the same type defined within a single web resource are batched into one file.

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

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

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

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

isSuperBatchingEnabled() - Method in class com.atlassian.plugin.webresource.DefaultResourceBatchingConfiguration

isSuperBatchingEnabled() - Method in interface com.atlassian.plugin.webresource.ResourceBatchingConfiguration

Gets whether web resources in different resource modules should be batched together.

J

JavascriptWebResource - Class in com.atlassian.plugin.webresource

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

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

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

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

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

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

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

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

Returns true if this filter supports the inclusion of the given resource.

matches(ResourceLocation) - Method in class com.atlassian.plugin.webresource.WebResourceTransformation

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

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

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

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

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(WebResourceIntegration, ServletContextFactory, WebResourceUrlProvider) - Constructor for class com.atlassian.plugin.webresource.PluginResourceLocatorImpl

PluginResourceLocatorImpl(WebResourceIntegration, ServletContextFactory, WebResourceUrlProvider, ResourceBatchingConfiguration) - Constructor for class com.atlassian.plugin.webresource.PluginResourceLocatorImpl

R

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

replaceAll(CharSequence) - Method in class com.atlassian.plugin.webresource.transformer.SearchAndReplacer

Replace all occurrences of the pattern in the input, using the given function

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

Indicates that a given plugin web resource is required.

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

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

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

Deprecated. As of 2.3.0, replaced by WebResourceManager.requireResource(String, Writer, UrlMode)

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

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

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

Deprecated.

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

Writes the resource tags of all resources that have the given context specified in their descriptor.

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

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

ResourceBatchingConfiguration - Interface in com.atlassian.plugin.webresource

Resource batching configuration for the WebResourceManagerImpl.

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

SearchAndReplacer - Class in com.atlassian.plugin.webresource.transformer

Performs a search and replace function on a given input.

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

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

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

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

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.

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

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

SingleDownloadableResourceBuilder - Class in com.atlassian.plugin.webresource

Constructs a single resource for download

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

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

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

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

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

Deprecated.

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

SuperBatchPluginResource - Class in com.atlassian.plugin.webresource

Creates a batch of all like-typed resources that are declared as "super-batch="true"" in their plugin definitions.

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

Creates a super batch resource without the included resources

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

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

SuperBatchSubResourceBuilder - Class in com.atlassian.plugin.webresource

Provides a fallback to serve resources relative to a super batch resource In practice, the resources url should be transformed via the {{com.atlassian.plugin.webresource.RelativeURLTransformResource}}.

SuperBatchSubResourceBuilder(ResourceDependencyResolver, DownloadableResourceFinder) - Constructor for class com.atlassian.plugin.webresource.SuperBatchSubResourceBuilder

T

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

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

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

transform(String) - Method in class com.atlassian.plugin.webresource.transformer.AbstractStringTransformedDownloadableResource

Deprecated. Override this method to transform the original content into a new format.

transform(CharSequence) - Method in class com.atlassian.plugin.webresource.transformer.CharSequenceDownloadableResource

Override this method to transform the original content into a new format.

transform(Element, ResourceLocation, String, DownloadableResource) - Method in interface com.atlassian.plugin.webresource.transformer.WebResourceTransformer

Transforms the downloadable resource by returning a new one.

transformAndStreamResource(DownloadableResource, Charset, OutputStream, Function<CharSequence, CharSequence>) - Static method in class com.atlassian.plugin.webresource.transformer.TransformerUtils

Write apply a given transform a resource and then write the transformed content to the supplied OutputStream.

transformDownloadableResource(PluginAccessor, DownloadableResource, ResourceLocation, String) - Method in class com.atlassian.plugin.webresource.WebResourceTransformation

TransformerUtils - Class in com.atlassian.plugin.webresource.transformer

Utility class for transforming resources

TransformerUtils() - Constructor for class com.atlassian.plugin.webresource.transformer.TransformerUtils

U

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

UrlMode - Enum in com.atlassian.plugin.webresource

A formatting mode for URLs.

UrlParseException - Exception in com.atlassian.plugin.webresource

An UrlParseException is thrown when a web resource url cannot be parsed correctly.

UrlParseException(String) - Constructor for exception com.atlassian.plugin.webresource.UrlParseException

UTF8 - Static variable in class com.atlassian.plugin.webresource.transformer.TransformerUtils

V

valueOf(String) - Static method in enum com.atlassian.plugin.webresource.UrlMode

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.atlassian.plugin.webresource.UrlMode

Returns an array containing the constants of this enum type, in the order they are declared.

W

WebResourceFilter - Interface in com.atlassian.plugin.webresource

An interface for filtering web resources.

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, WebResourceUrlProvider) - Constructor for class com.atlassian.plugin.webresource.WebResourceManagerImpl

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

WebResourceManagerImpl(PluginResourceLocator, WebResourceIntegration, WebResourceUrlProvider, ResourceBatchingConfiguration, ResourceDependencyResolver) - 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(HostContainer) - Constructor for class com.atlassian.plugin.webresource.WebResourceModuleDescriptor

WebResourceTransformation - Class in com.atlassian.plugin.webresource

Represents a set of transformer invocations for a specific web resource set and extension.

WebResourceTransformation(Element) - Constructor for class com.atlassian.plugin.webresource.WebResourceTransformation

WebResourceTransformer - Interface in com.atlassian.plugin.webresource.transformer

Transforms a downloadable resource.

WebResourceTransformerModuleDescriptor - Class in com.atlassian.plugin.webresource.transformer

Defines a module descriptor for a WebResourceTransformer.

WebResourceTransformerModuleDescriptor(ModuleFactory) - Constructor for class com.atlassian.plugin.webresource.transformer.WebResourceTransformerModuleDescriptor

WebResourceUrlProvider - Interface in com.atlassian.plugin.webresource

Provides the prefixes a 'system' static resource as well as the base url of the application to be used as a prefix for other web resources.

WebResourceUrlProviderImpl - Class in com.atlassian.plugin.webresource

The default implementation of WebResourceUrlProvider.

WebResourceUrlProviderImpl(WebResourceIntegration) - Constructor for class com.atlassian.plugin.webresource.WebResourceUrlProviderImpl

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