com.atlassian.plugin.webresource.impl.http

Class Controller

java.lang.Object

com.atlassian.plugin.webresource.impl.support.http.BaseController

com.atlassian.plugin.webresource.impl.http.Controller

public class Controller
extends BaseController

Handles HTTP requests.

Since:

3.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_JSON

Fields inherited from class com.atlassian.plugin.webresource.impl.support.http.BaseController

globals, request, response

Constructor Summary

Constructors

Constructor and Description
Controller(Globals globals, Request request, Response response)

Method Summary

Modifier and Type	Method and Description
protected String	buildCacheKey(String url) Creates cache key for resource or batch.
protected boolean	checkIfCachedAndNotModified(Date updatedAt) Check if resource is not modified and replies with not-modified response if so.
protected List<Resource>	getBatchResources(Collection<String> included, LinkedHashSet<String> excluded, String type, boolean resolveDependencies, boolean withLegacyConditions) Get Resources for Batch (all types of Batch - Web Resource Batch, Super Batch, Context Batch).
protected Resource	getResourceRelativeToBatch(Collection<String> included, LinkedHashSet<String> excluded, String resourceName, boolean resolveDependencies, boolean withLegacyConditions) Get Resource relative to Batch.
protected boolean	handleNotFoundRedirectAndNotModified(Resource resource) Handle not found resources, redirects and not modified resources.
protected boolean	isSourceMapEnabled() If Source Map is enabled for the current Request.
protected void	sendCached(Content content, Map<String,String> params, boolean isCachingEnabled)
protected void	sendCachedInDevelopment(Content content, boolean isCachingEnabled)
protected void	sendCachedInProduction(Content content, boolean isCachingEnabled)
void	serveBatch(Collection<String> included, LinkedHashSet<String> excluded, String type, boolean resolveDependencies, boolean withLegacyConditions, boolean isCachingEnabled) Serves Batch (all types of Batch - Web Resource Batch, Super Batch, Context Batch).
void	serveBatchSourceMap(Collection<String> included, LinkedHashSet<String> excluded, String type, boolean resolveDependencies, boolean withLegacyConditions) Serves Source Map for Batch.
protected void	serveResource(LinkedHashSet<String> requiredResources, Resource resource, boolean applyTransformations, boolean isCachingEnabled) Serves Resource.
void	serveResource(String completeKey, String resourceName) Serves single Resource.
void	serveResourceRelativeToBatch(Collection<String> included, LinkedHashSet<String> excluded, String resourceName, boolean resolveDependencies, boolean withLegacyConditions) Serves Resource relative to Batch.
void	serveResourceRelativeToBatchSourceMap(Collection<String> included, LinkedHashSet<String> excluded, String resourceName, boolean resolveDependencies, boolean withLegacyConditions) Serves Source Map for Resource relative to Batch.
protected void	serveResources(LinkedHashSet<String> requiredResources, com.google.common.base.Supplier<Collection<Resource>> resources, boolean isCachingEnabled) Serves resources.
void	serveResourceSourceMap(String completeKey, String resourceName) Serves Source Map for single Resource.
void	serveSource(String completeKey, String resourceName) Serves Source Code of the Resource.
protected void	serveSourceMap(LinkedHashSet<String> requiredResources, Resource resource, boolean isCachingEnabled) Serves Source Map.

Methods inherited from class com.atlassian.plugin.webresource.impl.support.http.BaseController

before

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

APPLICATION_JSON

public static final String APPLICATION_JSON

See Also:

Constant Field Values

Constructor Detail

Controller

public Controller(Globals globals,
                  Request request,
                  Response response)

Method Detail

serveResource

public void serveResource(String completeKey,
                          String resourceName)

Serves single Resource.

serveResourceSourceMap

public void serveResourceSourceMap(String completeKey,
                                   String resourceName)

Serves Source Map for single Resource.

serveBatch

