Search in sources :

Example 1 with JspConfig

use of org.eclipse.jetty.servlet.ServletContextHandler.JspConfig in project jetty.project by eclipse.

the class StandardDescriptorProcessor method visitTagLib.

public void visitTagLib(WebAppContext context, Descriptor descriptor, XmlParser.Node node) {
    //Additive across web.xml and web-fragment.xml
    String uri = node.getString("taglib-uri", false, true);
    String location = node.getString("taglib-location", false, true);
    context.setResourceAlias(uri, location);
    JspConfig config = (JspConfig) context.getServletContext().getJspConfigDescriptor();
    if (config == null) {
        config = new JspConfig();
        context.getServletContext().setJspConfigDescriptor(config);
    }
    TagLib tl = new TagLib();
    tl.setTaglibLocation(location);
    tl.setTaglibURI(uri);
    config.addTaglibDescriptor(tl);
}
Also used : JspConfig(org.eclipse.jetty.servlet.ServletContextHandler.JspConfig) TagLib(org.eclipse.jetty.servlet.ServletContextHandler.TagLib)

Example 2 with JspConfig

use of org.eclipse.jetty.servlet.ServletContextHandler.JspConfig in project jetty.project by eclipse.

the class StandardDescriptorProcessor method visitJspConfig.

public void visitJspConfig(WebAppContext context, Descriptor descriptor, XmlParser.Node node) {
    //Additive across web.xml and web-fragment.xml
    JspConfig config = (JspConfig) context.getServletContext().getJspConfigDescriptor();
    if (config == null) {
        config = new JspConfig();
        context.getServletContext().setJspConfigDescriptor(config);
    }
    for (int i = 0; i < node.size(); i++) {
        Object o = node.get(i);
        if (o instanceof XmlParser.Node && "taglib".equals(((XmlParser.Node) o).getTag()))
            visitTagLib(context, descriptor, (XmlParser.Node) o);
    }
    // Map URLs from jsp property groups to JSP servlet.
    // this is more JSP stupidness creeping into the servlet spec
    Iterator<XmlParser.Node> iter = node.iterator("jsp-property-group");
    List<String> paths = new ArrayList<String>();
    while (iter.hasNext()) {
        JspPropertyGroup jpg = new JspPropertyGroup();
        config.addJspPropertyGroup(jpg);
        XmlParser.Node group = iter.next();
        //url-patterns
        Iterator<XmlParser.Node> iter2 = group.iterator("url-pattern");
        while (iter2.hasNext()) {
            String url = iter2.next().toString(false, true);
            url = ServletPathSpec.normalize(url);
            paths.add(url);
            jpg.addUrlPattern(url);
        }
        jpg.setElIgnored(group.getString("el-ignored", false, true));
        jpg.setPageEncoding(group.getString("page-encoding", false, true));
        jpg.setScriptingInvalid(group.getString("scripting-invalid", false, true));
        jpg.setIsXml(group.getString("is-xml", false, true));
        jpg.setDeferredSyntaxAllowedAsLiteral(group.getString("deferred-syntax-allowed-as-literal", false, true));
        jpg.setTrimDirectiveWhitespaces(group.getString("trim-directive-whitespaces", false, true));
        jpg.setDefaultContentType(group.getString("default-content-type", false, true));
        jpg.setBuffer(group.getString("buffer", false, true));
        jpg.setErrorOnUndeclaredNamespace(group.getString("error-on-undeclared-namespace", false, true));
        //preludes
        Iterator<XmlParser.Node> preludes = group.iterator("include-prelude");
        while (preludes.hasNext()) {
            String prelude = preludes.next().toString(false, true);
            jpg.addIncludePrelude(prelude);
        }
        //codas
        Iterator<XmlParser.Node> codas = group.iterator("include-coda");
        while (codas.hasNext()) {
            String coda = codas.next().toString(false, true);
            jpg.addIncludeCoda(coda);
        }
        if (LOG.isDebugEnabled())
            LOG.debug(config.toString());
    }
    //add mappings to the jsp servlet from the property-group mappings
    if (paths.size() > 0) {
        ServletMapping jspMapping = null;
        for (ServletMapping m : _servletMappings) {
            if (m.getServletName().equals("jsp")) {
                jspMapping = m;
                break;
            }
        }
        if (jspMapping != null) {
            if (jspMapping.getPathSpecs() == null) {
                //no paths in jsp servlet mapping, we will add all of ours
                if (LOG.isDebugEnabled())
                    LOG.debug("Adding all paths from jsp-config to jsp servlet mapping");
                jspMapping.setPathSpecs(paths.toArray(new String[paths.size()]));
            } else {
                //check if each of our paths is already present in existing mapping
                ListIterator<String> piterator = paths.listIterator();
                while (piterator.hasNext()) {
                    String p = piterator.next();
                    if (jspMapping.containsPathSpec(p))
                        piterator.remove();
                }
                //any remaining paths, add to the jspMapping
                if (paths.size() > 0) {
                    for (String p : jspMapping.getPathSpecs()) paths.add(p);
                    if (LOG.isDebugEnabled())
                        LOG.debug("Adding extra paths from jsp-config to jsp servlet mapping");
                    jspMapping.setPathSpecs((String[]) paths.toArray(new String[paths.size()]));
                }
            }
        } else {
            //no mapping for jsp yet, make one
            ServletMapping mapping = new ServletMapping(new Source(Source.Origin.DESCRIPTOR, descriptor.getResource().toString()));
            mapping.setServletName("jsp");
            mapping.setPathSpecs(paths.toArray(new String[paths.size()]));
            _servletMappings.add(mapping);
        }
    }
}
Also used : XmlParser(org.eclipse.jetty.xml.XmlParser) ServletMapping(org.eclipse.jetty.servlet.ServletMapping) JspConfig(org.eclipse.jetty.servlet.ServletContextHandler.JspConfig) Node(org.eclipse.jetty.xml.XmlParser.Node) ArrayList(java.util.ArrayList) Node(org.eclipse.jetty.xml.XmlParser.Node) Constraint(org.eclipse.jetty.util.security.Constraint) Source(org.eclipse.jetty.servlet.Source) JspPropertyGroup(org.eclipse.jetty.servlet.ServletContextHandler.JspPropertyGroup)

