Inheritance diagram for org.turro.elephant.impl.context.DefaultConstructor:

Collaboration diagram for org.turro.elephant.impl.context.DefaultConstructor:

[legend]

Public Member Functions
	DefaultConstructor ()

boolean	isHeadless ()

void	setRequest (ServletRequest request)

void	setResponse (ServletResponse response)

HttpServletRequest	getRequest ()

HttpServletResponse	getResponse ()

ElContext	getCurrentContext ()

ElContext	getRenderingContext ()

void	setRenderingContext (ElContext context)

void	forceIsAContext (ElContext context)

boolean	isOriginal ()

boolean	isFileInternal (File file)

Object	findAttribute (String key)

Object	getApplicationAttribute (String key)

Object	getSessionAttribute (String key)

Map< String, Object >	getSessionAttributeMap (String prefix)

Object	getRequestAttribute (String key)

void	setApplicationAttribute (String key, Object value)

void	setSessionAttribute (String key, Object value)

void	setRequestAttribute (String key, Object value)

void	removeApplicationAttribute (String key)

void	removeSessionAttribute (String key)

void	removeRequestAttribute (String key)

void	startConstruction () throws IOException, ServletException

void	setStopper (String stopper)

boolean	fileExists (String filePath)

void	startBody ()

void	endBody ()

void	includeContent (String path) throws ServletException, IOException

void	renderContext (String path, String stopper) throws ServletException, IOException

void	redirect (String path) throws IOException

void	navigateBack () throws IOException

void	reload () throws IOException

PrintWriter	getOut () throws IOException

void	setOut (PrintWriter out)

void	closeOut () throws IOException

void	setPageRendering (boolean value)

void	setNullOutput (boolean value)

void	setOutputToString ()

String	getOutputString ()

void	processOutput (String text) throws ServletException, IOException

void	processOutput (PrintWriter newOut, String text) throws ServletException, IOException

String	encodeURL (String url)

String	decodeURL (String url)

String	getParameter (String param)

String	getParameter (String param, boolean decode)

String[]	getParameterValues (String param)

Parameters	getParameters ()

String	getActionParameter ()

String	getContextParameter ()

String	getIdelParameter ()

String	getValidUrl (String name)

String	getValidFileName (String name)

Localizer	getLocalizer ()

IContact	getUser ()

boolean	isOutsider ()

String	getUniqueId ()

boolean	isInRole (String role)

boolean	hasAnyRoleKey (String role)

void	setLastReferringContext (String context)

String	getLastReferringContext ()

void	addHeader (String header)

void	addCSS (String cssFile)

void	addJavaScript (String jsFile)

void	addMeta (String meta)

String	urlToFile (String file)

void	addOnLoadedJavaScript (String script)

void	addRobots (ElContext context)

void	invalidateSession ()

void	setMaxInactiveInterval (int interval)

void	changeCssHeaders (String from, String to)

boolean	canWebAdminister ()

boolean	isWebAdministering ()

void	setWebAdministering (boolean value)

String	getTemplateRoot ()

Map	getString ()

Protected Attributes
HttpServletRequest	request

HttpServletResponse	response

ElContext	rendering = null

Properties	bundle = null

PrintWriter	out = null

StringWriter	stringOutput = null

ArrayList	metas = new ArrayList()

boolean	isAContext = false

String	stopper

boolean	hasMootools = false

Static Protected Attributes
static final String	BUNDLE_LOCATION = "/WEB-INF/classes/elephant.properties"

Additional Inherited Members
Static Public Member Functions inherited from org.turro.elephant.context.IConstructor
static String	currentRepository (IConstructor constructor)

static String	globalRepository ()

Detailed Description

Author: Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 63 of file DefaultConstructor.java.

Constructor & Destructor Documentation

◆ DefaultConstructor()

org.turro.elephant.impl.context.DefaultConstructor.DefaultConstructor ( )

Creates a new instance of DefaultConstructor

Definition at line 81 of file DefaultConstructor.java.

                               {
     ElContextMap.init();
   }

Here is the call graph for this function:

Member Function Documentation

◆ addCSS()

void org.turro.elephant.impl.context.DefaultConstructor.addCSS ( String cssFile )

Parameters

cssFile CSS file path.

Implements org.turro.elephant.context.IConstructor.

