Index (Atlassian Plugins - Web Resources API 7.2.2 API)

A B C D E G H I L M N P Q R S T U V W
All Classes and Interfaces|All Packages

A

ABSOLUTE - Enum constant in enum class com.atlassian.webresource.api.UrlMode: Absolute URL format, with URL scheme, hostname, port (if non-standard for the scheme), and context path.
AbstractBooleanUrlReadingCondition - Class in com.atlassian.webresource.spi.condition: Simple abstract implementation for UrlReadingCondition implementations.
AbstractBooleanUrlReadingCondition() - Constructor for class com.atlassian.webresource.spi.condition.AbstractBooleanUrlReadingCondition
addToHash(String, Object) - Method in interface com.atlassian.webresource.api.url.UrlBuilder: Contributes to the url's static hash
addToQueryString(String, String) - Method in interface com.atlassian.webresource.api.url.UrlBuilder: Contributes to the url's querystring
addToUrl(UrlBuilder) - Method in class com.atlassian.webresource.spi.condition.AbstractBooleanUrlReadingCondition
addToUrl(UrlBuilder) - Method in interface com.atlassian.webresource.spi.condition.UrlReadingCondition: Called when constructing the URL as the hosting HTML page is being served.
addToUrl(UrlBuilder) - Method in interface com.atlassian.webresource.spi.transformer.TransformerUrlBuilder: Called when constructing the URL as the hosting HTML page is being served.
all() - Method in interface com.atlassian.webresource.api.assembler.resource.PluginUrlResourceParams
allUsedQueryParameters() - Method in interface com.atlassian.webresource.spi.transformer.WebResourceTransformerFactory: Return the complete set of query parameters that this transformer could ever use.
assembled() - Method in interface com.atlassian.webresource.api.assembler.WebResourceAssembler
AssembledResources - Interface in com.atlassian.webresource.api.assembler: Interface for clients to include web resources that have been required via RequiredResources.
assembler() - Method in interface com.atlassian.webresource.api.assembler.PageBuilderService: Retrieves the request-local WebResourceAssembler.
AUTO - Enum constant in enum class com.atlassian.webresource.api.UrlMode: Unspecified URL format, indicating that either absolute or relative URLs are acceptable.
autoIncludeFrontendRuntime(boolean) - Method in interface com.atlassian.webresource.api.assembler.WebResourceAssemblerBuilder: Occasionally a WRM feature requires supporting frontend code to work, such as when the interactive or lazy-load resource phases are used.

B

build() - Method in interface com.atlassian.webresource.api.assembler.WebResourceAssemblerBuilder: Constructs a WebResourceAssembler

C

com.atlassian.webresource.api - package com.atlassian.webresource.api
com.atlassian.webresource.api.assembler - package com.atlassian.webresource.api.assembler
com.atlassian.webresource.api.assembler.resource - package com.atlassian.webresource.api.assembler.resource
com.atlassian.webresource.api.data - package com.atlassian.webresource.api.data
com.atlassian.webresource.api.decorator - package com.atlassian.webresource.api.decorator
com.atlassian.webresource.api.descriptor - package com.atlassian.webresource.api.descriptor
com.atlassian.webresource.api.transformer - package com.atlassian.webresource.api.transformer
com.atlassian.webresource.api.url - package com.atlassian.webresource.api.url
com.atlassian.webresource.spi.condition - package com.atlassian.webresource.spi.condition
com.atlassian.webresource.spi.transformer - package com.atlassian.webresource.spi.transformer
CompleteWebResourceKey - Class in com.atlassian.webresource.api.assembler.resource: Represents complete key of the web-resource tag.
CompleteWebResourceKey(String, String) - Constructor for class com.atlassian.webresource.api.assembler.resource.CompleteWebResourceKey
CONTEXT - Enum constant in enum class com.atlassian.webresource.api.assembler.resource.PluginUrlResource.BatchType
copy() - Method in interface com.atlassian.webresource.api.assembler.WebResourceAssembler
create() - Method in interface com.atlassian.webresource.api.assembler.WebResourceAssemblerFactory: Creates a new WebResourceAssemblerParams for constructing a builder.

D

