ItsNatServletConfigImpl.java :  » Ajax » ItsNat » org » itsnat » impl » core » Java Open Source

/*
  ItsNat Java Web Application Framework
  Copyright (C) 2007 Innowhere Software Services S.L., Spanish Company
  Author: Jose Maria Arranz Santamaria

  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. See the GNU Affero General Public 
  License for more details. See the copy of the GNU Affero General Public License
  included in this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.itsnat.impl.core;

import java.text.DateFormat;
import java.text.NumberFormat;
import java.util.HashMap;
import java.util.Map;
import org.itsnat.core.ItsNatServletConfig;
import org.itsnat.core.ItsNatServletContext;
import javax.servlet.ServletConfig;
import org.itsnat.core.ItsNatException;
import org.itsnat.core.ClientErrorMode;
import org.itsnat.core.SyncMode;
import org.itsnat.core.UseGZip;
import org.itsnat.impl.core.http.ItsNatImpl;

/**
 *
 * @author jmarranz
 */
public class ItsNatServletConfigImpl extends ItsNatUserDataImpl implements ItsNatServletConfig
{
    protected ServletConfig servletConfig;
    protected ItsNatServletImpl servlet;        
    protected ItsNatServletContextImpl servletContext;    
    protected Map cacheDOMNodesByMime = new HashMap();
    protected int syncMode = SyncMode.ASYNC_HOLD;   
    protected long ajaxTimeout = -1; // No timeout
    protected String defaultEncoding = "UTF-8"; // "ISO-8859-1" "UTF-8"
    protected boolean debugMode = false;
    protected int clientErrorMode = ClientErrorMode.SHOW_SERVER_AND_CLIENT_ERRORS;
    protected boolean loadScriptInline = true;    
    protected boolean fastLoadMode = true;
    protected boolean nodeCacheEnabled = true;
    protected String jsFilesBasePath = "js";
    protected boolean addJSFiles = true;
    protected boolean autoBuildComponents = false;    
    protected int useGZip = UseGZip.SCRIPT; // Slo el JavaScript
    protected DateFormat dateFormat = DateFormat.getInstance();
    protected NumberFormat numberFormat = NumberFormat.getInstance();    
    protected long evtDispMaxWait = 0;
    protected boolean referrerEnabled = false; // El sistema de referrers requiere que el programador lo necesite por lo que lo normal es que lo active en los templates que lo necesiten
    protected boolean referrerPushEnabled = false; // Idem referrerEnabled
    protected boolean ajaxEnabled = true;
    protected boolean scriptEnabled = true;  
    protected boolean autoCleanEventListeners = true;
    protected boolean usePatternMarkupToRender = false;     
    protected Map artifacts;    
    
    /** Creates a new instance of ItsNatServletConfigImpl */
    public ItsNatServletConfigImpl(ServletConfig servletConfig,ItsNatServletImpl servlet)
    {
        super(true);
        
        this.servletConfig = servletConfig;
        this.servlet = servlet;
      
        ItsNatImpl itsNat = servlet.getItsNatImpl();
        this.servletContext = itsNat.getItsNatServletContextImpl(servletConfig.getServletContext());

        cacheDOMNodesByMime.put("text/html",Boolean.TRUE);
        cacheDOMNodesByMime.put("application/xhtml+xml",Boolean.TRUE);                
        cacheDOMNodesByMime.put("text/xml",Boolean.FALSE); // No tiene mucho sentido cachear nodos pues si generamos un XML todo seguramente ser contenido generado y nada esttico           
    }
    
    
    public ServletConfig getServletConfig()
    {
        return servletConfig;
    }

    public ItsNatServletContext getItsNatServletContext()
    {
        return servletContext;
    }
    
    public ItsNatServletContextImpl getItsNatServletContextImpl()
    {
        return servletContext;
    }        
    
    public void checkIsAlreadyUsed()
    {    
        servlet.checkIsAlreadyUsed();
    }
    
    public int getDefaultSyncMode()
    {
        return syncMode;
    }
    
    public void setDefaultSyncMode(int syncMode)
    {
        checkIsAlreadyUsed();
        
        checkSyncMode(syncMode);        
        this.syncMode = syncMode;
    }       
       
    public long getAJAXTimeout()
    {
        return ajaxTimeout;
    }

    public void setAJAXTimeout(long timeout)  
    {
        checkIsAlreadyUsed();
        
        this.ajaxTimeout = timeout; // Un valor 0 o negativo es no usar el timeout
    }
    
    public static void checkSyncMode(int syncMode)
    {
        //int ASYNC = 1;
        //int ASYNC_HOLD = 2;    
        //int SYNC  = 3; 
        if ((syncMode < SyncMode.ASYNC)||(syncMode > SyncMode.SYNC))
            throw new ItsNatException("Bad sync mode: " + syncMode);    
    }    
    
    public int getUseGZip()
    {
        return useGZip;
    }
    
    public void setUseGZip(int value)   
    {
        checkIsAlreadyUsed();
        
        this.useGZip = value;
    } 
    
    public boolean isOnLoadCacheStaticNodes(String mime)
    {
        Boolean value = (Boolean)cacheDOMNodesByMime.get(mime);
        if (value == null)
            return false;
        return value.booleanValue();
    }
    
    public void setOnLoadCacheStaticNodes(String mime,boolean cache)
    {
        checkIsAlreadyUsed();
        
        cacheDOMNodesByMime.put(mime,Boolean.valueOf(cache));
    }    
    
    public String getDefaultEncoding()
    {
        return defaultEncoding;
    }
    
    public void setDefaultEncoding(String defaultEncoding)
    {
        checkIsAlreadyUsed();
        
        this.defaultEncoding = defaultEncoding;
    }    
    
