org.xins.server.BackpackConstants Maven / Gradle / Ivy

Go to download
package org.xins.server;

/*
 * Properties names used in the backpack.
 *
 * @version $Revision: 1.2 $ $Date: 2012/02/25 17:51:07 $
 * @author Anthony Goubard
 *
 * @since XINS 3.0
 */
public interface BackpackConstants {

   /**
    * The key used to store the name of the function in the backpack.
    */
   String FUNCTION_NAME = "_functionName";

   /**
    * The key used to store the request IP address in the backpack.
    * The value is added by XINS Engine, so it's always available in the function.
    */
   String IP = "_ip";

   /**
    * The key used to indicating whether the function should be skipped or not.
    * Default is function not skipped.
    * If set, the value should be a Boolean.
    */
   String SKIP_FUNCTION_CALL = "_skipFunctionCall";

   /**
    * The key used to store the starting time of the call to the function.
    * The value is the number of milliseconds since the UNIX Epoch.
    */
   String START = "_start";

}