Index (Atlassian Plugins - Web Resources API 6.0.7 API)

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

A

addAllPrebakeErrors(Collection<PrebakeError>) - Method in interface com.atlassian.plugin.webresource.url.UrlBuilder
addPrebakeError(PrebakeError) - Method in interface com.atlassian.plugin.webresource.url.UrlBuilder: Allows a transform/condition to indicate that it was unable to add to the url for the given Coordinate.
addToHash(String, Object) - Method in interface com.atlassian.plugin.webresource.url.UrlBuilder: Contributes to the url's static hash
addToQueryString(String, String) - Method in interface com.atlassian.plugin.webresource.url.UrlBuilder: Contributes to the url's querystring
addToUrl(UrlBuilder) - Method in class com.atlassian.plugin.webresource.condition.SimpleUrlReadingCondition
addToUrl(UrlBuilder, Coordinate) - Method in class com.atlassian.plugin.webresource.condition.SimpleUrlReadingCondition
addToUrl(UrlBuilder) - Method in interface com.atlassian.plugin.webresource.condition.UrlReadingCondition: Called when constructing the URL as the hosting HTML page is being served.
addToUrl(UrlBuilder) - Method in interface com.atlassian.plugin.webresource.transformer.TransformerUrlBuilder: Called when constructing the URL as the hosting HTML page is being served.
addToUrl(UrlBuilder, Coordinate) - Method in interface com.atlassian.webresource.api.prebake.DimensionAwareTransformerUrlBuilder
addToUrl(UrlBuilder, Coordinate) - Method in interface com.atlassian.webresource.api.prebake.DimensionAwareUrlReadingCondition
all() - Method in interface com.atlassian.webresource.api.assembler.resource.PluginUrlResourceParams
andAbsent(String) - Method in interface com.atlassian.webresource.api.prebake.Dimensions: Adds a dimension that represents the absence of key in the query string.
andExactly(String, String...) - Method in interface com.atlassian.webresource.api.prebake.Dimensions: Adds dimensions for query param key over all the given values.
andExactly(String, Collection<String>) - Method in interface com.atlassian.webresource.api.prebake.Dimensions: Adds dimensions for query param key over all the given values.
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.
asyncDataDeadline(long, TimeUnit) - Method in interface com.atlassian.webresource.api.assembler.WebResourceAssemblerBuilder: Asynchronous data can be required with RequiredData.requireData(String, CompletionStage).
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

blacklistValues(Dimensions) - Method in interface com.atlassian.webresource.api.prebake.Dimensions: Filters the dimension values using the blacklist passed as parameter.
build() - Method in interface com.atlassian.webresource.api.assembler.WebResourceAssemblerBuilder: Constructs a WebResourceAssembler

C

cartesianProduct() - Method in interface com.atlassian.webresource.api.prebake.Dimensions: Computes the cartesian product as an unordered stream of Coordinates.
cartesianProductSize() - Method in interface com.atlassian.webresource.api.prebake.Dimensions: Computes the size of the cartesian product.
clearCache() - Method in interface com.atlassian.webresource.api.assembler.WebResourceAssemblerFactory: Deprecated.
since v3.3.2
com.atlassian.plugin.webresource - package com.atlassian.plugin.webresource
com.atlassian.plugin.webresource.condition - package com.atlassian.plugin.webresource.condition
com.atlassian.plugin.webresource.transformer - package com.atlassian.plugin.webresource.transformer
com.atlassian.plugin.webresource.url - package com.atlassian.plugin.webresource.url
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.prebake - package com.atlassian.webresource.api.prebake: Provides the ability to pre-compute ("prebake") all possible resource urls supported by this application, for a given set of requireContext/requireResource calls.
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
computeDimensions() - Method in class com.atlassian.plugin.webresource.condition.SimpleUrlReadingCondition
computeDimensions() - Method in interface com.atlassian.webresource.api.prebake.DimensionAwareUrlReadingCondition
computeDimensions() - Method in interface com.atlassian.webresource.api.prebake.DimensionAwareWebResourceTransformerFactory
conditionalComment() - Method in interface com.atlassian.webresource.api.assembler.resource.PluginUrlResourceParams: Deprecated.
Since v4.0. Always returns an empty string. Will be removed in v5.0.
Coordinate - Interface in com.atlassian.webresource.api.prebake: A Coordinate represents a single possible query-string combination.
copy() - Method in interface com.atlassian.webresource.api.assembler.WebResourceAssembler
copyTo(UrlBuilder, String) - Method in interface com.atlassian.webresource.api.prebake.Coordinate: Copies the given query key/value to the url builder, if this Coordinate contains that key.
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 com.atlassian.webresource.api.assembler.resource.ResourcePhase: Method responsible for managing the default phase.
DimensionAwareTransformerUrlBuilder - Interface in com.atlassian.webresource.api.prebake: A transformer that supports prebaking.
DimensionAwareUrlReadingCondition - Interface in com.atlassian.webresource.api.prebake: A condition that supports prebaking.
DimensionAwareWebResourceTransformerFactory - Interface in com.atlassian.webresource.api.prebake: A transformer that supports prebaking.
Dimensions - Interface in com.atlassian.webresource.api.prebake: Represents all the possible "dimensions" or set of possible combinations of query parameters that a transformer or condition can support.
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