data() - Method in interface com.atlassian.webresource.api.assembler.WebResourceAssembler
defaultPhase() - Static method in enum class com.atlassian.webresource.api.assembler.resource.ResourcePhase: Method responsible for managing the default phase.
DEFER - Enum constant in enum class com.atlassian.webresource.api.assembler.resource.ResourcePhase: Code should start loading when the client encounters it, but should not execute until code in the ResourcePhase.INLINE and ResourcePhase.REQUIRE phases has executed and the initial HTTP response has completed.
drainIncludedResources() - Method in interface com.atlassian.webresource.api.assembler.AssembledResources: Calculates dependencies, returns requested resources, then clears the list of webresources + contexts that have been included since the last call to AssembledResources.drainIncludedResources().
drainIncludedSyncResources() - Method in interface com.atlassian.webresource.api.assembler.AssembledResources: Deprecated.
since 5.6.0. Unused now ResourcePhase.INLINE exists.

E

equals(Object) - Method in class com.atlassian.webresource.api.assembler.resource.CompleteWebResourceKey
exclude(Set<String>, Set<String>) - Method in interface com.atlassian.webresource.api.assembler.RequiredResources: Specifies that the given resources should be excluded from all future calls to drainIncludedResources().
excludeSuperbatch() - Method in interface com.atlassian.webresource.api.assembler.RequiredResources: Exclude superbatch context.

G

get(String) - Method in interface com.atlassian.webresource.api.QueryParams
getBaseUrl() - Method in interface com.atlassian.webresource.api.WebResourceUrlProvider: Returns the base URL for this application.
getBaseUrl(UrlMode) - Method in interface com.atlassian.webresource.api.WebResourceUrlProvider: Returns the base URL for this application in either relative or absolute format, depending on the value of urlMode.
getBatchType() - Method in interface com.atlassian.webresource.api.assembler.resource.PluginUrlResource
getCompleteKey() - Method in class com.atlassian.webresource.api.assembler.resource.CompleteWebResourceKey
getContextDependencies() - Method in interface com.atlassian.webresource.api.descriptor.WebResourceModuleDescriptor: Returns the set of contexts that this web-resource depends on, this is only relevant is this web-resource is defining a root page (WebResourceModuleDescriptor.isRootPage())
getContexts() - Method in interface com.atlassian.webresource.api.descriptor.WebResourceModuleDescriptor
getData() - Method in interface com.atlassian.webresource.api.data.PluginDataResource
getDependencies() - Method in interface com.atlassian.webresource.api.descriptor.WebResourceModuleDescriptor: Returns a list of dependencies on other web-resources.
getJsonable() - Method in interface com.atlassian.webresource.api.data.PluginDataResource: Deprecated.
use PluginDataResource.getData() instead.
getKey() - Method in interface com.atlassian.webresource.api.assembler.resource.PluginUrlResource
getKey() - Method in interface com.atlassian.webresource.api.data.PluginDataResource
getModuleKey() - Method in interface com.atlassian.webresource.api.transformer.TransformerParameters
getParams() - Method in interface com.atlassian.webresource.api.assembler.resource.PluginUrlResource: Returns params that go outside this url's querystring.
getPhaseOrDefault(String) - Static method in enum class com.atlassian.webresource.api.assembler.resource.ResourcePhase
getPluginKey() - Method in class com.atlassian.webresource.api.assembler.resource.CompleteWebResourceKey
getPluginKey() - Method in interface com.atlassian.webresource.api.transformer.TransformerParameters
getRequiredResources(UrlMode) - Method in interface com.atlassian.webresource.api.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.webresource.api.WebResourceManager: Returns the resource tags for the previously required resources called via WebResourceManager.requireResource(String) that match the specified web resource filter.
getResourcePhase() - Method in interface com.atlassian.webresource.api.assembler.WebResource: Retrieves the web resource phase.
getResources() - Method in interface com.atlassian.webresource.api.assembler.WebResourceSet: Returns a list of included WebResources
getResources(Class<T>) - Method in interface com.atlassian.webresource.api.assembler.WebResourceSet: Returns a filtered list of included WebResources matching the given class
getResourceTags(String, UrlMode) - Method in interface com.atlassian.webresource.api.WebResourceManager: Returns the resource tags of the specified resource.
getResourceUrl(String, String) - Method in interface com.atlassian.webresource.api.WebResourceUrlProvider: Constructs and returns url for the given resource.
getStaticPluginResourceUrl(ModuleDescriptor<?>, String, UrlMode) - Method in interface com.atlassian.webresource.api.WebResourceUrlProvider: A helper method to return a url for 'plugin' resources.
getStaticPluginResourceUrl(String, String, UrlMode) - Method in interface com.atlassian.webresource.api.WebResourceUrlProvider: A helper method to return a url for 'plugin' resources.
getStaticResourcePrefix(UrlMode) - Method in interface com.atlassian.webresource.api.WebResourceUrlProvider: A helper method to return a prefix for 'system' static resources.
getStaticResourcePrefix(String, UrlMode) - Method in interface com.atlassian.webresource.api.WebResourceUrlProvider: A helper method to return a prefix for 'system' static resources.
getStaticResourcePrefix(String, String, UrlMode) - Method in interface com.atlassian.webresource.api.WebResourceUrlProvider: A helper method to return a prefix for 'system' static resources.
getStaticUrl(UrlMode) - Method in interface com.atlassian.webresource.api.assembler.resource.PluginUrlResource: The resource's url.
getWebResourceKey() - Method in class com.atlassian.webresource.api.assembler.resource.CompleteWebResourceKey

