org.bladerunnerjs.api

Class BRJS

java.lang.Object

org.bladerunnerjs.model.engine.AbstractNode

org.bladerunnerjs.model.engine.AbstractRootNode

org.bladerunnerjs.model.AbstractBRJSRootNode

org.bladerunnerjs.api.BRJS

All Implemented Interfaces:

BRJSNode, org.bladerunnerjs.model.engine.Node, org.bladerunnerjs.model.engine.RootNode

public class BRJS
extends org.bladerunnerjs.model.AbstractBRJSRootNode

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BRJS.Messages

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PRODUCT_NAME

Fields inherited from class org.bladerunnerjs.model.engine.AbstractRootNode

allowInvalidRootDirectories, loggerFactory, rootDir

Fields inherited from class org.bladerunnerjs.model.engine.AbstractNode

dir, rootNode

Constructor Summary

Constructors

Constructor and Description
BRJS(java.io.File brjsDir, java.io.File workingDir, PluginLocator pluginLocator, org.bladerunnerjs.utility.LoggerFactory loggerFactory, org.bladerunnerjs.model.AppVersionGenerator appVersionGenerator)

Method Summary

Modifier and Type	Method and Description
void	addTemplateTransformations(java.util.Map<java.lang.String,java.lang.String> transformations) Template transformation are used to replace aliases for namings that are automatically replaced when creating an node.
App	app(java.lang.String appName)
DirNode	appJars()
ApplicationServer	applicationServer()
ApplicationServer	applicationServer(int port)
java.util.List<App>	apps()
MemoizedFile	appsFolder()
BladerunnerConf	bladerunnerConf()
void	close()
DirNode	conf()
org.bladerunnerjs.model.TemplateGroup	confTemplateGroup(java.lang.String templateGroupName)
java.util.List<org.bladerunnerjs.model.TemplateGroup>	confTemplateGroups()
void	create()
FileObserver	fileObserver()
void	finalize()
org.bladerunnerjs.model.AppVersionGenerator	getAppVersionGenerator()
FileModificationRegistry	getFileModificationRegistry()
org.bladerunnerjs.utility.LoggerFactory	getLoggerFactory()
MemoizedFile	getMemoizedFile(java.io.File file)
MemoizedFile	getMemoizedFile(java.io.File dir, java.lang.String name)
MemoizedFile	getMemoizedFile(java.lang.String filePath)
org.bladerunnerjs.model.IO	io()
boolean	isRootDir(java.io.File dir)
DirNode	jsPatches()
org.bladerunnerjs.utility.JsStyleAccessor	jsStyleAccessor()
BundlableNode	locateFirstBundlableAncestorNode(java.io.File file)
MemoizedFile	loginRealmConf()
org.bladerunnerjs.plugin.utility.PluginAccessor	plugins()
void	populate(java.lang.String templateGroup) Any BRJSNode may be populated according to a pre-existing template.
int	runCommand(java.lang.String... args)
int	runUserCommand(org.bladerunnerjs.model.LogLevelAccessor logLevelAccessor, java.lang.String... args)
MemoizedFile	sdkFolder()
DirNode	sdkJsLibsDir()
org.bladerunnerjs.model.SdkJsLib	sdkLib(java.lang.String libName)
java.util.List<org.bladerunnerjs.model.SdkJsLib>	sdkLibs()
DirNode	sdkRoot()
org.bladerunnerjs.model.TemplateGroup	sdkTemplateGroup(java.lang.String templateGroupName)
java.util.List<org.bladerunnerjs.model.TemplateGroup>	sdkTemplateGroups()
App	systemApp(java.lang.String appName)
java.util.List<App>	systemApps()
DirNode	systemJars()
DirNode	testJars()
DirNode	testResults()
TestRunnerConf	testRunnerConf()
java.lang.String	toString()
App	userApp(java.lang.String appName)
java.util.List<App>	userApps()
DirNode	userJars()
MemoizedFile	usersPropertiesConf()
org.bladerunnerjs.utility.VersionInfo	versionInfo()