    public boolean isLoadScriptInline()
    {
        return loadScriptInline;
    }
    
    public void setLoadScriptInline(boolean value)
    {
        checkIsAlreadyUsed();
        
        this.loadScriptInline = value;
    }    

    public boolean isDebugMode()
    {
        return debugMode;
    }

    public void setDebugMode(boolean debugMode)
    {
        checkIsAlreadyUsed();
        
        this.debugMode = debugMode;
    }
    
    public int getClientErrorMode()
    {
        return clientErrorMode;
    }

    public void setClientErrorMode(int mode)
    {
        checkIsAlreadyUsed();      
        
        this.clientErrorMode = mode;
    }    
    
    public boolean isFastLoadMode()
    {
        return fastLoadMode;
    }
    
    public void setFastLoadMode(boolean fastLoadMode)
    {
        checkIsAlreadyUsed();
        
        this.fastLoadMode = fastLoadMode;
    }
    
    public boolean isNodeCacheEnabled()
    {
        return nodeCacheEnabled;
    }
    
    public void setNodeCacheEnabled(boolean nodeCacheEnabled)
    {
        checkIsAlreadyUsed();
        
        this.nodeCacheEnabled = nodeCacheEnabled;
    }
    
    public String getFrameworkScriptFilesBasePath()
    {
        return jsFilesBasePath;
    }
    
    public void setFrameworkScriptFilesBasePath(String path)
    {
        checkIsAlreadyUsed();
        
        this.jsFilesBasePath = path;
    }

    public boolean isAddFrameworkScriptFiles()
    {
        return addJSFiles;
    }    

    public void setAddFrameworkScriptFiles(boolean value)
    {
        checkIsAlreadyUsed();
        
        this.addJSFiles = value;
    }    
    
    public boolean isAutoBuildComponents()
    {
        return autoBuildComponents;
    }

    public void setAutoBuildComponents(boolean autoBuildComponents)
    {
        checkIsAlreadyUsed();
        
        this.autoBuildComponents = autoBuildComponents;     
    }        
    
    public DateFormat getDefaultDateFormat()
    {
        return dateFormat;
    }

    public void setDefaultDateFormat(DateFormat dateFormat)
    {
        checkIsAlreadyUsed();
        
        this.dateFormat = dateFormat;
    }   
    
    public NumberFormat getDefaultNumberFormat()
    {
        return numberFormat;
    }

    public void setDefaultNumberFormat(NumberFormat numberFormat)
    {
        checkIsAlreadyUsed();
        
        this.numberFormat = numberFormat;
    }    
    
    public long getEventDispatcherMaxWait()
    {
        return evtDispMaxWait;
    }
    
    public void setEventDispatcherMaxWait(long wait)
    {
        checkIsAlreadyUsed();
        
        this.evtDispMaxWait = wait;
    }    
    
    public boolean isReferrerEnabled()
    {
        return referrerEnabled;
    }

    public void setReferrerEnabled(boolean referrerEnabled)
    {
        checkIsAlreadyUsed();
        
        this.referrerEnabled = referrerEnabled;
    }            
    
    public boolean isReferrerPushEnabled()    
    {
        return referrerPushEnabled;
    }    
    
    public void setReferrerPushEnabled(boolean referrerPushEnabled)
    {
        checkIsAlreadyUsed();
        
        this.referrerPushEnabled = referrerPushEnabled;     
    }            
    
    public boolean isAJAXEnabled()
    {
        return ajaxEnabled;
    }

    public void setAJAXEnabled(boolean enable)
    {
        checkIsAlreadyUsed();
        
        this.ajaxEnabled = enable;
    }
    
    public boolean isScriptingEnabled()
    {
        return scriptEnabled;
    }

    public void setScriptingEnabled(boolean enabled)
    {
        checkIsAlreadyUsed();
        
        this.scriptEnabled = enabled;
        
        if (!enabled)
        {
            setAJAXEnabled(false);
            setFastLoadMode(true); // Pues el modo "slow" necesariamente necesita enviar JavaScript por los cambios en el DOM en tiempo de carga
        }
    }    
    
    public boolean isAutoCleanEventListeners()
    {
        return autoCleanEventListeners;
    }           

    public void setAutoCleanEventListeners(boolean enable)
    {
        checkIsAlreadyUsed();
        
        this.autoCleanEventListeners = enable;
    }
        
    public boolean isUsePatternMarkupToRender()
    {
        return usePatternMarkupToRender;
    }

    public void setUsePatternMarkupToRender(boolean usePatternMarkupToRender)
    {
        checkIsAlreadyUsed();        
        this.usePatternMarkupToRender = usePatternMarkupToRender;
    }     
    
    public boolean hasArtifacts()
    {
        if (artifacts == null) return false;
        return !artifacts.isEmpty();
    }
    
    public Map getArtifactMap()
    {
        if (artifacts == null)
            this.artifacts = new HashMap();
        return artifacts;
    }
    
    public Object getArtifact(String name)
    {
        if (!hasArtifacts()) return null;
        
        Map artifacts = getArtifactMap();
        return artifacts.get(name);        
    }
    
    public void registerArtifact(String name,Object value)
    {
        checkIsAlreadyUsed(); // As evitamos sincronizar (slo lectura)
        
        Map artifacts = getArtifactMap();
        artifacts.put(name,value);        
    }
    
    public Object removeArtifact(String name)
    {
        checkIsAlreadyUsed(); // As evitamos sincronizar (slo lectura)
        
        Map artifacts = getArtifactMap();
        return artifacts.remove(name);        
    }

}