Definition at line 688 of file DefaultConstructor.java.

                                      {
     if(cssFile.contains("${site_fonts}")) {
       if(ElephantContext.getSiteFonts() != null) {
         String fonts[] = ElephantContext.getSiteFonts().split(",");
         for(String font : fonts) {
           String result =
                   "<link rel=\"stylesheet\" type=\"text/css\" href=\"" +
                   urlToFile(cssFile.replaceFirst("\\$\\{site\\_fonts\\}", font)) +
                   "\">";
           if(!headers.contains(result)) {
             headers.add(result);
           }
         }
       }
     } else {
       String result =
               "<link rel=\"stylesheet\" type=\"text/css\" href=\"" +
               urlToFile(cssFile) +
               "\">";
       if(!headers.contains(result)) {
         headers.add(result);
       }
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addHeader()

void org.turro.elephant.impl.context.DefaultConstructor.addHeader ( String header )

Parameters

header

Implements org.turro.elephant.context.IConstructor.

Definition at line 682 of file DefaultConstructor.java.

                                        {
     header = header.replaceAll("\\{webRoot\\}", ElephantContext.getRootWebPath());
     headers.add(header);
   }

Here is the call graph for this function:

◆ addJavaScript()

void org.turro.elephant.impl.context.DefaultConstructor.addJavaScript ( String jsFile )

Parameters

jsFile JavaScript file path.

Implements org.turro.elephant.context.IConstructor.

Definition at line 714 of file DefaultConstructor.java.

                                            {
     String result =
             "<script type=\"text/javascript\" src=\"" +
             urlToFile(jsFile) +
             "\"></script>";
     if(!headers.contains(result)) {
       headers.add(result);
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addMeta()

void org.turro.elephant.impl.context.DefaultConstructor.addMeta ( String meta )

Parameters

meta string

Implements org.turro.elephant.context.IConstructor.

Definition at line 725 of file DefaultConstructor.java.

                                    {
     metas.add(meta);
   }

◆ addOnLoadedJavaScript()

void org.turro.elephant.impl.context.DefaultConstructor.addOnLoadedJavaScript ( String script )

Implements org.turro.elephant.context.IConstructor.

Definition at line 737 of file DefaultConstructor.java.

                                                    {
     if(!footers.contains(script)) {
       footers.add(script);
     }
   }

Here is the caller graph for this function:

◆ addRobots()

void org.turro.elephant.impl.context.DefaultConstructor.addRobots ( ElContext context )

Definition at line 743 of file DefaultConstructor.java.

                                            {
     boolean noIndex = context.getWebContext().isNoIndex(),
             noFollow = context.getWebContext().isNoFollow();
     String content = noIndex ? "NOINDEX" : "";
     content = content + (content.length() > 0 && noFollow ? "," : "");
     content = content + (noFollow ? "NOFOLLOW" : "");
     content = (content.length() == 0 ? "ALL" : content);
     String result = "<META NAME=\"ROBOTS\" CONTENT=\"" + content + "\">";
     if(!headers.contains(result)) {
       headers.add(result);
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ canWebAdminister()

boolean org.turro.elephant.impl.context.DefaultConstructor.canWebAdminister ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 779 of file DefaultConstructor.java.

                                     {
     IUser user = getUser();
     return user == null ? false :
           (user.isInRole("context:list") ||
            user.isInRole("default:edit"));
   }

Here is the call graph for this function:

◆ changeCssHeaders()

void org.turro.elephant.impl.context.DefaultConstructor.changeCssHeaders	(	String	from,
		String	to
	)

Implements org.turro.elephant.context.IConstructor.

Definition at line 770 of file DefaultConstructor.java.

                                                        {
     int count = 0;
     for(String s : (List<String>) headers) {
       headers.set(count, s.replace(from, to));
       count++;
     }
   }

◆ closeOut()

void org.turro.elephant.impl.context.DefaultConstructor.closeOut ( ) throws IOException

Implements org.turro.elephant.context.IConstructor.

Definition at line 473 of file DefaultConstructor.java.

                                             {
     if(out != null) out.close();
   }

Here is the caller graph for this function:

◆ decodeURL()

String org.turro.elephant.impl.context.DefaultConstructor.decodeURL ( String url )

Parameters

url	URL to be decoded.

Returns: The decoded URL.

Implements org.turro.elephant.context.IConstructor.

Definition at line 522 of file DefaultConstructor.java.

                                       {
     try {
       if(url != null) return URLDecoder.decode(new String(url.getBytes(ElephantContext.getEncoding()), "UTF-8"), "UTF-8");
     } catch (UnsupportedEncodingException ex) {
       Logger.getLogger(DefaultConstructor.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
     }
     return url;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ encodeURL()

String org.turro.elephant.impl.context.DefaultConstructor.encodeURL ( String url )

Parameters

url	URL to be encoded.

Returns: The encoded URL.

Implements org.turro.elephant.context.IConstructor.

Definition at line 512 of file DefaultConstructor.java.

                                       {
     try {
       return URLEncoder.encode(url, "UTF-8");
     } catch (UnsupportedEncodingException ex) {
       Logger.getLogger(DefaultConstructor.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
     }
     return url;
   }

Here is the call graph for this function:

◆ endBody()

void org.turro.elephant.impl.context.DefaultConstructor.endBody ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 392 of file DefaultConstructor.java.

                         {
     if(getCurrentContext() != null) {
       ElephantMarker marker = new ElephantMarker(this);
       marker.put("footers", footers);
       marker.process("elephant", "endHtml");
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fileExists()

boolean org.turro.elephant.impl.context.DefaultConstructor.fileExists ( String filePath )

Check if file exists within web context

Parameters

filePath Relative path to file

Implements org.turro.elephant.context.IConstructor.

Definition at line 364 of file DefaultConstructor.java.

                                              {
     File file = new File(ElephantContext.getRealPath(filePath));
     return file.exists();
   }

Here is the call graph for this function:

◆ findAttribute()

Object org.turro.elephant.impl.context.DefaultConstructor.findAttribute ( String key )

findAttribute looks sequentially in request, session and application scopes.

Parameters

key	Attribute to find.

Returns: Attribute's value or null.

Implements org.turro.elephant.context.IConstructor.

Definition at line 172 of file DefaultConstructor.java.

                                           {
     Object value = getRequestAttribute(key);
     if(value == null) value = getSessionAttribute(key);
     if(value == null) value = getApplicationAttribute(key);
     return value;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ forceIsAContext()

void org.turro.elephant.impl.context.DefaultConstructor.forceIsAContext ( ElContext context )

Implements org.turro.elephant.context.IConstructor.

Definition at line 140 of file DefaultConstructor.java.

                                                  {
     currentContext = context;
     isAContext = true;
   }

◆ getActionParameter()

String org.turro.elephant.impl.context.DefaultConstructor.getActionParameter ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 555 of file DefaultConstructor.java.

                                      {
     String value = getParameter("action");
     if(value == null) {
       String name;
       Enumeration pn = getRequest().getParameterNames();
       while(pn.hasMoreElements()) {
         name = (String) pn.nextElement();
         if(name.startsWith("action_") && getParameter(name) != null) {
           value = name.substring(7);
           break;
         }
       }
     }
     return value;
   }

Here is the call graph for this function:

◆ getApplicationAttribute()

Object org.turro.elephant.impl.context.DefaultConstructor.getApplicationAttribute ( String key )

Applications attributes live as long as container lives.

Parameters

key	Attribute to find.

Returns: Application attribute's value.

Implements org.turro.elephant.context.IConstructor.

Definition at line 180 of file DefaultConstructor.java.

                                                     {
     return ElephantContext.getAttribute(key);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContextParameter()

String org.turro.elephant.impl.context.DefaultConstructor.getContextParameter ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 572 of file DefaultConstructor.java.

                                       {
     return getParameter("context");
   }

Here is the call graph for this function:

◆ getCurrentContext()

ElContext org.turro.elephant.impl.context.DefaultConstructor.getCurrentContext ( )

Returns: Current IContext.

Implements org.turro.elephant.context.IConstructor.

Definition at line 122 of file DefaultConstructor.java.

                                        {
     if(currentContext == null)
       currentContext = ElContextMap.getContext(this);
     return currentContext;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIdelParameter()

String org.turro.elephant.impl.context.DefaultConstructor.getIdelParameter ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 577 of file DefaultConstructor.java.

                                    {
     return getParameter("idel");
   }

Here is the call graph for this function:

◆ getLastReferringContext()

String org.turro.elephant.impl.context.DefaultConstructor.getLastReferringContext ( )

Administration pages will use this value to know which context was selected before they were called. Here we understand that a context was selected if constructor rendered.

Returns: Last constructed context.

Implements org.turro.elephant.context.IConstructor.

Definition at line 677 of file DefaultConstructor.java.

                                           {
     return Strings.isBlank(History.peek(this), "/");
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLocalizer()

Localizer org.turro.elephant.impl.context.DefaultConstructor.getLocalizer ( )

Returns: A Localizer for current locale.

See also: org.turro.elephant.impl.util.Localizer

Implements org.turro.elephant.context.IConstructor.

Definition at line 607 of file DefaultConstructor.java.

                                   {
     return new Localizer(this);
   }

◆ getOut()

PrintWriter org.turro.elephant.impl.context.DefaultConstructor.getOut ( ) throws IOException

Returns: Current PrintWriter in use.

Exceptions

java.io.IOException

Implements org.turro.elephant.context.IConstructor.

Definition at line 457 of file DefaultConstructor.java.

                                                  {
     if(out == null && !nullOutput) {
       out = response.getWriter();
       if(response.getContentType() == null && pageRendering) {
         startBody();
       }
     }
     return out;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOutputString()

String org.turro.elephant.impl.context.DefaultConstructor.getOutputString ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 494 of file DefaultConstructor.java.

                                   {
     if(stringOutput != null) {
       return stringOutput.toString();
     }
     return null;
   }

◆ getParameter() [1/2]

String org.turro.elephant.impl.context.DefaultConstructor.getParameter ( String param )

Implements org.turro.elephant.context.IConstructor.

Definition at line 532 of file DefaultConstructor.java.

                                            {
     return getParameter(param, false);
   }

Here is the caller graph for this function:

◆ getParameter() [2/2]

String org.turro.elephant.impl.context.DefaultConstructor.getParameter	(	String	param,
		boolean	decode
	)

Implements org.turro.elephant.context.IConstructor.

Definition at line 537 of file DefaultConstructor.java.

                                                            {
     if(decode) {
       return decodeURL(request.getParameter(param));
     }
     return request.getParameter(param);
   }

Here is the call graph for this function:

◆ getParameters()

Parameters org.turro.elephant.impl.context.DefaultConstructor.getParameters ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 550 of file DefaultConstructor.java.

                                     {
     return Parameters.from(request.getParameterMap());
   }

Here is the call graph for this function:

◆ getParameterValues()

String [] org.turro.elephant.impl.context.DefaultConstructor.getParameterValues ( String param )

Implements org.turro.elephant.context.IConstructor.

Definition at line 545 of file DefaultConstructor.java.

                                                    {
     return request.getParameterValues(param);
   }

◆ getRenderingContext()

ElContext org.turro.elephant.impl.context.DefaultConstructor.getRenderingContext ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 129 of file DefaultConstructor.java.

                                          {
     if(rendering == null) return getCurrentContext();
     return rendering;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRequest()

HttpServletRequest org.turro.elephant.impl.context.DefaultConstructor.getRequest ( )

Returns: Current HttpServletRequest.

Implements org.turro.elephant.context.IConstructor.

Definition at line 112 of file DefaultConstructor.java.

                                          {
     return request;
   }

Here is the caller graph for this function:

◆ getRequestAttribute()

Object org.turro.elephant.impl.context.DefaultConstructor.getRequestAttribute ( String key )

Request attributes are visible through a single request. Once the request has given the response they are removed.

Parameters

key	Attribute to find

Returns: Request attribute's value.

Implements org.turro.elephant.context.IConstructor.

Definition at line 217 of file DefaultConstructor.java.

                                                 {
     return request != null ? request.getAttribute(key) : null;
   }

Here is the caller graph for this function:

◆ getResponse()

HttpServletResponse org.turro.elephant.impl.context.DefaultConstructor.getResponse ( )

Returns: Current HttpServletResponse.

Implements org.turro.elephant.context.IConstructor.

Definition at line 117 of file DefaultConstructor.java.

                                            {
     return response;
   }

◆ getSessionAttribute()

Object org.turro.elephant.impl.context.DefaultConstructor.getSessionAttribute ( String key )

Session attributes are stored in visitor sessions, meaning that their value will be available only by current visitor.

Parameters

key	Attribute to find

Returns: Session attribute's value.

Implements org.turro.elephant.context.IConstructor.

Definition at line 185 of file DefaultConstructor.java.

                                                 {
     try {
       if(request != null && request.getSession(false) != null) {
         return request.getSession().getAttribute(key);
       }
     } catch(Exception ex) {
       Logger.getLogger(DefaultConstructor.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
     }
     return null;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSessionAttributeMap()

Map<String, Object> org.turro.elephant.impl.context.DefaultConstructor.getSessionAttributeMap ( String prefix )

Implements org.turro.elephant.context.IConstructor.

Definition at line 197 of file DefaultConstructor.java.

                                                                    {
     HashMap<String, Object> map = new HashMap<>();
     try {
       if(request != null && request.getSession(false) != null) {
         HttpSession session = request.getSession();
         Iterator<String> it = session.getAttributeNames().asIterator();
         while(it.hasNext()) {
           String key = it.next();
           if(Strings.isBlank(prefix) || key.startsWith(prefix)) {
             map.put(Strings.killPrefix(key, prefix), session.getAttribute(key));
           }
         }
       }
     } catch(Exception ex) {
       Logger.getLogger(DefaultConstructor.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
     }
     return map;
   }

Here is the call graph for this function:

◆ getString()

Map org.turro.elephant.impl.context.DefaultConstructor.getString ( )

Definition at line 821 of file DefaultConstructor.java.

                          {
     return I_.compatibilityMap();
   }

Here is the call graph for this function:

◆ getTemplateRoot()

String org.turro.elephant.impl.context.DefaultConstructor.getTemplateRoot ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 808 of file DefaultConstructor.java.

                                   {
     if(templateRoot == null) {
       if(getCurrentContext() != null) {
         templateRoot = getCurrentContext().getTemplateRoot();
       } else {
         templateRoot = ElephantContext.getTemplatesRoot();
       }
     }
     return templateRoot;
   }

Here is the call graph for this function:

◆ getUniqueId()

String org.turro.elephant.impl.context.DefaultConstructor.getUniqueId ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 641 of file DefaultConstructor.java.

                               {
     return "cid_" + IdGenerator.generate() + uniqueSuffix++;
   }

◆ getUser()

IContact org.turro.elephant.impl.context.DefaultConstructor.getUser ( )

Returns: A validated IUser or null if no user was validated.

Implements org.turro.elephant.context.IConstructor.

Definition at line 627 of file DefaultConstructor.java.

                             {
     return (IContact)findAttribute(IUser.LOGGED_USER);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidFileName()

String org.turro.elephant.impl.context.DefaultConstructor.getValidFileName ( String name )

Convenience method for ensuring file names will contain valid characters and no spaces.

Parameters

name	File name.

Returns: A valid file name.

Implements org.turro.elephant.context.IConstructor.

Definition at line 602 of file DefaultConstructor.java.

                                               {
     return name.replaceAll("[^a-zA-Z0-9\\.\\-]", "_");
   }

◆ getValidUrl()

String org.turro.elephant.impl.context.DefaultConstructor.getValidUrl ( String name )

Convenience method for ensuring paths will contain valid characters and no spaces.

Parameters

name	URL to be converted.

Returns: A valid URL.

Implements org.turro.elephant.context.IConstructor.

Definition at line 597 of file DefaultConstructor.java.

                                          {
     return name.replaceAll("[^a-zA-Z0-9\\.\\-\\/]", "_");
   }

◆ hasAnyRoleKey()

boolean org.turro.elephant.impl.context.DefaultConstructor.hasAnyRoleKey ( String role )

Implements org.turro.elephant.context.IConstructor.

Definition at line 661 of file DefaultConstructor.java.

                                             {
     IUser user = getUser();
     if(user != null) {
       return user.hasAnyRoleKey(role);
     } else {
       return false;
     }
   }

Here is the call graph for this function:

◆ includeContent()

void org.turro.elephant.impl.context.DefaultConstructor.includeContent ( String path ) throws ServletException, IOException

This method should act differently depending on which file is to be included:

HTML files. Read file content, process macros and write to output stream. Text files. Read file context and write to output enclosed with PRE tags. Rest of files. Call ServletContext.getRequestDispatcher().

Parameters

path	Relative path to file.

Exceptions

javax.servlet.ServletException
java.io.IOException

Implements org.turro.elephant.context.IConstructor.

Definition at line 401 of file DefaultConstructor.java.

                                                                                {
     getOut();
     if(path.matches(".*\\.(htm|html)")) {
       includeFile(out, ElephantContext.getRealPath(path));
     } else if(path.matches(".*\\.(txt)")) {
       out.println("<pre>");
       includeFile(out, ElephantContext.getRealPath(path));
       out.println("</pre>");
     } else {
       ElephantContext.getCurrent().getRequestDispatcher(path).include(request, response);
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ invalidateSession()

void org.turro.elephant.impl.context.DefaultConstructor.invalidateSession ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 757 of file DefaultConstructor.java.

                                   {
     request.getSession().invalidate();
   }

◆ isFileInternal()

boolean org.turro.elephant.impl.context.DefaultConstructor.isFileInternal ( File file )

This method intends to protect internal files. Since almost everything allocated within web application context will be visible by root context, asking whether a file is internal may prevent showing some folders.

Parameters

file	File to query.

Returns: returns True if file is stored in internal folder structures.

Implements org.turro.elephant.context.IConstructor.

Definition at line 151 of file DefaultConstructor.java.

                                            {
     if(file == null) return true;
     String fileName = file.isFile() ? file.getName() : file.getAbsolutePath();
     String internals = ElephantContext.getSiteInternalFiles();
     if(internals != null) {
       String tmp[] = internals.split(",");
       for(String s : tmp) {
         if(fileName.matches(Strings.convertToRegEx(s))) return true;
       }
     }
     return (fileName.matches("google.*\\.html")) ||
             (fileName.matches("site.*\\.xml")) ||
             (fileName.matches("robots\\.txt")) ||
             (fileName.contains("_internal")) ||
             (fileName.contains("_zul")) ||
             (fileName.contains("resources")) ||
             (fileName.contains("WEB-INF")) ||
             (fileName.contains("META-INF"));
   }

Here is the call graph for this function:

◆ isHeadless()

boolean org.turro.elephant.impl.context.DefaultConstructor.isHeadless ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 86 of file DefaultConstructor.java.

                               {
     return request == null;
   }

◆ isInRole()

boolean org.turro.elephant.impl.context.DefaultConstructor.isInRole ( String role )

IConstructor implementations should return true when the role string gets validated against current user.

Parameters

role	Role string.

Returns: True if current validated user is in role.

Implements org.turro.elephant.context.IConstructor.

Definition at line 646 of file DefaultConstructor.java.

                                        {
     if(("lang:_" + I_.api().used().getLanguage()).equals(role)) {
       return true;
     }
     IUser user = getUser();
     if(user != null) {
       if("user:in".equals(role)) return true;
       if(isWebAdminRole(role) && !isWebAdministering()) return false;
       return user.isInRole(role);
     } else {
       return false;
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isOriginal()

boolean org.turro.elephant.impl.context.DefaultConstructor.isOriginal ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 146 of file DefaultConstructor.java.

                               {
     return getCurrentContext().equals(getRenderingContext());
   }

Here is the call graph for this function:

◆ isOutsider()

boolean org.turro.elephant.impl.context.DefaultConstructor.isOutsider ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 632 of file DefaultConstructor.java.

                               {
     IContact user = getUser();
     if(user != null && user.isValid()) {
       return user.isOutsider();
     }
     return false;
   }

Here is the call graph for this function:

◆ isWebAdministering()

boolean org.turro.elephant.impl.context.DefaultConstructor.isWebAdministering ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 787 of file DefaultConstructor.java.

                                       {
     return "true".equals(getSessionAttribute("xp_webAdministering"));
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ navigateBack()

void org.turro.elephant.impl.context.DefaultConstructor.navigateBack ( ) throws IOException

Implements org.turro.elephant.context.IConstructor.

Definition at line 444 of file DefaultConstructor.java.

                                                 {
     redirect(Strings.isBlank(History.back(this), "/"));
   }

Here is the call graph for this function:

◆ processOutput() [1/2]

void org.turro.elephant.impl.context.DefaultConstructor.processOutput	(	PrintWriter	newOut,
		String	text
	)		throws ServletException, IOException

Implements org.turro.elephant.context.IConstructor.

Definition at line 507 of file DefaultConstructor.java.

                                                                                                   {
     Parser.processMacros(this, newOut, text);
   }

Here is the call graph for this function:

◆ processOutput() [2/2]

void org.turro.elephant.impl.context.DefaultConstructor.processOutput ( String text ) throws ServletException, IOException

Implements org.turro.elephant.context.IConstructor.

Definition at line 502 of file DefaultConstructor.java.

                                                                               {
     processOutput(out, text);
   }

◆ redirect()

void org.turro.elephant.impl.context.DefaultConstructor.redirect ( String path ) throws IOException

Convenience method for redirections within the same context. IConstructor implementations should ensure a call to redirect("/") will redirect to current web application's root.

Parameters

path	Relative path.

Exceptions

java.io.IOException

Implements org.turro.elephant.context.IConstructor.

Definition at line 429 of file DefaultConstructor.java.

                                                        {
     if(Strings.isBlank(path)) path = "/";
     if(path.equals("*")) {
       ElContext ctx = ElContextMap.getCurrent();
       path = ctx != null ? ctx.getPath() : "/";
     }
     if(path.startsWith("http:") || path.startsWith("https:") || !path.startsWith("/") || 
             (!Strings.isBlank(request.getContextPath()) && path.startsWith(request.getContextPath() + "/"))) {
       response.sendRedirect(path);
     } else {
       response.sendRedirect(request.getContextPath() + path);
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reload()

void org.turro.elephant.impl.context.DefaultConstructor.reload ( ) throws IOException

Implements org.turro.elephant.context.IConstructor.

Definition at line 449 of file DefaultConstructor.java.

                                           {
     ElContext elctx = getCurrentContext();
     if(elctx != null) {
       redirect(elctx.getPath());
     }
   }

Here is the call graph for this function:

◆ removeApplicationAttribute()

void org.turro.elephant.impl.context.DefaultConstructor.removeApplicationAttribute ( String key )

Removes application attribute.

Parameters

key

Implements org.turro.elephant.context.IConstructor.

Definition at line 245 of file DefaultConstructor.java.

                                                      {
     ElephantContext.removeAttribute(key);
   }

Here is the call graph for this function:

◆ removeRequestAttribute()

void org.turro.elephant.impl.context.DefaultConstructor.removeRequestAttribute ( String key )

Removes request attribute.

Parameters

key

Implements org.turro.elephant.context.IConstructor.

Definition at line 259 of file DefaultConstructor.java.

                                                  {
     try {
       if(request != null) request.removeAttribute(key);
     } catch(Exception ex) {
       Logger.getLogger(DefaultConstructor.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
     }
   }

Here is the call graph for this function:

◆ removeSessionAttribute()

void org.turro.elephant.impl.context.DefaultConstructor.removeSessionAttribute ( String key )

Removes session attribute.

Parameters

key

Implements org.turro.elephant.context.IConstructor.

Definition at line 250 of file DefaultConstructor.java.

                                                  {
     try {
       if(request != null && request.getSession(false) != null) request.getSession().removeAttribute(key);
     } catch(Exception ex) {
       Logger.getLogger(DefaultConstructor.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
     }
   }

Here is the call graph for this function:

◆ renderContext()

void org.turro.elephant.impl.context.DefaultConstructor.renderContext	(	String	path,
		String	stopper
	)		throws ServletException, IOException

This method includes context's default element content. Instead of calling page construction, as does includeContent, includeContext only renders context content.

Parameters

path	Relative path to file.
stopper	String stopper, defaults to "<end/>"

Exceptions

javax.servlet.ServletException
java.io.IOException

Implements org.turro.elephant.context.IConstructor.

Definition at line 415 of file DefaultConstructor.java.

                                                                                               {
     ElContext ctx;
     if((ctx = ElContextMap.getContext(path)) != null) {
       ElContext tmpCtx = this.rendering;
       String tmpStop = this.stopper;
       setRenderingContext(ctx);
       setStopper("true".equals(stopper) ? "<end/>" : null);
       ctx.getElement().startConstruction();      
       setRenderingContext(tmpCtx);
       setStopper(tmpStop);
     }
   }

Here is the call graph for this function:

◆ setApplicationAttribute()

void org.turro.elephant.impl.context.DefaultConstructor.setApplicationAttribute	(	String	key,
		Object	value
	)

Sets application attribute's value.

Parameters

key
value

Implements org.turro.elephant.context.IConstructor.

Definition at line 222 of file DefaultConstructor.java.

                                                                 {
     ElephantContext.setAttribute(key, value);
   }

Here is the call graph for this function:

◆ setLastReferringContext()

void org.turro.elephant.impl.context.DefaultConstructor.setLastReferringContext ( String context )

IConstructor implementations should set this value when starting a context construction. Context value refers to IContext's path.

Parameters

context Last constructed context.

Implements org.turro.elephant.context.IConstructor.

Definition at line 671 of file DefaultConstructor.java.

                                                       {
     History.add(this, context);
     //setSessionAttribute("xp_ref_ctx", context);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMaxInactiveInterval()

void org.turro.elephant.impl.context.DefaultConstructor.setMaxInactiveInterval ( int interval )

Implements org.turro.elephant.context.IConstructor.

Definition at line 762 of file DefaultConstructor.java.

                                                    {
     HttpSession session = request.getSession();
     if(session != null) {
       session.setMaxInactiveInterval(interval);
     }
   }

◆ setNullOutput()

void org.turro.elephant.impl.context.DefaultConstructor.setNullOutput ( boolean value )

Implements org.turro.elephant.context.IConstructor.

Definition at line 483 of file DefaultConstructor.java.

                                            {
     nullOutput = value;
   }

◆ setOut()

void org.turro.elephant.impl.context.DefaultConstructor.setOut ( PrintWriter out )

Implements org.turro.elephant.context.IConstructor.

Definition at line 468 of file DefaultConstructor.java.

                                       {
     this.out = out; 
   }

Here is the caller graph for this function:

◆ setOutputToString()

void org.turro.elephant.impl.context.DefaultConstructor.setOutputToString ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 488 of file DefaultConstructor.java.

                                   {
     stringOutput = new StringWriter();
     setOut(new PrintWriter(stringOutput));
   }

Here is the call graph for this function:

◆ setPageRendering()

void org.turro.elephant.impl.context.DefaultConstructor.setPageRendering ( boolean value )

Implements org.turro.elephant.context.IConstructor.

Definition at line 478 of file DefaultConstructor.java.

                                               {
     pageRendering = value;
   }

◆ setRenderingContext()

void org.turro.elephant.impl.context.DefaultConstructor.setRenderingContext ( ElContext context )

Implements org.turro.elephant.context.IConstructor.

Definition at line 135 of file DefaultConstructor.java.

                                                      {
     rendering = context;
   }

Here is the caller graph for this function:

◆ setRequest()

void org.turro.elephant.impl.context.DefaultConstructor.setRequest ( ServletRequest request )

Called by ContextFactory during initialization.

Parameters

request Current HttpServletRequest.

Implements org.turro.elephant.context.IConstructor.

Definition at line 91 of file DefaultConstructor.java.

                                                  {
     this.request = (HttpServletRequest)request;
     if(this.request != null) {
       this.request.setAttribute("el_cons", this);
       if(Application.loadResources(((HttpServletRequest) request).getServletPath())) {
         this.request.setAttribute("el_label", I_.compatibilityMap());
         this.request.setAttribute("i_", I_.api());
         this.request.setAttribute("i", I_.map());
         this.request.setAttribute("k", I_.byKeyMap());
       }
     }
   }

Here is the call graph for this function:

◆ setRequestAttribute()

void org.turro.elephant.impl.context.DefaultConstructor.setRequestAttribute	(	String	key,
		Object	value
	)

Sets request attribute's value.

Parameters

key
value

Implements org.turro.elephant.context.IConstructor.

Definition at line 236 of file DefaultConstructor.java.

                                                             {
     try {
       if(request != null && request.getRequestURI() != null) request.setAttribute(key, value);
     } catch(Exception ex) {
       Logger.getLogger(DefaultConstructor.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
     }
   }

Here is the call graph for this function:

◆ setResponse()

void org.turro.elephant.impl.context.DefaultConstructor.setResponse ( ServletResponse response )

Called by ContextFactory during initialization.

Parameters

response Current HttpServletResponse.

Implements org.turro.elephant.context.IConstructor.

Definition at line 105 of file DefaultConstructor.java.

                                                     {
     this.response = (HttpServletResponse)response;
     if(this.response != null)
       CookieUtil.setCookie((HttpServletResponse) response, "webroot", request.getContextPath(), "/", 30*24*60*60);
   }

Here is the call graph for this function:

◆ setSessionAttribute()

void org.turro.elephant.impl.context.DefaultConstructor.setSessionAttribute	(	String	key,
		Object	value
	)

Sets session attribute's value.

Parameters

key
value

Implements org.turro.elephant.context.IConstructor.

Definition at line 227 of file DefaultConstructor.java.

                                                             {
     try {
       if(request != null && request.getSession() != null) request.getSession().setAttribute(key, value);
     } catch(Exception ex) {
       Logger.getLogger(DefaultConstructor.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStopper()

void org.turro.elephant.impl.context.DefaultConstructor.setStopper ( String stopper )

Implements org.turro.elephant.context.IConstructor.

Definition at line 359 of file DefaultConstructor.java.

                                          {
     this.stopper = stopper;
   }

Here is the caller graph for this function:

◆ setWebAdministering()

void org.turro.elephant.impl.context.DefaultConstructor.setWebAdministering ( boolean value )

Implements org.turro.elephant.context.IConstructor.

Definition at line 792 of file DefaultConstructor.java.

                                                  {
     setSessionAttribute("xp_webAdministering", Boolean.toString(value));
   }

Here is the call graph for this function:

◆ startBody()

void org.turro.elephant.impl.context.DefaultConstructor.startBody ( )

Implements org.turro.elephant.context.IConstructor.

Definition at line 370 of file DefaultConstructor.java.

                           {
     response.setContentType("text/html;charset=" + ElephantContext.getEncoding());
     addCSS("https://fonts.googleapis.com/css?family=${site_fonts}");
     MetaList confMetas = new MetaList(ElephantContext.getMetas());
     confMetas.add("<meta http-equiv=\"content-type\" content=\"text/html; charset=" + ElephantContext.getEncoding() + "\">");
     confMetas.addAll(metas);
     if(getCurrentContext() != null) {
       addRobots(getCurrentContext());
       ElephantMarker marker = new ElephantMarker(this);
       marker.put("lang", I_.api().used().getLanguage());
       marker.put("title", HtmlContent.plain(getCurrentContext().getTitle() + " | " + ElephantContext.getSiteName(), 255));
       marker.put("metas", confMetas);
       marker.put("description", ElephantContext.getSiteDescription());
       marker.put("keywords", ElephantContext.getSiteKeywords());
       marker.put("icon", ElephantContext.getSiteIcon());
       marker.put("headers", headers);
       marker.put("isContext", isAContext);
       marker.process("elephant", "startHtml");
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ startConstruction()

void org.turro.elephant.impl.context.DefaultConstructor.startConstruction ( ) throws IOException, ServletException

Starts a page construction. First will locate which headers, including encoding, CSS, JavaScript, etc., are to be inserted. Then will collect all the elements configured to render in current context, instantiate ILayoutManager, ILayout and start rendering.

Exceptions

javax.servlet.ServletException
java.io.IOException

Implements org.turro.elephant.context.IConstructor.

Definition at line 268 of file DefaultConstructor.java.

                                                                        {
     boolean include = request.getServletPath().startsWith("/xp"),
             action = request.getServletPath().startsWith("/xpaction");
     
     if(Actions.executeAction(this)) return;
     
     Element incNode = null;
     //if(checkRedirections()) return;
     if(include) {
       incNode = ContextFactory.getInclude(this);
     }
     if(action) {
       //TODO: check permissions
       request.setAttribute("el_cons", this);
       IAction exec = ContextFactory.getAction(this);
       try {
         exec.execute();
       } catch (Exception ex) {
         throw new ServletException(ex);
       }
     } else {
       request.setAttribute("el_cons", this);
       if(incNode != null) {
         Iterator heads = incNode.getChildren("header").iterator();
         Element tmp;
         while(heads.hasNext()) {
           tmp = (Element) heads.next();
           switch (tmp.getAttributeValue("type")) {
             case "css":
               addCSS(tmp.getAttributeValue("content"));
               break;
             case "javascript":
               addJavaScript(tmp.getAttributeValue("content"));
               break;
           }
         }
       }
       if(incNode != null) {
         //TODO: check permissions
         includeContent(incNode.getAttributeValue("content"));
       } else {
         if(getCurrentContext() == null || !getCurrentContext().getFile().exists()) {
           redirect("/");
           return;
         } else {
           if(!Strings.isBlank(getCurrentContext().getWebContext().getRedirect())) {
             if(getCurrentContext().isInRole()) {
               setLastReferringContext(getCurrentContext().getPath());
               redirect(getCurrentContext().getWebContext().getRedirect());
               return;
             } else if(getUser() == null) {
               ElephantLogin.redirectToLogin(this);
               return;
             } else {
               redirect(getLastReferringContext());
               return;
             }
           } else {
             if(getCurrentContext().isInRole()) {
               setLastReferringContext(getCurrentContext().getPath());
               isAContext = true;
               addOnLoadedJavaScript("webRoot = '" + ElephantContext.getRootWebPath() + "';");
               addOnLoadedJavaScript("webPort = " + getRequest().getServerPort() + ";");
               addOnLoadedJavaScript("pushPK = '" + Secrets.getSecret("key=push;pair=pk") + "';");
               IUser iuser = getUser();
               if(iuser != null) {
                 addOnLoadedJavaScript("currentMail = '" + iuser.getProperty(IUser.CONNECTOR_EMAIL) + "';");
               } else {
                 addOnLoadedJavaScript("currentMail = null;");
               }
               Boolean internalSignIn = (Boolean) getSessionAttribute(IUser.INTERNAL_SIGNIN);
               if(internalSignIn != null && internalSignIn) {
                 addOnLoadedJavaScript("internalSignIn = true;");
               }
               getCurrentContext().construct(this);
             } else if(getUser() == null) {
               ElephantLogin.redirectToLogin(this);
               return;
             } else {
               redirect("/");
               return;
             }
           }
         }
       }
       endBody();
       closeOut();
     }
   }

Here is the call graph for this function:

◆ urlToFile()

String org.turro.elephant.impl.context.DefaultConstructor.urlToFile ( String file )

Definition at line 729 of file DefaultConstructor.java.

                                        {
     if(file.startsWith("http:") || file.startsWith("https:")) {
       return file;
     }
     return ElephantContext.getRootWebPath() + file;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ bundle

Properties org.turro.elephant.impl.context.DefaultConstructor.bundle = null

protected

Definition at line 70 of file DefaultConstructor.java.

◆ BUNDLE_LOCATION

final String org.turro.elephant.impl.context.DefaultConstructor.BUNDLE_LOCATION = "/WEB-INF/classes/elephant.properties"

staticprotected

Definition at line 66 of file DefaultConstructor.java.

◆ hasMootools

boolean org.turro.elephant.impl.context.DefaultConstructor.hasMootools = false

protected

Definition at line 76 of file DefaultConstructor.java.

◆ isAContext

boolean org.turro.elephant.impl.context.DefaultConstructor.isAContext = false

protected

Definition at line 74 of file DefaultConstructor.java.

◆ metas

ArrayList org.turro.elephant.impl.context.DefaultConstructor.metas = new ArrayList()

protected

Definition at line 73 of file DefaultConstructor.java.

◆ out

PrintWriter org.turro.elephant.impl.context.DefaultConstructor.out = null

protected

Definition at line 71 of file DefaultConstructor.java.

◆ rendering

ElContext org.turro.elephant.impl.context.DefaultConstructor.rendering = null

protected

Definition at line 69 of file DefaultConstructor.java.

◆ request

HttpServletRequest org.turro.elephant.impl.context.DefaultConstructor.request

protected

Definition at line 67 of file DefaultConstructor.java.

◆ response

HttpServletResponse org.turro.elephant.impl.context.DefaultConstructor.response

protected

Definition at line 68 of file DefaultConstructor.java.

◆ stopper

String org.turro.elephant.impl.context.DefaultConstructor.stopper

protected

Definition at line 75 of file DefaultConstructor.java.

◆ stringOutput

StringWriter org.turro.elephant.impl.context.DefaultConstructor.stringOutput = null

protected

Definition at line 72 of file DefaultConstructor.java.

The documentation for this class was generated from the following file:

DefaultConstructor.java

Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DefaultConstructor()

Member Function Documentation

◆ addCSS()

◆ addHeader()

◆ addJavaScript()

◆ addMeta()

◆ addOnLoadedJavaScript()

◆ addRobots()

◆ canWebAdminister()

◆ changeCssHeaders()

◆ closeOut()

◆ decodeURL()

◆ encodeURL()

◆ endBody()

◆ fileExists()

◆ findAttribute()

◆ forceIsAContext()

◆ getActionParameter()

◆ getApplicationAttribute()

◆ getContextParameter()

◆ getCurrentContext()

◆ getIdelParameter()

◆ getLastReferringContext()

◆ getLocalizer()

◆ getOut()

◆ getOutputString()

◆ getParameter() [1/2]

◆ getParameter() [2/2]

◆ getParameters()

◆ getParameterValues()

◆ getRenderingContext()

◆ getRequest()

◆ getRequestAttribute()

◆ getResponse()

◆ getSessionAttribute()

◆ getSessionAttributeMap()

◆ getString()

◆ getTemplateRoot()

◆ getUniqueId()

◆ getUser()

◆ getValidFileName()

◆ getValidUrl()

◆ hasAnyRoleKey()

◆ includeContent()

◆ invalidateSession()

◆ isFileInternal()

◆ isHeadless()

◆ isInRole()

◆ isOriginal()

◆ isOutsider()

◆ isWebAdministering()

◆ navigateBack()

◆ processOutput() [1/2]

◆ processOutput() [2/2]

◆ redirect()

◆ reload()

◆ removeApplicationAttribute()

◆ removeRequestAttribute()

◆ removeSessionAttribute()

◆ renderContext()

◆ setApplicationAttribute()

◆ setLastReferringContext()

◆ setMaxInactiveInterval()

◆ setNullOutput()

◆ setOut()

◆ setOutputToString()

◆ setPageRendering()

◆ setRenderingContext()

◆ setRequest()

◆ setRequestAttribute()

◆ setResponse()

◆ setSessionAttribute()

◆ setStopper()

◆ setWebAdministering()