Examples with ComponentDefinition org.apache.struts.tiles.ComponentDefinition used on opensource projects

Example 1 with ComponentDefinition

use of org.apache.struts.tiles.ComponentDefinition in project sonar-java by SonarSource.

the class TilesPreProcessor method execute.

// ---------------------------------------------------------- Public Methods
/**
 * <p>If the current <code>ForwardConfig</code> is using "tiles",
 * perform necessary pre-processing to set up the <code>TilesContext</code>
 * and substitute a new <code>ForwardConfig</code> which is understandable
 * to a <code>RequestDispatcher</code>.</p>
 *
 * <p>Note that if the command finds a previously existing
 * <code>ComponentContext</code> in the request, then it
 * infers that it has been called from within another tile,
 * so instead of changing the <code>ForwardConfig</code> in the chain
 * <code>Context</code>, the command uses <code>RequestDispatcher</code>
 * to <em>include</em> the tile, and returns true, indicating that the processing
 * chain is complete.</p>
 *
 * @param context The <code>Context</code> for the current request
 *
 * @return <code>false</code> in most cases, but true if we determine
 * that we're processing in "include" mode.
 */
public boolean execute(Context context) throws Exception {
    // Is there a Tiles Definition to be processed?
    ServletActionContext sacontext = (ServletActionContext) context;
    ForwardConfig forwardConfig = sacontext.getForwardConfig();
    if (forwardConfig == null || forwardConfig.getPath() == null) {
        log.debug("No forwardConfig or no path, so pass to next command.");
        return (false);
    }
    ComponentDefinition definition = null;
    try {
        definition = TilesUtil.getDefinition(forwardConfig.getPath(), sacontext.getRequest(), sacontext.getContext());
    } catch (FactoryNotFoundException ex) {
        // this is not a serious error, so log at low priority
        log.debug("Tiles DefinitionFactory not found, so pass to next command.");
        return false;
    } catch (NoSuchDefinitionException ex) {
        // ignore not found
        log.debug("NoSuchDefinitionException " + ex.getMessage());
    }
    // Do we do a forward (original behavior) or an include ?
    boolean doInclude = false;
    ComponentContext tileContext = null;
    // Get current tile context if any.
    // If context exists, or if the response has already been committed we will do an include
    tileContext = ComponentContext.getContext(sacontext.getRequest());
    doInclude = (tileContext != null || sacontext.getResponse().isCommitted());
    // Controller associated to a definition, if any
    Controller controller = null;
    // Computed uri to include
    String uri = null;
    if (definition != null) {
        // We have a "forward config" definition.
        // We use it to complete missing attribute in context.
        // We also get uri, controller.
        uri = definition.getPath();
        controller = definition.getOrCreateController();
        if (tileContext == null) {
            tileContext = new ComponentContext(definition.getAttributes());
            ComponentContext.setContext(tileContext, sacontext.getRequest());
        } else {
            tileContext.addMissing(definition.getAttributes());
        }
    }
    // Process definition set in Action, if any.  This may override the
    // values for uri or controller found using the ForwardConfig, and
    // may augment the tileContext with additional attributes.
    // :FIXME: the class DefinitionsUtil is deprecated, but I can't find
    // the intended alternative to use.
    definition = DefinitionsUtil.getActionDefinition(sacontext.getRequest());
    if (definition != null) {
        // We also overload uri and controller if set in definition.
        if (definition.getPath() != null) {
            log.debug("Override forward uri " + uri + " with action uri " + definition.getPath());
            uri = definition.getPath();
        }
        if (definition.getOrCreateController() != null) {
            log.debug("Override forward controller with action controller");
            controller = definition.getOrCreateController();
        }
        if (tileContext == null) {
            tileContext = new ComponentContext(definition.getAttributes());
            ComponentContext.setContext(tileContext, sacontext.getRequest());
        } else {
            tileContext.addMissing(definition.getAttributes());
        }
    }
    if (uri == null) {
        log.debug("no uri computed, so pass to next command");
        return false;
    }
    // Execute controller associated to definition, if any.
    if (controller != null) {
        log.trace("Execute controller: " + controller);
        controller.execute(tileContext, sacontext.getRequest(), sacontext.getResponse(), sacontext.getContext());
    }
    if (doInclude) {
        log.info("Tiles process complete; doInclude with " + uri);
        doInclude(sacontext, uri);
    } else {
        log.info("Tiles process complete; forward to " + uri);
        doForward(sacontext, uri);
    }
    log.debug("Tiles processed, so clearing forward config from context.");
    sacontext.setForwardConfig(null);
    return (false);
}

Example 2 with ComponentDefinition

use of org.apache.struts.tiles.ComponentDefinition in project sonar-java by SonarSource.

the class DefinitionDispatcherAction method execute.

/**
 * Process the specified HTTP request, and create the corresponding HTTP
 * response (or forward to another web component that will create it),
 * with provision for handling exceptions thrown by the business logic.
 *
 * @param mapping The ActionMapping used to select this instance
 * @param form The optional ActionForm bean for this request (if any)
 * @param request The HTTP request we are processing
 * @param response The HTTP response we are creating
 *
 * @exception Exception if the application business logic throws
 *  an exception
 * @since Struts 1.1
 */
public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
    // Identify the request parameter containing the method name
    // If none defined, use "def"
    String parameter = mapping.getParameter();
    if (parameter == null) {
        parameter = "def";
    }
    // Identify the method name to be dispatched to
    String name = request.getParameter(parameter);
    if (name == null) {
        log.error("Can't get parameter '" + parameter + "'.");
        return mapping.findForward("error");
    }
    // Try to dispatch to requested definition
    try {
        // Read definition from factory, but we can create it here.
        ComponentDefinition definition = TilesUtil.getDefinition(name, request, getServlet().getServletContext());
        if (log.isDebugEnabled()) {
            log.debug("Get Definition " + definition);
        }
        DefinitionsUtil.setActionDefinition(request, definition);
    } catch (FactoryNotFoundException e) {
        log.error("Can't get definition factory.", e);
        return mapping.findForward("error");
    } catch (NoSuchDefinitionException e) {
        log.error("Can't get definition '" + name + "'.", e);
        return mapping.findForward("error");
    } catch (DefinitionsFactoryException e) {
        log.error("General Factory error '" + e.getMessage() + "'.", e);
        return mapping.findForward("error");
    } catch (Exception e) {
        log.error("General error '" + e.getMessage() + "'.", e);
        return mapping.findForward("error");
    }
    return mapping.findForward("success");
}

Example 3 with ComponentDefinition

use of org.apache.struts.tiles.ComponentDefinition in project sonar-java by SonarSource.

the class DefinitionTag method doStartTag.

/**
 * Process the start tag by creating a new definition.
 * @throws JspException On errors processing tag.
 */
public int doStartTag() throws JspException {
    // Do we extend a definition ?
    if (extendsDefinition != null && !extendsDefinition.equals("")) {
        ComponentDefinition parentDef = TagUtils.getComponentDefinition(extendsDefinition, pageContext);
        definition = new ComponentDefinition(parentDef);
    } else {
        definition = new ComponentDefinition();
    }
    // Set definitions attributes
    if (page != null) {
        definition.setTemplate(page);
    }
    if (role != null) {
        definition.setRole(role);
    }
    return EVAL_BODY_INCLUDE;
}