Variables in jsp pages with "included" pages

JavaJspJakarta Ee

Java Problem Overview


What are the scoping rules for variables in a jsp page with pages added to them using tags?

My understanding is that an included page is essentially copied verbatim into the page, which would lead me to assume that if I've declared a variable in a Parent JSP that it would be available in the child ones.

However Eclipse complains about this (understandably because I could feasibly include the pages in any page or use them as stand alone. And when I try to start the tomcat server it fails to start.

I basically want to get a couple of variables from the session in the parent page and use them in the child pages. This doesn't work.

So I've struck ont he idea of getting them from the session in each of the child pages, however I was wondering if I could give them all the same variable names, or if I'd have to pick different variable names for them in each page so they didn't clash.

Also what about imports if I import log4net in the parent jss do I also have to import it in the child ones?

Java Solutions


Solution 1 - Java

In JSP there are two ways of including other jsp pages.

<%@include file="include.jsp"%>

and

<jsp:include page="include.jsp" />

If you use the former, then any variable declared on the parent JSP will be in scope in the include.jsp (of course Eclipse will not see this as you surmised) as it is effectively copied in by the compiler.

If you use the second approach, the inclusion is done at runtime and the include page has its own scope.

Ditto for imports. Although it is safe to redundantly import them in the include page.

If I'm using the former I prefer to suffix them with .jspf to signify a JSP fragment. I can than turn off some of Eclipses warning in the fragment files. But in general I try to avoid using that method and prefer the second approach.

More information can be found in the docs here: Include directive and JSP include.

Solution 2 - Java

Use the following, if you want to use variable within the path of the page to be included:

<% pageContext.include("/cities/" + (String) request.getAttribute("country_code") + ".jsp"); %>

Solution 3 - Java

From an object-orientated point of view, i would recommend not relying on the scope of the variable in parent.jsp being included in the child.jsp. This is because when i include a fragment in a jsp i tend to want to reuse that fragment in many different places. For example if i have a child.jsp i may want to use it in parent1.jsp as well as parent2.jsp. In the case it is better not to variable inheritence.

Solution 4 - Java

When you create a variable, you should set the scope to session, otherwise, the included page will not see it. Example :

<logic:iterate id="supportTmp" name="publicites" indexId="indexLots" scope="session">                                    
    <c:set var="support" value="${supportTmp}" scope="session"/>
    <c:choose>
    <c:when test="${publiciteMoniteur == true}">
	<jsp:include page="/jsp/bodies/suiviEnvoiPubliciteMoniteurLigne.jsp" />
    </c:when>
    <c:otherwise>
    	<jsp:include page="/jsp/bodies/suiviEnvoiPubliciteDefautLigne.jsp" />
    </c:otherwise>
</c:choose>
</logic:iterate>

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionOmar KoohejiView Question on Stackoverflow
Solution 1 - JavaKrisView Answer on Stackoverflow
Solution 2 - JavaDagvadorjView Answer on Stackoverflow
Solution 3 - JavamR_fr0gView Answer on Stackoverflow
Solution 4 - JavaMarouane GazanayiView Answer on Stackoverflow