H

hashCode() - Method in class com.atlassian.webresource.api.assembler.resource.CompleteWebResourceKey
hasTwoPhaseProperties() - Method in interface com.atlassian.webresource.spi.transformer.TwoPhaseResourceTransformer: Allows a transformer to decide whether it has enough data to run an alternate transformation strategy using the data loaded when TwoPhaseResourceTransformer.loadTwoPhaseProperties(ResourceLocation, Function) was called.

I

includeResources(Writer, UrlMode) - Method in interface com.atlassian.webresource.api.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.webresource.api.WebResourceManager: Writes out the resource tags to the previously required resources called via WebResourceManager.requireResource(String) for the specified resource type.
includeResources(Iterable<String>, Writer, UrlMode) - Method in interface com.atlassian.webresource.api.WebResourceManager: Writes out the resource tags for a specified set of required resources and their dependencies.
includeSuperbatchResources(boolean) - Method in interface com.atlassian.webresource.api.assembler.WebResourceAssemblerBuilder: Deprecated.
since 5.5.0. Use RequiredResources.excludeSuperbatch() instead.
includeSyncbatchResources(boolean) - Method in interface com.atlassian.webresource.api.assembler.WebResourceAssemblerBuilder: The sync batch is implicitly included in every request.
init(Map<String, String>) - Method in class com.atlassian.webresource.spi.condition.AbstractBooleanUrlReadingCondition
init(Map<String, String>) - Method in interface com.atlassian.webresource.spi.condition.UrlReadingCondition: Called after creation and autowiring.
INLINE - Enum constant in enum class com.atlassian.webresource.api.assembler.resource.ResourcePhase: Code is rendered directly to the HTTP response.
INTERACTION - Enum constant in enum class com.atlassian.webresource.api.assembler.resource.ResourcePhase: Intended for page’s non-critical, dynamic behaviours.
isConditionTrue() - Method in class com.atlassian.webresource.spi.condition.AbstractBooleanUrlReadingCondition
isDeprecated() - Method in interface com.atlassian.webresource.api.descriptor.WebResourceModuleDescriptor
isDisableMinification() - Method in interface com.atlassian.webresource.api.descriptor.WebResourceModuleDescriptor
isRootPage() - Method in interface com.atlassian.webresource.api.descriptor.WebResourceModuleDescriptor: Declares if this web-resource is defining the root page, e.g.

L

loadTwoPhaseProperties(ResourceLocation, Function<String, InputStream>) - Method in interface com.atlassian.webresource.spi.transformer.TwoPhaseResourceTransformer: For a given file to be transformed, find and load any build-time metadata associated with it.
location() - Method in interface com.atlassian.webresource.api.transformer.TransformableResource: The original resource location

M

makeResourceTransformer(TransformerParameters) - Method in interface com.atlassian.webresource.spi.transformer.WebResourceTransformerFactory: Return the transformer for this transform
makeUrlBuilder(TransformerParameters) - Method in interface com.atlassian.webresource.spi.transformer.WebResourceTransformerFactory: Return the URL builder for this transform
matches(String) - Method in interface com.atlassian.webresource.api.WebResourceFilter: Returns true if this filter supports the inclusion of the given resource.
media() - Method in interface com.atlassian.webresource.api.assembler.resource.PluginCssResourceParams

N

nextResource() - Method in interface com.atlassian.webresource.api.transformer.TransformableResource: The original resource

P

