IConstructor.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2011 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.turro.elephant.context;
 
import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.Map;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.turro.action.Parameters;
import org.turro.elephant.impl.util.Localizer;
import org.turro.elephant.web.ElContext;
import org.turro.elephant.web.context.WebContext;
import org.turro.plugin.contacts.IContact;
 
public interface IConstructor {
 
  public boolean isHeadless();
  public void setRequest(ServletRequest request);
  public void setResponse(ServletResponse response);
  public HttpServletRequest getRequest();
  public HttpServletResponse getResponse();
  public ElContext getCurrentContext();
  public ElContext getRenderingContext();
  public void setRenderingContext(ElContext context);
  public void forceIsAContext(ElContext context);
  public boolean isOriginal();
  
  public String getUniqueId();
 
  public boolean isFileInternal(File file);
  public Object findAttribute(String key);
  public Object getApplicationAttribute(String key);
  public Object getSessionAttribute(String key);
  public Map<String, Object> getSessionAttributeMap(String prefix);
  public Object getRequestAttribute(String key);
  public void setApplicationAttribute(String key, Object value);
  public void setSessionAttribute(String key, Object value);
  public void setRequestAttribute(String key, Object value);
  public void removeApplicationAttribute(String key);
  public void removeSessionAttribute(String key);
  public void removeRequestAttribute(String key);
  public void setLastReferringContext(String context);
  public String getLastReferringContext();
  public void addHeader(String header);
  public void addCSS(String cssFile);
  public void addMeta(String meta);
  public void addJavaScript(String jsFile);
  public void addOnLoadedJavaScript(String script);
  public void startConstruction() throws ServletException, IOException;
  public void startBody();
  public void endBody();
  public void setStopper(String stopper);
  public void includeContent(String path) throws ServletException, IOException;
  public void renderContext(String path, String stopper) throws ServletException, IOException;
  public void redirect(String path) throws IOException;
  public void navigateBack() throws IOException;
  public void reload() throws IOException;
  public PrintWriter getOut() throws IOException;
  public void setOut(PrintWriter out) throws IOException;
  public void closeOut() throws IOException;
  public void setPageRendering(boolean value);
  public void setNullOutput(boolean value);
  public void setOutputToString();
  public String getOutputString();
  public void processOutput(String text) throws ServletException, IOException;
  public void processOutput(PrintWriter out, String text) throws ServletException, IOException;
  public void changeCssHeaders(String from, String to);
  
//  /**
//   * This method should return selected context's children. Path is a relative path
//   * to any context. Level controls which context in path will be selected, for example:
//   * 
//   * path = /docs/api/elephant
//   * 
//   * level = 0, returns '/' children.
//   * level = 1, returns '/docs' children.
//   * level = 2, returns '/docs/api' children.
//   * 
//   * and so on.
//   * @param from Relative context path.
//   * @param level Context level, starting with root = 0.
//   * @return Selected context's children.
//   */
//  public IContext[] getContexts(String from, int level);
  public String encodeURL(String url);
  public String decodeURL(String url);
  public String getValidUrl(String name);
  public String getValidFileName(String name);
  public Localizer getLocalizer();
  public IContact getUser();
  public boolean isOutsider();
  public boolean isInRole(String role);
  public boolean hasAnyRoleKey(String role);
  public String getParameter(String param);
  public String getParameter(String param, boolean decode);
  public String[] getParameterValues(String param);
  public Parameters getParameters();
  public String getContextParameter();
  public String getIdelParameter();
  public String getActionParameter();
  //public boolean checkTemporalSession(HttpServletRequest request);
  public void invalidateSession();
  public void setMaxInactiveInterval(int i);
 
  public boolean canWebAdminister();
  public boolean isWebAdministering();
  public void setWebAdministering(boolean value);
 
  public boolean fileExists(String filePath);
 
  public String getTemplateRoot();
  
  /* Repositories */
  
  public static String currentRepository(IConstructor constructor) {
    String repository = WebContext.relativeRepository();
    if(constructor != null) {
      ElContext ctx = constructor.getRenderingContext();
      if(ctx != null) {
        repository = ctx.getRepositoryPath();
      }
    }
    return ElephantContext.getRootWebPath() + repository;
  }
 
  public static String globalRepository() {
    return ElephantContext.getRootWebPath() + WebContext.relativeRepository();
  }
 
}