Package 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	Description
	Router(Globals globals)
protected	Router(Globals globals, List<BaseRouter<Controller>.Route> routes, boolean useAbsoluteUrl)	Needed to support legacy API.

Method Summary

Modifier and Type	Method	Description
String	buildUrlWithPrefix(String url, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String hash, String bundleHash)	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 bundleHash)
String	contextBatchUrl(String key, String type, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String bundleHash)	Url helpers.
protected Controller	createController(Globals globals, Request request, Response response)	Override this method and provide instance of the controller.
static RawRequest	decodeContexts(String encodedContexts)	Decodes context key like `batch1,batch2,-excludedBatch3,-excludedBatch4` into lists of included and excluded contexts.
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)
String	pluginResourceUrl(String pluginKey, String resourceName, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String bundleHash)
String	prebuildSourceUrl(Resource resource)
String	prebuildSourceUrl(String completeKey, String resourceName, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String bundleHash)
String	resourceSourceMapUrl(String completeKey, String resourceName, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String bundleHash)
String	resourceUrl(String completeKey, String resourceName, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String bundleHash)
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 bundleHash)
String	resourceUrlRelativeToWebResourceBatch(String completeKey, String resourceName, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String bundleHash)
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 bundleHash)
static String	unescapeSlashes(String string)
String	webResourceBatchUrl(String completeKey, String type, Map<String,String> params, boolean isResourceSupportCache, boolean isResourceSupportCdn, String resourceHash, String bundleHash)	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 Details

Router

public Router(Globals globals)

Router

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

Needed to support legacy API.

Method Details

resourceUrlAsStaticMethod

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

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 RawRequest decodeContexts(String encodedContexts)

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

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)

contextBatchUrl

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

Url helpers.

contextBatchSourceMapUrl

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

resourceUrlRelativeToContextBatch

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

resourceUrl

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

resourceSourceMapUrl

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

pluginResourceUrl

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

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 bundleHash)

prebuildSourceUrl

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

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 bundleHash)

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 bundleHash)

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 bundleHash)

Adds prefix to relative url.

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>