PageBuilderService - Interface in com.atlassian.webresource.api.assembler: Service for working with the page being rendered by the current HTTP request.
peek() - Method in interface com.atlassian.webresource.api.assembler.AssembledResources: Returns the currently requested resources as per AssembledResources.drainIncludedResources(), however does not clear the internal list.
PluginCssResource - Interface in com.atlassian.webresource.api.assembler.resource: A CSS webresource
PluginCssResourceParams - Interface in com.atlassian.webresource.api.assembler.resource: Parameters for a CSS webresource
PluginDataResource - Interface in com.atlassian.webresource.api.data: Container for a data key and value
PluginJsResource - Interface in com.atlassian.webresource.api.assembler.resource: A Javascript webresource
PluginJsResourceParams - Interface in com.atlassian.webresource.api.assembler.resource: Parameters for a Javascript webresource
PluginUrlResource<T extends PluginUrlResourceParams> - Interface in com.atlassian.webresource.api.assembler.resource: Representation of a resource accessible via a URL
PluginUrlResource.BatchType - Enum Class in com.atlassian.webresource.api.assembler.resource
PluginUrlResourceParams - Interface in com.atlassian.webresource.api.assembler.resource: Parameters that affect a resource that occur outside its querystring - e.g.: media query, and other attributes on an HTML tag e.g.: charset

Q

queryKey() - Method in class com.atlassian.webresource.spi.condition.AbstractBooleanUrlReadingCondition: Should be unique to avoid clashes
QueryParams - Interface in com.atlassian.webresource.api: Provides access to querystring params.

R

RELATIVE - Enum constant in enum class com.atlassian.webresource.api.UrlMode: Relative URL format, starting with a slash and the context path.
REQUIRE - Enum constant in enum class com.atlassian.webresource.api.assembler.resource.ResourcePhase: Code should be loaded and run immediately as the client encounters it, blocking further HTML parsing.
requireContext(ResourcePhase, String) - Method in interface com.atlassian.webresource.api.assembler.RequiredResources: Specifies that resources for the given webresource context should be included on the next call to drainIncludedResources(), taking into consideration the resource phase.
requireContext(String) - Method in interface com.atlassian.webresource.api.assembler.RequiredResources: Specifies that resources for the given webresource context should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().
requireData(String, Jsonable) - Method in interface com.atlassian.webresource.api.assembler.RequiredData: Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().
requireData(String, Jsonable, ResourcePhase) - Method in interface com.atlassian.webresource.api.assembler.RequiredData
requireData(String, Boolean) - Method in interface com.atlassian.webresource.api.assembler.RequiredData: Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().
requireData(String, Boolean, ResourcePhase) - Method in interface com.atlassian.webresource.api.assembler.RequiredData
requireData(String, Number) - Method in interface com.atlassian.webresource.api.assembler.RequiredData: Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().
requireData(String, Number, ResourcePhase) - Method in interface com.atlassian.webresource.api.assembler.RequiredData
requireData(String, String) - Method in interface com.atlassian.webresource.api.assembler.RequiredData: Specifies that JSON data with the given key should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().
requireData(String, String, ResourcePhase) - Method in interface com.atlassian.webresource.api.assembler.RequiredData
RequiredData - Interface in com.atlassian.webresource.api.assembler: Interface for clients to require data blobs.
RequiredResources - Interface in com.atlassian.webresource.api.assembler: Interface for clients to require web resources.
requirePage(ResourcePhase, String) - Method in interface com.atlassian.webresource.api.assembler.RequiredResources: Includes all contexts and resources specified in the root-page into the WebResourceAssembler taking into consideration the resource phase.
requirePage(String) - Method in interface com.atlassian.webresource.api.assembler.RequiredResources: Includes all contexts and resources specified in the root-page into the WebResourceAssembler with ResourcePhase.defaultPhase().
requireResource(String) - Method in interface com.atlassian.webresource.api.WebResourceManager: Indicates that a given plugin web resource is required.
requireResource(String, Writer, UrlMode) - Method in interface com.atlassian.webresource.api.WebResourceManager: Writes the resource tags of the specified resource to the writer.
requireResourcesForContext(String) - Method in interface com.atlassian.webresource.api.WebResourceManager: Writes the resource tags of all resources that have the given context specified in their descriptor.
requireSuperbatch(ResourcePhase) - Method in interface com.atlassian.webresource.api.assembler.RequiredResources: Sets resource phase for superbatch context.
requireWebResource(ResourcePhase, String) - Method in interface com.atlassian.webresource.api.assembler.RequiredResources: Specifies that resources for the given module should be included on the next call to drainIncludedResources(), taking into consideration the resource phase.
requireWebResource(String) - Method in interface com.atlassian.webresource.api.assembler.RequiredResources: Specifies that resources for the given module should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().
RESOURCE - Enum constant in enum class com.atlassian.webresource.api.assembler.resource.PluginUrlResource.BatchType
ResourcePhase - Enum Class in com.atlassian.webresource.api.assembler.resource: Defines the current resource phases.
resources() - Method in interface com.atlassian.webresource.api.assembler.WebResourceAssembler

S

