/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2002-2011, Open Source Geospatial Foundation (OSGeo)
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation;
 *    version 2.1 of the License.
 *
 *    This library 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
 *    Lesser General Public License for more details.
 */
package org.geotools.data.teradata;

import java.util.HashMap;
import java.util.Map;

/**
 * Thread local table that holds transaction local query bands.
 * 
 * @author Justin Deoliveira, OpenGeo
 *
 *
 * @source $URL$
 */
public class QueryBand {

    /**
     * Session query band for name of application.
     */
    public static String APPLICATION = "Application";
    
    /**
     * Local query band for user name executing request.
     */
    public static String CLIENT_USER = "ClientUser";
    /**
     * Local query band for host name executing request.
     */
    public static String CLIENT_HOST = "ClientHostName";
    /**
     * Local query band for layer being worked against.
     */
    public static String LAYER = "Layer";
    /**
     * Local query band for type of statement, SELECT, DELETE, etc...
     */
    public static String PROCESS = "Process";
    
    static ThreadLocal<Map<String,String>> LOCAL = new ThreadLocal<Map<String,String>>() {
        protected Map<String,String> initialValue() {
            return new HashMap<String, String>();
        };
    };
    
    /**
     * Returns local query band map.
     */
    public static Map<String,String> local() {
        return LOCAL.get();
    }
    
    /**
     * Clears the local query band thread local.
     */
    public static void remove() {
        LOCAL.remove();
    }

}