Examples of org.bladerunnerjs.plugin.ContentPlugin

org.bladerunnerjs.plugin.ContentPlugin
Content plug-ins allow generated content to be returned by the application server in response to requests from the web browser. Where content plug-ins differ from similar mechanisms employed on most other application servers is that they are required to support flat-file export, and so must therefore have the following properties:

Determinism

The same response must always be returned given the same request and the same set of files on disk.

Discoverability

The complete list of valid content paths must be provided by content plug-ins on demand (using {@link #getValidDevContentPaths getValidDevContentPaths()} &{@link #getValidProdContentPaths getValidProdContentPaths()}), such that any requests from the browser that are not included in this list are considered to be an error.

Although content-plugins are designed to be usable both dynamically, and as part of a build (for flat-file export), a provision for generating different content in development and production is provided, for cases where things need to be done in a more efficient manner in production, and in a more dev-friendly manner in development. Developers that choose to exploit this facility should take care to ensure there is no chance of bugs being found in production, that can't also be observed in development; a core tenet of BladeRunnerJS.

The following methods are identifier-methods, and may be invoked before {@link Plugin#setBRJS Plugin.setBRJS()} has been invoked:
- {@link #getRequestPrefix}
- {@link #getCompositeGroupName}

      if (parsedRequest.formName.equals(UNVERSIONED_BUNDLE_REQUEST)) {
        /* since unversioned requests (/myApp/somePlugin/file.txt) could also be a request to a custom servlet
         * if the request type is an unversioned bundle request we must first check that a content plugin can ultimately handle it
         */
        String contentPath = parsedRequest.properties.get("content-path");
        ContentPlugin contentProvider = app.root().plugins().contentPluginForLogicalPath(contentPath);
        if (contentProvider == null) {
          return false;
        }
        return true;
      }

View Full Code Here

      
      localeForwardingPage.write("<head>\n");
      localeForwardingPage.write("<noscript><meta http-equiv='refresh' content='0; url=" + app.appConf().getDefaultLocale() + "/'></noscript>\n");
      localeForwardingPage.write("<script type='text/javascript'>\n");
      
      ContentPlugin appVersionContentPlugin = app.root().plugins().contentPlugin("app-meta");
      ContentPathParser appVersionContentPathParser = appVersionContentPlugin.getContentPathParser();
      String appVersionContentPath = appVersionContentPathParser.createRequest("app-meta-request");
      ResponseContent responseContent = appVersionContentPlugin.handleRequest(appVersionContentPathParser.parse(appVersionContentPath), bundleSet, contentAccessor, appVersionContentPath);
      ByteArrayOutputStream baos = new ByteArrayOutputStream();
      responseContent.write(baos);
      localeForwardingPage.write( baos.toString() );
      
      localeForwardingPage.write("\n");

View Full Code Here

    logger.debug(Messages.REQUEST_HANDLED_MSG, logicalRequestpath, app.getName());
    
    String name = (bundlableNode instanceof NamedNode) ? ((NamedNode) bundlableNode).getName() : "default";
    logger.debug(Messages.CONTEXT_IDENTIFIED_MSG, bundlableNode.getTypeName(), name, logicalRequestpath);
    
    ContentPlugin contentProvider = app.root().plugins().contentPluginForLogicalPath(logicalRequestpath);
    
    if(contentProvider == null) {
      throw new ResourceNotFoundException("No content provider could be found found the logical request path '" + logicalRequestpath + "'");
    }
    
    logger.debug(Messages.BUNDLER_IDENTIFIED_MSG, contentProvider.getPluginClass().getSimpleName(), logicalRequestpath);
    
    ParsedContentPath contentPath = contentProvider.getContentPathParser().parse(logicalRequestpath);
    return contentProvider.handleRequest(contentPath, bundleSet, contentAccessor, version);
  }

View Full Code Here

    
    return verifierChainer;
  }
  
  private VerifierChainer verifyProdAndDevRequestsForContentPluginsAre(String contentPluginPrefix, String... expectedRequests) throws Exception {
    ContentPlugin contentPlugin = bundlableNode.root().plugins().contentPlugin(contentPluginPrefix);
    List<String> actualDevRequests = contentPlugin.getValidDevContentPaths(bundlableNode.getBundleSet(), bundlableNode.app().appConf().getLocales());
    List<String> actualProdRequests = contentPlugin.getValidProdContentPaths(bundlableNode.getBundleSet(), bundlableNode.app().appConf().getLocales());
    
    assertEquals("dev requests didn't match", Joiner.on(", ").join(expectedRequests), Joiner.on(", ").join(actualDevRequests));
    assertEquals("prod requests didn't match", Joiner.on(", ").join(expectedRequests), Joiner.on(", ").join(actualProdRequests));
    
    return verifierChainer;

View Full Code Here

    
    return verifierChainer;
  }
  
  public VerifierChainer devRequestsForContentPluginsAre(String contentPluginPrefix, String... expectedRequests) throws Exception {
    ContentPlugin contentPlugin = bundlableNode.root().plugins().contentPlugin(contentPluginPrefix);
    List<String> actualRequests = contentPlugin.getValidDevContentPaths(bundlableNode.getBundleSet(), bundlableNode.app().appConf().getLocales());
    
    assertEquals("dev requests didn't match", Joiner.on(", ").join(expectedRequests), Joiner.on(", ").join(actualRequests));
    
    return verifierChainer;
  }

View Full Code Here

    
    return verifierChainer;
  }
  
  public VerifierChainer prodRequestsForContentPluginsAre(String contentPluginPrefix, String... expectedRequests) throws Exception {
    ContentPlugin contentPlugin = bundlableNode.root().plugins().contentPlugin(contentPluginPrefix);
    List<String> actualRequests = contentPlugin.getValidProdContentPaths(bundlableNode.getBundleSet(), bundlableNode.app().appConf().getLocales());
    
    assertEquals("prod requests didn't match", Joiner.on(", ").join(expectedRequests), Joiner.on(", ").join(actualRequests));
    
    return verifierChainer;
  }

View Full Code Here

            || contentPluginProdRequestsMap.get(requestPrefix).contains(versionedContentPath) ) {
          writeContentFile(bundleSet, urlContentAccessor, target, appRequestHandler, version, aspectRequestPrefix, contentPlugin, contentPath);
        }
      }
    } else {
      ContentPlugin plugin = (contentPlugin instanceof VirtualProxyContentPlugin) ? (ContentPlugin) ((VirtualProxyContentPlugin) contentPlugin).getUnderlyingPlugin() : contentPlugin;
      bundleSet.getBundlableNode().root().logger(AppBuilderUtilis.class).info("The content plugin '%s' is part of a composite content plugin so no files will be generated. " + 
          "If content bundles should be generated for this content plugin, you should set it's composite group name to null.", plugin.getClass().getSimpleName());
    }
  }

View Full Code Here

TOP

Related Classes of org.bladerunnerjs.plugin.ContentPlugin

org.bladerunnerjs.model.app.building.AppBuilderUtilis

org.bladerunnerjs.testing.specutility.BundlableNodeVerifier

org.bladerunnerjs.utility.AppRequestHandler

org.bladerunnerjs.utility.BundleSetRequestHandler

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.