Methods inherited from class org.bladerunnerjs.model.AbstractBRJSRootNode

getTemplateName, root

Methods inherited from class org.bladerunnerjs.model.engine.AbstractRootNode

getRegisteredNode, getRegisteredNode, getRegisteredNodes, isNodeRegistered, locateAncestorNodeOfClass, locateAncestorNodeOfClass, locateAncestorNodeOfClass, locateFirstAncestorNode, locateFirstAncestorNode, logger, registerNode

Methods inherited from class org.bladerunnerjs.model.engine.AbstractNode

addObserver, addObserver, containsFile, createDefaultNode, delete, dir, dirExists, discoverAllChildren, exists, file, getObservers, getTypeName, incrementChildFileVersions, incrementFileVersion, memoizedScopeFiles, nodeProperties, notifyObservers, parentNode, ready, rootStorageDir, setNodeDir, storageDir, storageFile

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bladerunnerjs.model.engine.Node

addObserver, addObserver, containsFile, delete, dir, dirExists, discoverAllChildren, exists, file, getObservers, getTypeName, incrementChildFileVersions, incrementFileVersion, memoizedScopeFiles, nodeProperties, notifyObservers, parentNode, ready, storageDir, storageFile

Field Detail

PRODUCT_NAME

public static final java.lang.String PRODUCT_NAME

See Also:

Constant Field Values

Constructor Detail

BRJS

public BRJS(java.io.File brjsDir,
            java.io.File workingDir,
            PluginLocator pluginLocator,
            org.bladerunnerjs.utility.LoggerFactory loggerFactory,
            org.bladerunnerjs.model.AppVersionGenerator appVersionGenerator)
     throws InvalidSdkDirectoryException

Throws:

InvalidSdkDirectoryException

Method Detail

appsFolder

public MemoizedFile appsFolder()

sdkFolder

public MemoizedFile sdkFolder()

isRootDir

public boolean isRootDir(java.io.File dir)

addTemplateTransformations

public void addTemplateTransformations(java.util.Map<java.lang.String,java.lang.String> transformations)
                                throws ModelUpdateException

Description copied from interface: BRJSNode

Template transformation are used to replace aliases for namings that are automatically replaced when creating an node. They may be added to any template and must be prefix by `@` to indicate that the token will be replaced. The method applies these replacements to the BRJSNode.

Parameters:

transformations - a Map of Strings to Strings where the key is the token and the value is the String it will be replaced with * @see Custom Templates

Throws:

ModelUpdateException - for any exceptions thrown while calculating node template transformations

create

public void create()
            throws javax.naming.InvalidNameException,
                   ModelUpdateException

Specified by:

create in interface org.bladerunnerjs.model.engine.Node

Overrides:

create in class org.bladerunnerjs.model.engine.AbstractNode

Throws:

javax.naming.InvalidNameException

ModelUpdateException

populate

public void populate(java.lang.String templateGroup)
              throws javax.naming.InvalidNameException,
                     ModelUpdateException,
                     TemplateInstallationException

Description copied from interface: BRJSNode

Any BRJSNode may be populated according to a pre-existing template. The method will create the files and folders existing in the specified template, including their content, within the BRJSNode. This method is to help with consistency among your entities and may be used, for example, to adhere to certain programming or modular styles.

Specified by:

populate in interface BRJSNode

Overrides:

populate in class org.bladerunnerjs.model.AbstractBRJSRootNode

Parameters:

templateGroup - a String that represents the name by which the templates therein will be referenced when creating new nodes. The templateGroup may contain templates for various BRJS entities, and the one corresponding to your current BRJSNode type will be retrieved automatically.

Throws:

javax.naming.InvalidNameException - if the node may not be created due to an invalid name associated to it

ModelUpdateException - for other non-BRJS-specific issues

TemplateInstallationException - if the template has not been found

finalize

public void finalize()
              throws java.io.IOException,
                     java.lang.InterruptedException

Overrides:

finalize in class java.lang.Object

Throws:

java.io.IOException

java.lang.InterruptedException

close

public void close()
           throws java.io.IOException,
                  java.lang.InterruptedException

Throws:

java.io.IOException

java.lang.InterruptedException

locateFirstBundlableAncestorNode

public BundlableNode locateFirstBundlableAncestorNode(java.io.File file)
                                               throws InvalidBundlableNodeException

Throws:

InvalidBundlableNodeException

io

public org.bladerunnerjs.model.IO io()

jsStyleAccessor

public org.bladerunnerjs.utility.JsStyleAccessor jsStyleAccessor()

apps

public java.util.List<App> apps()

app

public App app(java.lang.String appName)

userApps

public java.util.List<App> userApps()

userApp

public App userApp(java.lang.String appName)

systemApps

public java.util.List<App> systemApps()

systemApp

public App systemApp(java.lang.String appName)

sdkJsLibsDir

public DirNode sdkJsLibsDir()

sdkLibs

public java.util.List<org.bladerunnerjs.model.SdkJsLib> sdkLibs()

sdkLib

public org.bladerunnerjs.model.SdkJsLib sdkLib(java.lang.String libName)

jsPatches

public DirNode jsPatches()

confTemplateGroups

public java.util.List<org.bladerunnerjs.model.TemplateGroup> confTemplateGroups()

confTemplateGroup

public org.bladerunnerjs.model.TemplateGroup confTemplateGroup(java.lang.String templateGroupName)

sdkTemplateGroups

public java.util.List<org.bladerunnerjs.model.TemplateGroup> sdkTemplateGroups()

sdkTemplateGroup

public org.bladerunnerjs.model.TemplateGroup sdkTemplateGroup(java.lang.String templateGroupName)

testResults

public DirNode testResults()

appJars

public DirNode appJars()

conf

public DirNode conf()

systemJars

public DirNode systemJars()

testJars

public DirNode testJars()

userJars

public DirNode userJars()

versionInfo

public org.bladerunnerjs.utility.VersionInfo versionInfo()

loginRealmConf

public MemoizedFile loginRealmConf()

usersPropertiesConf

public MemoizedFile usersPropertiesConf()

bladerunnerConf

public BladerunnerConf bladerunnerConf()
                                throws ConfigException

Throws:

ConfigException

testRunnerConf

public TestRunnerConf testRunnerConf()
                              throws ConfigException

Throws:

ConfigException

sdkRoot

public DirNode sdkRoot()

plugins

public org.bladerunnerjs.plugin.utility.PluginAccessor plugins()

runCommand

public int runCommand(java.lang.String... args)
               throws NoSuchCommandException,
                      CommandArgumentsException,
                      CommandOperationException

Throws:

NoSuchCommandException

CommandArgumentsException

CommandOperationException

runUserCommand

public int runUserCommand(org.bladerunnerjs.model.LogLevelAccessor logLevelAccessor,
                          java.lang.String... args)
                   throws CommandOperationException

Throws:

CommandOperationException

applicationServer

public ApplicationServer applicationServer()
                                    throws ConfigException

Throws:

ConfigException

applicationServer

public ApplicationServer applicationServer(int port)

getLoggerFactory

public org.bladerunnerjs.utility.LoggerFactory getLoggerFactory()

getAppVersionGenerator

public org.bladerunnerjs.model.AppVersionGenerator getAppVersionGenerator()

toString

public java.lang.String toString()

Overrides:

toString in class org.bladerunnerjs.model.engine.AbstractNode

getFileModificationRegistry

public FileModificationRegistry getFileModificationRegistry()

getMemoizedFile

public MemoizedFile getMemoizedFile(java.lang.String filePath)

getMemoizedFile

public MemoizedFile getMemoizedFile(java.io.File file)

getMemoizedFile

public MemoizedFile getMemoizedFile(java.io.File dir,
                                    java.lang.String name)

fileObserver

public FileObserver fileObserver()
                          throws ConfigException,
                                 java.io.IOException

Throws:

ConfigException

java.io.IOException