seed(WebResourceAssembler) - Method in interface com.atlassian.webresource.api.assembler.PageBuilderService: Deprecated.
since 3.3.2
shouldDisplay(QueryParams) - Method in class com.atlassian.webresource.spi.condition.AbstractBooleanUrlReadingCondition
shouldDisplay(QueryParams) - Method in interface com.atlassian.webresource.spi.condition.UrlReadingCondition: Determine whether the web fragment should be displayed.

T

toString() - Method in class com.atlassian.webresource.api.assembler.resource.CompleteWebResourceKey
transform(TransformableResource, QueryParams) - Method in interface com.atlassian.webresource.spi.transformer.UrlReadingWebResourceTransformer: Transforms the downloadable resource by returning a new one.
TransformableResource - Interface in com.atlassian.webresource.api.transformer: Describes a resource for transformation
TransformerParameters - Interface in com.atlassian.webresource.api.transformer: Transformer parameters to be passed to WebResourceTransformerFactory's methods.
TransformerUrlBuilder - Interface in com.atlassian.webresource.spi.transformer: The part of a transformer that contributes to the URL
TRUE - Static variable in class com.atlassian.webresource.spi.condition.AbstractBooleanUrlReadingCondition
TwoPhaseResourceTransformer - Interface in com.atlassian.webresource.spi.transformer: Allows implementors to receive metadata captured from build-time processing steps and to decide whether to use an alternate transformation strategy based on that metadata.

U

UrlBuilder - Interface in com.atlassian.webresource.api.url: Interface for conditions / transformers to contribute information to a resource URL.
UrlMode - Enum Class in com.atlassian.webresource.api: A formatting mode for URLs.
UrlReadingCondition - Interface in com.atlassian.webresource.spi.condition: Condition that contributes to the URL.
UrlReadingWebResourceTransformer - Interface in com.atlassian.webresource.spi.transformer: The part of a transformer that reads the config and url params and does the actual resource transformation.
UrlReadingWebResourceTransformerModuleDescriptor - Interface in com.atlassian.webresource.api.decorator

V

valueOf(String) - Static method in enum class com.atlassian.webresource.api.assembler.resource.PluginUrlResource.BatchType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.atlassian.webresource.api.assembler.resource.ResourcePhase: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.atlassian.webresource.api.UrlMode: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.atlassian.webresource.api.assembler.resource.PluginUrlResource.BatchType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.atlassian.webresource.api.assembler.resource.ResourcePhase: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.atlassian.webresource.api.UrlMode: Returns an array containing the constants of this enum class, in the order they are declared.

W

WebResource - Interface in com.atlassian.webresource.api.assembler: Marker interface for resources returned from the web resource system.
WebResourceAssembler - Interface in com.atlassian.webresource.api.assembler: Stateful component that handles inclusion of css, javascript and data resources.
WebResourceAssemblerBuilder - Interface in com.atlassian.webresource.api.assembler: Builder for constructing WebResourceAssembler
WebResourceAssemblerFactory - Interface in com.atlassian.webresource.api.assembler: Factory for creating web resource builders.
WebResourceDataProvider - Interface in com.atlassian.webresource.api.data: Interface for providing JSON data to a client.
WebResourceFilter - Interface in com.atlassian.webresource.api: An interface for filtering web resources.
WebResourceManager - Interface in com.atlassian.webresource.api: Manage 'css', 'javascript' and other 'resources' that are usually linked at the top of pages using <script> and <link> tags.
WebResourceModuleDescriptor - Interface in com.atlassian.webresource.api.descriptor: Missing the following; getting the composite condition, getting the transformations, getting the data providers, and getting the deprecation details.
WebResourceSet - Interface in com.atlassian.webresource.api.assembler: Set of assembled web resources and web resources contexts.
WebResourceTransformerFactory - Interface in com.atlassian.webresource.spi.transformer: Factory to create URL aware web resource transformers
WebResourceUrlProvider - Interface in com.atlassian.webresource.api: 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.
writeHtmlTags(Writer, UrlMode) - Method in interface com.atlassian.webresource.api.assembler.WebResourceSet: Write the HTML tags for this object's resources to the writer.
writeHtmlTags(Writer, UrlMode, Predicate<WebResource>) - Method in interface com.atlassian.webresource.api.assembler.WebResourceSet: Write the HTML tags for this object's resources to the writer.
writePrefetchLinks(Writer, UrlMode) - Method in interface com.atlassian.webresource.api.assembler.WebResourceSet: Write the HTML tags for non-data resources as prefetch links: <link rel="prefetch">.

A B C D E G H I L M N P Q R S T U V W
All Classes and Interfaces|All Packages