public void serveBatch(Collection<String> included,
                       LinkedHashSet<String> excluded,
                       String type,
                       boolean resolveDependencies,
                       boolean withLegacyConditions,
                       boolean isCachingEnabled)

Serves Batch (all types of Batch - Web Resource Batch, Super Batch, Context Batch).

Parameters:

included - keys of included Web Resources.

excluded - keys of excluded Web Resources.

type - type of Batch.

resolveDependencies - if dependencies should be resolved.

serveBatchSourceMap

public void serveBatchSourceMap(Collection<String> included,
                                LinkedHashSet<String> excluded,
                                String type,
                                boolean resolveDependencies,
                                boolean withLegacyConditions)

Serves Source Map for Batch.

getBatchResources

protected List<Resource> getBatchResources(Collection<String> included,
                                           LinkedHashSet<String> excluded,
                                           String type,
                                           boolean resolveDependencies,
                                           boolean withLegacyConditions)

Get Resources for Batch (all types of Batch - Web Resource Batch, Super Batch, Context Batch).

Parameters:

included - keys of included Web Resources.

excluded - keys of excluded Web Resources.

type - type of Batch.

resolveDependencies - if dependencies should be resolved.

serveResourceRelativeToBatch

public void serveResourceRelativeToBatch(Collection<String> included,
                                         LinkedHashSet<String> excluded,
                                         String resourceName,
                                         boolean resolveDependencies,
                                         boolean withLegacyConditions)

Serves Resource relative to Batch.

serveResourceRelativeToBatchSourceMap

public void serveResourceRelativeToBatchSourceMap(Collection<String> included,
                                                  LinkedHashSet<String> excluded,
                                                  String resourceName,
                                                  boolean resolveDependencies,
                                                  boolean withLegacyConditions)

Serves Source Map for Resource relative to Batch.

getResourceRelativeToBatch

protected Resource getResourceRelativeToBatch(Collection<String> included,
                                              LinkedHashSet<String> excluded,
                                              String resourceName,
                                              boolean resolveDependencies,
                                              boolean withLegacyConditions)

Get Resource relative to Batch.

serveSource

public void serveSource(String completeKey,
                        String resourceName)

Serves Source Code of the Resource.

serveResource

protected void serveResource(LinkedHashSet<String> requiredResources,
                             Resource resource,
                             boolean applyTransformations,
                             boolean isCachingEnabled)

Serves Resource.

Parameters:

applyTransformations - if transformations should be applied.

serveResources

protected void serveResources(LinkedHashSet<String> requiredResources,
                              com.google.common.base.Supplier<Collection<Resource>> resources,
                              boolean isCachingEnabled)

Serves resources.

serveSourceMap

protected void serveSourceMap(LinkedHashSet<String> requiredResources,
                              Resource resource,
                              boolean isCachingEnabled)

Serves Source Map.

handleNotFoundRedirectAndNotModified

protected boolean handleNotFoundRedirectAndNotModified(Resource resource)

Handle not found resources, redirects and not modified resources.

Returns:

true if request has been handled and no further processing needed.

checkIfCachedAndNotModified

protected boolean checkIfCachedAndNotModified(Date updatedAt)

Check if resource is not modified and replies with not-modified response if so.

Parameters:

updatedAt - when resource has been updated.

Returns:

true if Resources is not modified and no further processing is needed.

sendCached

protected void sendCached(Content content,
                          Map<String,String> params,
                          boolean isCachingEnabled)

sendCachedInProduction

protected void sendCachedInProduction(Content content,
                                      boolean isCachingEnabled)

sendCachedInDevelopment

protected void sendCachedInDevelopment(Content content,
                                       boolean isCachingEnabled)

buildCacheKey

protected String buildCacheKey(String url)

Creates cache key for resource or batch.

isSourceMapEnabled

protected boolean isSourceMapEnabled()

If Source Map is enabled for the current Request.