empty() - Static method in interface com.atlassian.webresource.api.prebake.Dimensions: Factory for an empty dimension object.
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.

F

filePath() - Method in class com.atlassian.plugin.webresource.transformer.TransformableResource: Deprecated.
since 5.0.0, will be removed in next major version.
fromMap(Map<String, List<String>>) - Static method in interface com.atlassian.webresource.api.prebake.Dimensions: Initialises a new Dimensions instance from a Map.

G

get(String) - Method in class com.atlassian.plugin.webresource.QueryParams
get(String) - Method in interface com.atlassian.webresource.api.prebake.Coordinate: The value for a given query param, or null if that query param is not present.
getBatchType() - Method in interface com.atlassian.webresource.api.assembler.resource.PluginUrlResource
getCompleteKey() - Method in class com.atlassian.webresource.api.assembler.resource.CompleteWebResourceKey
getData() - Method in interface com.atlassian.webresource.api.data.PluginDataResource
getJsonable() - Method in interface com.atlassian.webresource.api.data.PluginDataResource: Deprecated.
use getData() instead.
getKey() - Method in interface com.atlassian.webresource.api.assembler.resource.PluginUrlResource
getKey() - Method in interface com.atlassian.webresource.api.data.PluginDataResource
getKeys() - Method in interface com.atlassian.webresource.api.prebake.Coordinate: Get list of all keys.
getModuleKey() - Method in class com.atlassian.plugin.webresource.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 com.atlassian.webresource.api.assembler.resource.ResourcePhase
getPluginKey() - Method in class com.atlassian.plugin.webresource.transformer.TransformerParameters
getPluginKey() - Method in class com.atlassian.webresource.api.assembler.resource.CompleteWebResourceKey
getPrebakeErrors() - Method in interface com.atlassian.webresource.api.assembler.resource.PluginUrlResource: If this url was generated as part of a pre-bake, this indicates any errors that occured.
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
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.plugin.webresource.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

ieOnly() - Method in interface com.atlassian.webresource.api.assembler.resource.PluginUrlResourceParams: Deprecated.
Since v4.0. Always returns false. Will be removed in v5.0.
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.plugin.webresource.condition.SimpleUrlReadingCondition
init(Map<String, String>) - Method in interface com.atlassian.plugin.webresource.condition.UrlReadingCondition: Called after creation and autowiring.
isComplete() - Method in interface com.atlassian.webresource.api.assembler.WebResourceSet: If promises of data have been required via RequiredData.requireData(String, CompletionStage) then this WebResourceSet will only contain the completed promises.
isConditionTrue() - Method in class com.atlassian.plugin.webresource.condition.SimpleUrlReadingCondition
isTainted() - Method in interface com.atlassian.webresource.api.assembler.resource.PluginUrlResource

L

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

M

makeResourceTransformer(TransformerParameters) - Method in interface com.atlassian.plugin.webresource.transformer.WebResourceTransformerFactory: Return the transformer for this transform
makeResourceTransformer(Element, TransformerParameters) - Method in interface com.atlassian.plugin.webresource.transformer.WebResourceTransformerFactory: Deprecated.
this method is added as a temporary solution to support Bitbucket Server's AbstractUrlReadingClientWebFragmentTransformer, and will be removed after Bitbucket 7.0 is released
makeUrlBuilder(TransformerParameters) - Method in interface com.atlassian.plugin.webresource.transformer.WebResourceTransformerFactory: Return the URL builder for this transform
makeUrlBuilder(TransformerParameters) - Method in interface com.atlassian.webresource.api.prebake.DimensionAwareWebResourceTransformerFactory
media() - Method in interface com.atlassian.webresource.api.assembler.resource.PluginCssResourceParams

N

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

O

of(Map<String, String>) - Static method in class com.atlassian.plugin.webresource.QueryParams
other() - Method in interface com.atlassian.webresource.api.assembler.resource.PluginUrlResourceParams

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 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 - eg conditional comment, media query, and other attributes on an HTML tag eg charset
pollIncludedResources() - Method in interface com.atlassian.webresource.api.assembler.AssembledResources: Similar to AssembledResources.drainIncludedResources(), but will block until there is at least one complete promise to return.
PrebakeError - Interface in com.atlassian.webresource.api.assembler.resource: A marking interface that identifies an error generated while prebaking resources.
PrebakeWarning - Interface in com.atlassian.webresource.api.assembler.resource: A marking interface that identifies a warning condition generated while prebaking resources.
product(Dimensions) - Method in interface com.atlassian.webresource.api.prebake.Dimensions: Combines two dimensions, representing all possible combinations of both dimensions.

