org.jwall.web.audit.rules.Condition Maven / Gradle / Ivy

Go to download
/*
 *  Copyright (C) 2007-2014 Christian Bockermann 
 *
 *  This file is part of the  web-audit  library.
 *
 *  web-audit library is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The  web-audit  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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see .
 *
 */
package org.jwall.web.audit.rules;

import java.io.Serializable;
import java.util.List;

import org.jwall.web.audit.AuditEvent;
import org.jwall.web.audit.filter.Operator;


/**
 * 
 * This is the basic interface which needs to be implemented by all
 * rule conditions.
 * 
 * 
 * @author Christian Bockermann <[email protected]>
 */
public interface Condition
    extends Serializable
{
    public final static String EQ = Operator.EQ.toString();
    public final static String LT = Operator.LT.toString();
    public final static String LE = Operator.LE.toString();
    public final static String GT = Operator.GT.toString();
    public final static String GE = Operator.GE.toString();
    public final static String PM = Operator.PM.toString();
    public final static String RX = Operator.RX.toString();
    public final static String SX = Operator.SX.toString();
    public final static String IN = Operator.IN.toString();

    /**
     * Returns the variable on which this condition acts.
     * 
     * @return
     */
    public String getVariable();
    
    
    /**
     * Sets the variable on which this condition needs to match.
     * 
     * @param variable
     */
    public void setVariable( String variable );
    
    
    /**
     * This method returns the value used by this condition to match
     * the value of the variable against.
     * 
     * @return
     */
    public String getValue();
    
    
    /**
     * This returns a textual representation of the operator of this condition. 
     * 
     * @return
     */
    public String getOperator();


    /**
     * This method executes the condition against the given event. This is
     * basically the core-functionality of this instance.
     * 
     * @param evt
     * @return
     */
    public boolean matches( AuditEvent evt );
    
    
    public boolean matches( List values );
    
    
    /**
     * 
     * 
     * @param pattern
     * @param input
     * @return
     */
    public boolean matches( String pattern, String input );
}