com.atlassian.plugin.webresource.impl.http

Class Router

java.lang.Object

com.atlassian.plugin.webresource.impl.support.http.BaseRouter<Controller>

com.atlassian.plugin.webresource.impl.http.Router

public class Router
extends BaseRouter<Controller>

Generates urls and route requests to proper handlers.

Since:

3.3

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.plugin.webresource.impl.support.http.BaseRouter

BaseRouter.Handler, BaseRouter.Route

Field Summary

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

globals, routes, useAbsoluteUrl

Constructor Summary

Constructors

Modifier	Constructor and Description
	Router(Globals globals)
protected	Router(Globals globals, List<BaseRouter.Route> routes, boolean useAbsoluteUrl) Needed to support legacy API.

Method Summary

Modifier and Type	Method and Description
String	buildUrlWithPrefix(String url, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String hash, String version) Adds prefix to relative url.
Router	cloneWithNewUrlMode(boolean useAbsoluteUrl) Needed to support legacy API.
String	contextBatchSourceMapUrl(String key, String type, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String resourceVersion)
String	contextBatchUrl(String key, String type, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String resourceVersion) Url helpers.
protected Controller	createController(Globals globals, Request request, Response response) Override this method and provide instance of the controller.
static Tuple<Collection<String>,Collection<String>>	decodeContexts(String encodedContexts) Decodes context key like `batch1,batch2,-excludedBatch3,-excludedBatch4` into lists of included and excluded contexts.
static Tuple<Collection<String>,LinkedHashSet<String>>	decodeContextsAsWebResources(String encodedContexts) Decodes list of Contexts Keys into Virtual Resources Keys.
static String	encodeContexts(Collection<String> includedContexts, Iterable<String> excludedContexts) Encodes lists of included and excluded contexts into single key like `batch1,batch2,-excludedBatch3, -excludedBatch4`.
static String	escapeSlashes(String string)
static boolean	isSourceMap(Request request) If the request is source map.
String	pluginResourceUrl(String pluginKey, String resourceName, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String resourceVersion)
String	prebuildSourceUrl(Resource resource)
String	prebuildSourceUrl(String completeKey, String resourceName, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String resourceVersion)
String	resourceSourceMapUrl(String completeKey, String resourceName, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String resourceVersion)
String	resourceUrl(String completeKey, String resourceName, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String resourceVersion)
static String	resourceUrlAsStaticMethod(String completeKey, String resourceName, Map<String,String> params)
String	resourceUrlRelativeToContextBatch(String key, String type, String resourceName, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String resourceVersion)
String	resourceUrlRelativeToWebResourceBatch(String completeKey, String resourceName, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String resourceVersion)
String	resourceUrlWithoutHash(Resource resource, Map<String,String> params)
String	sourceMapUrl(String resourceUrl, Map<String,String> generatedParams)
static String	sourceMapUrlToUrl(String sourceMapUrl) Converting source map url to url, removes `.map` from url.
String	sourceUrl(Resource resource)
String	sourceUrl(String completeKey, String resourceName, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String resourceVersion)
protected static Collection<String>	turnContextsIntoVirtualResources(Collection<String> contexts) Decodes list of Contexts Keys into Virtual Resources Keys.
static String	unescapeSlashes(String string)
String	webResourceBatchUrl(String completeKey, String type, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String resourceVersion) It is important for the url structure to be: 1.

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

addRoute, buildUrl, buildUrl, callHandler, canDispatch, dispatch, interpolate, isUrlTooLong, joinWithSlashWithoutEmpty, parseWithRe, routeToRe

Methods inherited from class java.lang.Object

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

Constructor Detail

Router

public Router(Globals globals)

Router

protected Router(Globals globals,
                 List<BaseRouter.Route> routes,
                 boolean useAbsoluteUrl)

Needed to support legacy API.

Method Detail

contextBatchUrl

public String contextBatchUrl(String key,
                              String type,
                              Map<String,String> params,
                              boolean isResourceSupportCache,
                              boolean isResourceSupportCdn,
                              String resourceHash,
                              String resourceVersion)

Url helpers.

contextBatchSourceMapUrl

public String contextBatchSourceMapUrl(String key,
                                       String type,
                                       Map<String,String> params,
                                       boolean isResourceSupportCache,
                                       boolean isResourceSupportCdn,
                                       String resourceHash,
                                       String resourceVersion)

resourceUrlRelativeToContextBatch

public String resourceUrlRelativeToContextBatch(String key,
                                                String type,
                                                String resourceName,
                                                Map<String,String> params,
                                                boolean isResourceSupportCache,
                                                boolean isResourceSupportCdn,
                                                String resourceHash,
                                                String resourceVersion)