Example 3 with JspConfig

use of org.eclipse.jetty.servlet.ServletContextHandler.JspConfig in project jetty.project by eclipse.

the class QuickStartDescriptorGenerator method generateQuickStartWebXml.

/**
     * Perform the generation of the xml file
     * @param stream the stream to generate the quickstart-web.xml to
     * @throws IOException if unable to generate the quickstart-web.xml
     * @throws FileNotFoundException if unable to find the file 
     */
public void generateQuickStartWebXml(OutputStream stream) throws FileNotFoundException, IOException {
    if (_webApp == null)
        throw new IllegalStateException("No webapp for quickstart generation");
    if (stream == null)
        throw new IllegalStateException("No output for quickstart generation");
    _webApp.getMetaData().getOrigins();
    if (_webApp.getBaseResource() == null)
        throw new IllegalArgumentException("No base resource for " + this);
    LOG.info("Quickstart generating");
    XmlAppendable out = new XmlAppendable(stream, "UTF-8");
    MetaData md = _webApp.getMetaData();
    Map<String, String> webappAttr = new HashMap<>();
    webappAttr.put("xmlns", "http://xmlns.jcp.org/xml/ns/javaee");
    webappAttr.put("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
    webappAttr.put("xsi:schemaLocation", "http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd");
    webappAttr.put("metadata-complete", "true");
    webappAttr.put("version", "3.1");
    out.openTag("web-app", webappAttr);
    if (_webApp.getDisplayName() != null)
        out.tag("display-name", _webApp.getDisplayName());
    // Set some special context parameters
    // The location of the war file on disk
    AttributeNormalizer normalizer = new AttributeNormalizer(_webApp.getBaseResource());
    // The library order
    addContextParamFromAttribute(out, ServletContext.ORDERED_LIBS);
    //the servlet container initializers
    addContextParamFromAttribute(out, AnnotationConfiguration.CONTAINER_INITIALIZERS);
    //the tlds discovered
    addContextParamFromAttribute(out, MetaInfConfiguration.METAINF_TLDS, normalizer);
    //the META-INF/resources discovered
    addContextParamFromAttribute(out, MetaInfConfiguration.METAINF_RESOURCES, normalizer);
    //add the name of the origin attribute, if it is being used
    if (_generateOrigin) {
        out.openTag("context-param").tag("param-name", ORIGIN).tag("param-value", _originAttribute).closeTag();
    }
    // init params
    for (String p : _webApp.getInitParams().keySet()) out.openTag("context-param", origin(md, "context-param." + p)).tag("param-name", p).tag("param-value", _webApp.getInitParameter(p)).closeTag();
    if (_webApp.getEventListeners() != null)
        for (EventListener e : _webApp.getEventListeners()) out.openTag("listener", origin(md, e.getClass().getCanonicalName() + ".listener")).tag("listener-class", e.getClass().getCanonicalName()).closeTag();
    ServletHandler servlets = _webApp.getServletHandler();
    if (servlets.getFilters() != null) {
        for (FilterHolder holder : servlets.getFilters()) outholder(out, md, holder);
    }
    if (servlets.getFilterMappings() != null) {
        for (FilterMapping mapping : servlets.getFilterMappings()) {
            out.openTag("filter-mapping");
            out.tag("filter-name", mapping.getFilterName());
            if (mapping.getPathSpecs() != null)
                for (String s : mapping.getPathSpecs()) out.tag("url-pattern", s);
            if (mapping.getServletNames() != null)
                for (String n : mapping.getServletNames()) out.tag("servlet-name", n);
            if (!mapping.isDefaultDispatches()) {
                if (mapping.appliesTo(DispatcherType.REQUEST))
                    out.tag("dispatcher", "REQUEST");
                if (mapping.appliesTo(DispatcherType.ASYNC))
                    out.tag("dispatcher", "ASYNC");
                if (mapping.appliesTo(DispatcherType.ERROR))
                    out.tag("dispatcher", "ERROR");
                if (mapping.appliesTo(DispatcherType.FORWARD))
                    out.tag("dispatcher", "FORWARD");
                if (mapping.appliesTo(DispatcherType.INCLUDE))
                    out.tag("dispatcher", "INCLUDE");
            }
            out.closeTag();
        }
    }
    if (servlets.getServlets() != null) {
        for (ServletHolder holder : servlets.getServlets()) outholder(out, md, holder);
    }
    if (servlets.getServletMappings() != null) {
        for (ServletMapping mapping : servlets.getServletMappings()) {
            out.openTag("servlet-mapping", origin(md, mapping.getServletName() + ".servlet.mappings"));
            out.tag("servlet-name", mapping.getServletName());
            if (mapping.getPathSpecs() != null)
                for (String s : mapping.getPathSpecs()) out.tag("url-pattern", s);
            out.closeTag();
        }
    }
    // Security elements
    SecurityHandler security = _webApp.getSecurityHandler();
    if (security != null && (security.getRealmName() != null || security.getAuthMethod() != null)) {
        out.openTag("login-config");
        if (security.getAuthMethod() != null)
            out.tag("auth-method", origin(md, "auth-method"), security.getAuthMethod());
        if (security.getRealmName() != null)
            out.tag("realm-name", origin(md, "realm-name"), security.getRealmName());
        if (Constraint.__FORM_AUTH.equalsIgnoreCase(security.getAuthMethod())) {
            out.openTag("form-login-config");
            out.tag("form-login-page", origin(md, "form-login-page"), security.getInitParameter(FormAuthenticator.__FORM_LOGIN_PAGE));
            out.tag("form-error-page", origin(md, "form-error-page"), security.getInitParameter(FormAuthenticator.__FORM_ERROR_PAGE));
            out.closeTag();
        }
        out.closeTag();
    }
    if (security instanceof ConstraintAware) {
        ConstraintAware ca = (ConstraintAware) security;
        for (String r : ca.getRoles()) out.openTag("security-role").tag("role-name", r).closeTag();
        for (ConstraintMapping m : ca.getConstraintMappings()) {
            out.openTag("security-constraint");
            out.openTag("web-resource-collection");
            {
                if (m.getConstraint().getName() != null)
                    out.tag("web-resource-name", m.getConstraint().getName());
                if (m.getPathSpec() != null)
                    out.tag("url-pattern", origin(md, "constraint.url." + m.getPathSpec()), m.getPathSpec());
                if (m.getMethod() != null)
                    out.tag("http-method", m.getMethod());
                if (m.getMethodOmissions() != null)
                    for (String o : m.getMethodOmissions()) out.tag("http-method-omission", o);
                out.closeTag();
            }
            if (m.getConstraint().getAuthenticate()) {
                String[] roles = m.getConstraint().getRoles();
                if (roles != null && roles.length > 0) {
                    out.openTag("auth-constraint");
                    if (m.getConstraint().getRoles() != null)
                        for (String r : m.getConstraint().getRoles()) out.tag("role-name", r);
                    out.closeTag();
                } else
                    out.tag("auth-constraint");
            }
            switch(m.getConstraint().getDataConstraint()) {
                case Constraint.DC_NONE:
                    out.openTag("user-data-constraint").tag("transport-guarantee", "NONE").closeTag();
                    break;
                case Constraint.DC_INTEGRAL:
                    out.openTag("user-data-constraint").tag("transport-guarantee", "INTEGRAL").closeTag();
                    break;
                case Constraint.DC_CONFIDENTIAL:
                    out.openTag("user-data-constraint").tag("transport-guarantee", "CONFIDENTIAL").closeTag();
                    break;
                default:
                    break;
            }
            out.closeTag();
        }
    }
    if (_webApp.getWelcomeFiles() != null) {
        out.openTag("welcome-file-list");
        for (String welcomeFile : _webApp.getWelcomeFiles()) {
            out.tag("welcome-file", welcomeFile);
        }
        out.closeTag();
    }
    Map<String, String> localeEncodings = _webApp.getLocaleEncodings();
    if (localeEncodings != null && !localeEncodings.isEmpty()) {
        out.openTag("locale-encoding-mapping-list");
        for (Map.Entry<String, String> entry : localeEncodings.entrySet()) {
            out.openTag("locale-encoding-mapping", origin(md, "locale-encoding." + entry.getKey()));
            out.tag("locale", entry.getKey());
            out.tag("encoding", entry.getValue());
            out.closeTag();
        }
        out.closeTag();
    }
    //session-config
    if (_webApp.getSessionHandler() != null) {
        out.openTag("session-config");
        int maxInactiveSec = _webApp.getSessionHandler().getMaxInactiveInterval();
        out.tag("session-timeout", (maxInactiveSec == 0 ? "0" : Integer.toString(maxInactiveSec / 60)));
        //cookie-config
        SessionCookieConfig cookieConfig = _webApp.getSessionHandler().getSessionCookieConfig();
        if (cookieConfig != null) {
            out.openTag("cookie-config");
            if (cookieConfig.getName() != null)
                out.tag("name", origin(md, "cookie-config.name"), cookieConfig.getName());
            if (cookieConfig.getDomain() != null)
                out.tag("domain", origin(md, "cookie-config.domain"), cookieConfig.getDomain());
            if (cookieConfig.getPath() != null)
                out.tag("path", origin(md, "cookie-config.path"), cookieConfig.getPath());
            if (cookieConfig.getComment() != null)
                out.tag("comment", origin(md, "cookie-config.comment"), cookieConfig.getComment());
            out.tag("http-only", origin(md, "cookie-config.http-only"), Boolean.toString(cookieConfig.isHttpOnly()));
            out.tag("secure", origin(md, "cookie-config.secure"), Boolean.toString(cookieConfig.isSecure()));
            out.tag("max-age", origin(md, "cookie-config.max-age"), Integer.toString(cookieConfig.getMaxAge()));
            out.closeTag();
        }
        // tracking-modes
        Set<SessionTrackingMode> modes = _webApp.getSessionHandler().getEffectiveSessionTrackingModes();
        if (modes != null) {
            for (SessionTrackingMode mode : modes) out.tag("tracking-mode", mode.toString());
        }
        out.closeTag();
    }
    //error-pages
    Map<String, String> errorPages = ((ErrorPageErrorHandler) _webApp.getErrorHandler()).getErrorPages();
    if (errorPages != null) {
        for (Map.Entry<String, String> entry : errorPages.entrySet()) {
            out.openTag("error-page", origin(md, "error." + entry.getKey()));
            //a global or default error page has no code or exception               
            if (!ErrorPageErrorHandler.GLOBAL_ERROR_PAGE.equals(entry.getKey())) {
                if (entry.getKey().matches("\\d{3}"))
                    out.tag("error-code", entry.getKey());
                else
                    out.tag("exception-type", entry.getKey());
            }
            out.tag("location", entry.getValue());
            out.closeTag();
        }
    }
    //mime-types
    MimeTypes mimeTypes = _webApp.getMimeTypes();
    if (mimeTypes != null) {
        for (Map.Entry<String, String> entry : mimeTypes.getMimeMap().entrySet()) {
            out.openTag("mime-mapping");
            out.tag("extension", origin(md, "extension." + entry.getKey()), entry.getKey());
            out.tag("mime-type", entry.getValue());
            out.closeTag();
        }
    }
    //jsp-config
    JspConfig jspConfig = (JspConfig) _webApp.getServletContext().getJspConfigDescriptor();
    if (jspConfig != null) {
        out.openTag("jsp-config");
        Collection<TaglibDescriptor> tlds = jspConfig.getTaglibs();
        if (tlds != null && !tlds.isEmpty()) {
            for (TaglibDescriptor tld : tlds) {
                out.openTag("taglib");
                out.tag("taglib-uri", tld.getTaglibURI());
                out.tag("taglib-location", tld.getTaglibLocation());
                out.closeTag();
            }
        }
        Collection<JspPropertyGroupDescriptor> jspPropertyGroups = jspConfig.getJspPropertyGroups();
        if (jspPropertyGroups != null && !jspPropertyGroups.isEmpty()) {
            for (JspPropertyGroupDescriptor jspPropertyGroup : jspPropertyGroups) {
                out.openTag("jsp-property-group");
                Collection<String> strings = jspPropertyGroup.getUrlPatterns();
                if (strings != null && !strings.isEmpty()) {
                    for (String urlPattern : strings) out.tag("url-pattern", urlPattern);
                }
                if (jspPropertyGroup.getElIgnored() != null)
                    out.tag("el-ignored", jspPropertyGroup.getElIgnored());
                if (jspPropertyGroup.getPageEncoding() != null)
                    out.tag("page-encoding", jspPropertyGroup.getPageEncoding());
                if (jspPropertyGroup.getScriptingInvalid() != null)
                    out.tag("scripting-invalid", jspPropertyGroup.getScriptingInvalid());
                if (jspPropertyGroup.getIsXml() != null)
                    out.tag("is-xml", jspPropertyGroup.getIsXml());
                if (jspPropertyGroup.getDeferredSyntaxAllowedAsLiteral() != null)
                    out.tag("deferred-syntax-allowed-as-literal", jspPropertyGroup.getDeferredSyntaxAllowedAsLiteral());
                if (jspPropertyGroup.getTrimDirectiveWhitespaces() != null)
                    out.tag("trim-directive-whitespaces", jspPropertyGroup.getTrimDirectiveWhitespaces());
                if (jspPropertyGroup.getDefaultContentType() != null)
                    out.tag("default-content-type", jspPropertyGroup.getDefaultContentType());
                if (jspPropertyGroup.getBuffer() != null)
                    out.tag("buffer", jspPropertyGroup.getBuffer());
                if (jspPropertyGroup.getErrorOnUndeclaredNamespace() != null)
                    out.tag("error-on-undeclared-namespace", jspPropertyGroup.getErrorOnUndeclaredNamespace());
                strings = jspPropertyGroup.getIncludePreludes();
                if (strings != null && !strings.isEmpty()) {
                    for (String prelude : strings) out.tag("include-prelude", prelude);
                }
                strings = jspPropertyGroup.getIncludeCodas();
                if (strings != null && !strings.isEmpty()) {
                    for (String coda : strings) out.tag("include-coda", coda);
                }
                out.closeTag();
            }
        }
        out.closeTag();
    }
    //lifecycle: post-construct, pre-destroy
    LifeCycleCallbackCollection lifecycles = ((LifeCycleCallbackCollection) _webApp.getAttribute(LifeCycleCallbackCollection.LIFECYCLE_CALLBACK_COLLECTION));
    if (lifecycles != null) {
        Collection<LifeCycleCallback> tmp = lifecycles.getPostConstructCallbacks();
        for (LifeCycleCallback c : tmp) {
            out.openTag("post-construct");
            out.tag("lifecycle-callback-class", c.getTargetClassName());
            out.tag("lifecycle-callback-method", c.getMethodName());
            out.closeTag();
        }
        tmp = lifecycles.getPreDestroyCallbacks();
        for (LifeCycleCallback c : tmp) {
            out.openTag("pre-destroy");
            out.tag("lifecycle-callback-class", c.getTargetClassName());
            out.tag("lifecycle-callback-method", c.getMethodName());
            out.closeTag();
        }
    }
    out.literal(_extraXML);
    out.closeTag();
}
Also used : ServletHandler(org.eclipse.jetty.servlet.ServletHandler) FilterHolder(org.eclipse.jetty.servlet.FilterHolder) ErrorPageErrorHandler(org.eclipse.jetty.servlet.ErrorPageErrorHandler) JspConfig(org.eclipse.jetty.servlet.ServletContextHandler.JspConfig) HashMap(java.util.HashMap) SessionTrackingMode(javax.servlet.SessionTrackingMode) ServletHolder(org.eclipse.jetty.servlet.ServletHolder) FilterMapping(org.eclipse.jetty.servlet.FilterMapping) JspPropertyGroupDescriptor(javax.servlet.descriptor.JspPropertyGroupDescriptor) MetaData(org.eclipse.jetty.webapp.MetaData) ConstraintAware(org.eclipse.jetty.security.ConstraintAware) SessionCookieConfig(javax.servlet.SessionCookieConfig) EventListener(java.util.EventListener) ServletMapping(org.eclipse.jetty.servlet.ServletMapping) SecurityHandler(org.eclipse.jetty.security.SecurityHandler) ConstraintMapping(org.eclipse.jetty.security.ConstraintMapping) LifeCycleCallbackCollection(org.eclipse.jetty.plus.annotation.LifeCycleCallbackCollection) MimeTypes(org.eclipse.jetty.http.MimeTypes) Constraint(org.eclipse.jetty.util.security.Constraint) XmlAppendable(org.eclipse.jetty.xml.XmlAppendable) TaglibDescriptor(javax.servlet.descriptor.TaglibDescriptor) LifeCycleCallback(org.eclipse.jetty.plus.annotation.LifeCycleCallback) HashMap(java.util.HashMap) Map(java.util.Map)

Aggregations

JspConfig (org.eclipse.jetty.servlet.ServletContextHandler.JspConfig)3 ServletMapping (org.eclipse.jetty.servlet.ServletMapping)2 Constraint (org.eclipse.jetty.util.security.Constraint)2 ArrayList (java.util.ArrayList)1 EventListener (java.util.EventListener)1 HashMap (java.util.HashMap)1 Map (java.util.Map)1 SessionCookieConfig (javax.servlet.SessionCookieConfig)1 SessionTrackingMode (javax.servlet.SessionTrackingMode)1 JspPropertyGroupDescriptor (javax.servlet.descriptor.JspPropertyGroupDescriptor)1 TaglibDescriptor (javax.servlet.descriptor.TaglibDescriptor)1 MimeTypes (org.eclipse.jetty.http.MimeTypes)1 LifeCycleCallback (org.eclipse.jetty.plus.annotation.LifeCycleCallback)1 LifeCycleCallbackCollection (org.eclipse.jetty.plus.annotation.LifeCycleCallbackCollection)1 ConstraintAware (org.eclipse.jetty.security.ConstraintAware)1 ConstraintMapping (org.eclipse.jetty.security.ConstraintMapping)1 SecurityHandler (org.eclipse.jetty.security.SecurityHandler)1 ErrorPageErrorHandler (org.eclipse.jetty.servlet.ErrorPageErrorHandler)1 FilterHolder (org.eclipse.jetty.servlet.FilterHolder)1 FilterMapping (org.eclipse.jetty.servlet.FilterMapping)1