Q

queryKey() - Method in class com.atlassian.plugin.webresource.condition.SimpleUrlReadingCondition
QueryParams - Class in com.atlassian.plugin.webresource: Provides access to querystring params.

R

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().
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.
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, 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
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, CompletionStage<Jsonable>) - Method in interface com.atlassian.webresource.api.assembler.RequiredData: Specifies that JSON data with the given key should be avaialbe to the client-side webpage at some point in the future.
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.
requireModule(String) - Method in interface com.atlassian.webresource.api.assembler.RequiredResources: Specifies that the given module should be included on the next call to drainIncludedResources() with ResourcePhase.defaultPhase().
requireModule(ResourcePhase, String) - Method in interface com.atlassian.webresource.api.assembler.RequiredResources: Specifies that the given module should be included on the next call to drainIncludedResources(), 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().
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.
requireSuperbatch(ResourcePhase) - Method in interface com.atlassian.webresource.api.assembler.RequiredResources: Sets resource phase for superbatch context.
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().
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.
ResourcePhase - Enum 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.plugin.webresource.condition.SimpleUrlReadingCondition
shouldDisplay(QueryParams) - Method in interface com.atlassian.plugin.webresource.condition.UrlReadingCondition: Determine whether the web fragment should be displayed.
SimpleUrlReadingCondition - Class in com.atlassian.plugin.webresource.condition: Simple implementation for DimensionAwareUrlReadingCondition implementations.
SimpleUrlReadingCondition() - Constructor for class com.atlassian.plugin.webresource.condition.SimpleUrlReadingCondition

T

toString() - Method in class com.atlassian.plugin.webresource.QueryParams
toString() - Method in class com.atlassian.webresource.api.assembler.resource.CompleteWebResourceKey
transform(TransformableResource, QueryParams) - Method in interface com.atlassian.plugin.webresource.transformer.UrlReadingWebResourceTransformer: Transforms the downloadable resource by returning a new one.
TransformableResource - Class in com.atlassian.plugin.webresource.transformer: Describes a resource for transformation
TransformableResource(ResourceLocation, DownloadableResource) - Constructor for class com.atlassian.plugin.webresource.transformer.TransformableResource
TransformableResource(ResourceLocation, String, DownloadableResource) - Constructor for class com.atlassian.plugin.webresource.transformer.TransformableResource: Deprecated.
since 5.0.0, will be removed in next major version, use `TransformableResource(ResourceLocation location, DownloadableResource nextResource)` instead.
TransformerParameters - Class in com.atlassian.plugin.webresource.transformer: Transformer parameters to be passed to WebResourceTransformerFactory's methods
TransformerParameters(String, String) - Constructor for class com.atlassian.plugin.webresource.transformer.TransformerParameters
TransformerParameters(String, String, String) - Constructor for class com.atlassian.plugin.webresource.transformer.TransformerParameters: Deprecated.
TransformerUrlBuilder - Interface in com.atlassian.plugin.webresource.transformer: The part of a transformer that contributes to the URL
TwoPhaseResourceTransformer - Interface in com.atlassian.plugin.webresource.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.plugin.webresource.url: Interface for conditions / transformers to contribute information to a resource URL.
UrlMode - Enum in com.atlassian.webresource.api: A formatting mode for URLs.
UrlReadingCondition - Interface in com.atlassian.plugin.webresource.condition: Condition that contributes to the URL.
UrlReadingWebResourceTransformer - Interface in com.atlassian.plugin.webresource.transformer: The part of a transformer that reads the config and url params and does the actual resource transformation.

V

valueOf(String) - Static method in enum com.atlassian.webresource.api.assembler.resource.PluginUrlResource.BatchType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.atlassian.webresource.api.assembler.resource.ResourcePhase: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.atlassian.webresource.api.UrlMode: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.atlassian.webresource.api.assembler.resource.PluginUrlResource.BatchType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.atlassian.webresource.api.assembler.resource.ResourcePhase: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.atlassian.webresource.api.UrlMode: Returns an array containing the constants of this enum type, 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.
WebResourceSet - Interface in com.atlassian.webresource.api.assembler: Set of assembled web resources and web resources contexts.
WebResourceTransformerFactory - Interface in com.atlassian.plugin.webresource.transformer: Factory to create URL aware web resource transformers
whitelistValues(Dimensions) - Method in interface com.atlassian.webresource.api.prebake.Dimensions: Filters the dimension values using the whitelist passed as parameter.
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 F G H I L M N O P Q R S T U V W