resourceUrlAsStaticMethod

public static String resourceUrlAsStaticMethod(String completeKey,
                                               String resourceName,
                                               Map<String,String> params)

resourceUrl

public String resourceUrl(String completeKey,
                          String resourceName,
                          Map<String,String> params,
                          boolean isResourceSupportCache,
                          boolean isResourceSupportCdn,
                          String resourceHash,
                          String resourceVersion)

resourceSourceMapUrl

public String resourceSourceMapUrl(String completeKey,
                                   String resourceName,
                                   Map<String,String> params,
                                   boolean isResourceSupportCache,
                                   boolean isResourceSupportCdn,
                                   String resourceHash,
                                   String resourceVersion)

pluginResourceUrl

public String pluginResourceUrl(String pluginKey,
                                String resourceName,
                                Map<String,String> params,
                                boolean isResourceSupportCache,
                                boolean isResourceSupportCdn,
                                String resourceHash,
                                String resourceVersion)

resourceUrlWithoutHash

public String resourceUrlWithoutHash(Resource resource,
                                     Map<String,String> params)

sourceUrl

public String sourceUrl(String completeKey,
                        String resourceName,
                        Map<String,String> params,
                        boolean isResourceSupportCache,
                        boolean isResourceSupportCdn,
                        String resourceHash,
                        String resourceVersion)

prebuildSourceUrl

public String prebuildSourceUrl(String completeKey,
                                String resourceName,
                                Map<String,String> params,
                                boolean isResourceSupportCache,
                                boolean isResourceSupportCdn,
                                String resourceHash,
                                String resourceVersion)

sourceUrl

public String sourceUrl(Resource resource)

prebuildSourceUrl

public String prebuildSourceUrl(Resource resource)

webResourceBatchUrl

public String webResourceBatchUrl(String completeKey,
                                  String type,
                                  Map<String,String> params,
                                  boolean isResourceSupportCache,
                                  boolean isResourceSupportCdn,
                                  String resourceHash,
                                  String resourceVersion)

It is important for the url structure to be: 1. the same number of sectioned paths as the SinglePluginResource 2. include the module complete key in the path before the resource name This is due to css resources referencing other resources such as images in relative path forms.

resourceUrlRelativeToWebResourceBatch

public String resourceUrlRelativeToWebResourceBatch(String completeKey,
                                                    String resourceName,
                                                    Map<String,String> params,
                                                    boolean isResourceSupportCache,
                                                    boolean isResourceSupportCdn,
                                                    String resourceHash,
                                                    String resourceVersion)

sourceMapUrl

public String sourceMapUrl(String resourceUrl,
                           Map<String,String> generatedParams)

cloneWithNewUrlMode

public Router cloneWithNewUrlMode(boolean useAbsoluteUrl)

Needed to support legacy API.

buildUrlWithPrefix

public String buildUrlWithPrefix(String url,
                                 Map<String,String> params,
                                 boolean isResourceSupportCache,
                                 boolean isResourceSupportCdn,
                                 String hash,
                                 String version)

Adds prefix to relative url.

encodeContexts

public static String encodeContexts(Collection<String> includedContexts,
                                    Iterable<String> excludedContexts)

Encodes lists of included and excluded contexts into single key like `batch1,batch2,-excludedBatch3, -excludedBatch4`.

decodeContexts

public static Tuple<Collection<String>,Collection<String>> decodeContexts(String encodedContexts)

Decodes context key like `batch1,batch2,-excludedBatch3,-excludedBatch4` into lists of included and excluded contexts.

decodeContextsAsWebResources

public static Tuple<Collection<String>,LinkedHashSet<String>> decodeContextsAsWebResources(String encodedContexts)

Decodes list of Contexts Keys into Virtual Resources Keys.

turnContextsIntoVirtualResources

protected static Collection<String> turnContextsIntoVirtualResources(Collection<String> contexts)

Decodes list of Contexts Keys into Virtual Resources Keys.

createController

protected Controller createController(Globals globals,
                                      Request request,
                                      Response response)

Description copied from class: BaseRouter

Override this method and provide instance of the controller.

Specified by:

createController in class BaseRouter<Controller>

isSourceMap

public static boolean isSourceMap(Request request)

If the request is source map.

sourceMapUrlToUrl

public static String sourceMapUrlToUrl(String sourceMapUrl)

Converting source map url to url, removes `.map` from url.

escapeSlashes

public static String escapeSlashes(String string)

unescapeSlashes

public static String unescapeSlashes(String string)