org.nustaq.kontraktor.remoting.http.javascript

Class DependencyResolver

java.lang.Object

org.nustaq.kontraktor.remoting.http.javascript.DependencyResolver

public class DependencyResolver
extends Object

Created by ruedi on 06.04.2015. Algorithm: starting from the root component (searched via resource path), resolve all dependencies resulting in a list of (ordered according to dependencies) directories. The resulting list is then searched in order when doing lookup/merge

Field Summary

Fields

Modifier and Type	Field and Description
protected String	baseDir
protected File[]	lookupDirs
protected String	lookupPrefix
protected String	mergedPrefix
protected File[]	resourcePath
protected String	rootComponent

Constructor Summary

Constructors

Constructor and Description
DependencyResolver(String lookupPrefix, String mergedPrefix, String rootComponent, String[] resourcePath)

Method Summary

Modifier and Type	Method and Description
byte[]	createScriptTags(List<String> jsFileNames) returns document.write() script tags for each dependent js library.
List<String>	findFilesInDirs(java.util.function.BiFunction<String,String,Boolean> filter) iterates all component directorys, list each (nonrecursively) and return all component/filenames where filter returns true.
String	getBaseDir()
protected List<File>	getDependentDirs(String comp, List<File> li, HashSet<String> alreadyCheckedDependencies) creates a lookup path for given component.
String	getRootComponent()
List<File>	locateComponent(String name)
File	locateResource(String name) iterate component directories in order and return full path of first file matching
byte[]	mergeBinary(List<String> fileNames) lookup (ordered directory computed by resourcepath) and merge scripts into a single byte[].
byte[]	mergeScripts(List<String> fileNames) lookup (ordered directory computed by resourcepath) and merge scripts into a single byte[].
byte[]	mergeTextSnippets(List<String> names, String startTag, String endTag) locate ressource file on the directory path and merge them in a document.write file.
protected DependencyResolver	setBaseDir(String baseDir)
protected DependencyResolver	setResourcePath(String... path)
protected void	setRootComponent(String name)

Methods inherited from class java.lang.Object

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

Field Detail

mergedPrefix

protected String mergedPrefix

lookupPrefix

protected String lookupPrefix

resourcePath

protected File[] resourcePath

lookupDirs

protected File[] lookupDirs

baseDir

protected String baseDir

rootComponent

protected String rootComponent

Constructor Detail

DependencyResolver

public DependencyResolver(String lookupPrefix,
                          String mergedPrefix,
                          String rootComponent,
                          String[] resourcePath)

Method Detail

getBaseDir

public String getBaseDir()

setBaseDir

protected DependencyResolver setBaseDir(String baseDir)

setResourcePath

protected DependencyResolver setResourcePath(String... path)

setRootComponent

protected void setRootComponent(String name)

getRootComponent

public String getRootComponent()

findFilesInDirs

public List<String> findFilesInDirs(java.util.function.BiFunction<String,String,Boolean> filter)

iterates all component directorys, list each (nonrecursively) and return all component/filenames where filter returns true.

Parameters:

filter -

Returns:

locateResource

public File locateResource(String name)

iterate component directories in order and return full path of first file matching

Parameters:

name -

Returns:

locateComponent

public List<File> locateComponent(String name)

Parameters:

name -

Returns:

a priority ordered list of directories containing files for a given component.

getDependentDirs

protected List<File> getDependentDirs(String comp,
                                      List<File> li,
                                      HashSet<String> alreadyCheckedDependencies)
                               throws IOException

creates a lookup path for given component. (1) resourcePath is searched for a directory named 'comp', file is added (2) if the newly added directory contains a 'dep.kson' dependency file, recursively coninue wiht (1) for each dependent component

Parameters:

comp - - component name to lookup

li - - growing list of files

alreadyCheckedDependencies - - already visited components

Returns:

an ordered list of directories which can be searched later on when doing single file lookup

Throws:

IOException

createScriptTags

public byte[] createScriptTags(List<String> jsFileNames)

returns document.write() script tags for each dependent js library. DEV MODE only. In production mode, all .js will be merged into a single document, which is hard to debug with. Therefore in development just generate a bunch of single JS-file includes

Parameters:

jsFileNames -

Returns:

mergeScripts

public byte[] mergeScripts(List<String> fileNames)

lookup (ordered directory computed by resourcepath) and merge scripts into a single byte[]. use in production mode (debugging will be hard) for dev createScriptTags() is used instead

Parameters:

fileNames - list script (.js) filenames

Returns:

mergeBinary

public byte[] mergeBinary(List<String> fileNames)

lookup (ordered directory computed by resourcepath) and merge scripts into a single byte[].

Parameters:

fileNames - list of filenames to merge

Returns:

mergeTextSnippets

public byte[] mergeTextSnippets(List<String> names,
                                String startTag,
                                String endTag)

locate ressource file on the directory path and merge them in a document.write file. Does some text replacements (?? forgot why)

Parameters:

names -

Returns: