org.bladerunnerjs.api

Interface BundlableNode

All Superinterfaces:

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

All Known Subinterfaces:

BrowsableNode

All Known Implementing Classes:

org.bladerunnerjs.model.AbstractBrowsableNode, org.bladerunnerjs.model.AbstractBundlableNode, Aspect, BladesetWorkbench, BladeWorkbench, TestPack, Workbench

public interface BundlableNode
extends org.bladerunnerjs.model.engine.Node, org.bladerunnerjs.model.AssetContainer

Any BRJS-specific entity that will be bundled and which may handle logical requests.

Method Summary

Modifier and Type	Method and Description
java.util.List<Asset>	assets(Asset asset, java.util.List<java.lang.String> requirePaths) The method returns all the Assets that are required by the parameter Asset through the contained require paths.
BundleSet	getBundleSet() The method retrieves the BundleSet corresponding to the current BundableNode for when it is necessary to deploy it.
LinkedAsset	getLinkedAsset(java.lang.String requirePath) The method retrieves the resource specified by the require path.
ResponseContent	handleLogicalRequest(java.lang.String logicalRequestPath, BundleSet bundleSet, org.bladerunnerjs.model.UrlContentAccessor contentAccessor, java.lang.String version) Handle a given request using the BundleSet provided.
ResponseContent	handleLogicalRequest(java.lang.String logicalRequestPath, org.bladerunnerjs.model.UrlContentAccessor contentAccessor, java.lang.String version) The method represents a bundle request and will deliver the response in the form of bundled resources.
java.util.List<LinkedAsset>	seedAssets() The method retrieves the a List of LinkedAsset that are located within the current BundableNode.

Methods inherited from interface org.bladerunnerjs.model.AssetContainer

app, asset, assets, canonicaliseRequirePath, isNamespaceEnforced, requirePrefix, scopeAssetContainers

Methods inherited from interface org.bladerunnerjs.api.BRJSNode

addTemplateTransformations, getTemplateName, populate

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

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

Method Detail

getLinkedAsset

LinkedAsset getLinkedAsset(java.lang.String requirePath)
                    throws RequirePathException

The method retrieves the resource specified by the require path.

Parameters:

requirePath - the require path from which the resource will be retrieved

Returns:

the LinkedAsset object retrieved

Throws:

RequirePathException - if the require path is invalid or the resource is out of scope

seedAssets

java.util.List<LinkedAsset> seedAssets()

The method retrieves the a List of LinkedAsset that are located within the current BundableNode.

Returns:

the list of LinkedAssets objects retrieved

getBundleSet

BundleSet getBundleSet()
                throws ModelOperationException

The method retrieves the BundleSet corresponding to the current BundableNode for when it is necessary to deploy it.

Returns:

the BundleSet corresponding to the current BundableNode

Throws:

ModelOperationException - if any exceptions are thrown when retrieving the BundleSet

handleLogicalRequest

ResponseContent handleLogicalRequest(java.lang.String logicalRequestPath,
                                     org.bladerunnerjs.model.UrlContentAccessor contentAccessor,
                                     java.lang.String version)
                              throws MalformedRequestException,
                                     ResourceNotFoundException,
                                     ContentProcessingException

The method represents a bundle request and will deliver the response in the form of bundled resources.

Parameters:

logicalRequestPath - the path the request is being made for

contentAccessor - the output stream the content will be written to

version - the version of the bundle being retrieved

Returns:

the ResponseContent corresponding to the bundled resources

Throws:

MalformedRequestException - if the request does not adhere to the expected format

ResourceNotFoundException - if the request may not be handled due to the indicated resource not being found

ContentProcessingException - for non-BRJS-specific issues

handleLogicalRequest

ResponseContent handleLogicalRequest(java.lang.String logicalRequestPath,
                                     BundleSet bundleSet,
                                     org.bladerunnerjs.model.UrlContentAccessor contentAccessor,
                                     java.lang.String version)
                              throws MalformedRequestException,
                                     ResourceNotFoundException,
                                     ContentProcessingException

Handle a given request using the BundleSet provided. See #handleLogicalRequest(String logicalRequestPath, UrlContentAccessor contentAccessor, String version) throws MalformedRequestException, ResourceNotFoundException, ContentProcessingException;

Parameters:

logicalRequestPath - the path the request is being made for

bundleSet - handle the request using the provided BundleSet

contentAccessor - the output stream the content will be written to

version - the version of the bundle being retrieved

Returns:

the ResponseContent corresponding to the bundled resources

Throws:

MalformedRequestException - if the request does not adhere to the expected format

ResourceNotFoundException - if the request may not be handled due to the indicated resource not being found

ContentProcessingException - for non-BRJS-specific issues

assets

java.util.List<Asset> assets(Asset asset,
                             java.util.List<java.lang.String> requirePaths)
                      throws RequirePathException

The method returns all the Assets that are required by the parameter Asset through the contained require paths.

Parameters:

asset - the Asset object whose required Assets will be retrieved

requirePaths - the require paths to be resolved

Returns:

a list of Assets that are required by the parameter Asset

Throws:

RequirePathException - if the require path is invalid or ambiguous, out of scope, or may otherwise not be resolvable