ninja

Class AssetsController

java.lang.Object

ninja.AssetsController

public class AssetsController
extends Object

This controller serves public resources under /public

Author:

ra

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASSETS_DIR
static String	FILENAME_PATH_PARAM

Constructor Summary

Constructors

Constructor and Description
AssetsController(HttpCacheToolkit httpCacheToolkit, MimeTypes mimeTypes, NinjaProperties ninjaProperties)

Method Summary

Modifier and Type	Method and Description
static String	getFileNameFromPathOrReturnRequestPath(Context context)
String	normalizePathWithoutTrailingSlash(String fileName) If we get - for whatever reason - a relative URL like assets/../conf/application.conf we expand that to the "real" path.
Result	serve(Context context) Deprecated.
Result	serveStatic(Context context) Serves resources from the assets directory of your application.
Result	serveWebJars(Context context) Serves resources from the assets directory of your application.

Methods inherited from class java.lang.Object

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

Field Detail

ASSETS_DIR

public static final String ASSETS_DIR

See Also:

Constant Field Values

FILENAME_PATH_PARAM

public static final String FILENAME_PATH_PARAM

See Also:

Constant Field Values

Constructor Detail

AssetsController

@Inject
public AssetsController(HttpCacheToolkit httpCacheToolkit,
                                MimeTypes mimeTypes,
                                NinjaProperties ninjaProperties)

Method Detail

serve

@Deprecated
public Result serve(Context context)

Deprecated.

Deprecated. Please use serveDir or serveFile.

serveStatic

public Result serveStatic(Context context)

Serves resources from the assets directory of your application. For instance: route: /robots.txt A request to /robots.txt will be served from /assets/robots.txt. You can also use a path like the following to serve files: route: /assets/{fileName: .*} matches /assets/app/app.css and will return /assets/app/app.css (from your jar).

serveWebJars

public Result serveWebJars(Context context)

Serves resources from the assets directory of your application. For instance: A request to /robots.txt will be served from /assets/robots.txt. Request to /public/css/app.css will be served from /assets/css/app.css.

normalizePathWithoutTrailingSlash

public String normalizePathWithoutTrailingSlash(String fileName)

If we get - for whatever reason - a relative URL like assets/../conf/application.conf we expand that to the "real" path. In the above case conf/application.conf. You should then add the assets prefix. Otherwise someone can create an attack and read all resources of our app. If we expand and normalize the incoming path this is no longer possible.

Parameters:

fileName - A potential "fileName"

Returns:

A normalized fileName.

getFileNameFromPathOrReturnRequestPath

public static String getFileNameFromPathOrReturnRequestPath(Context context)