/*******************************************************************************
* This file is part of OpenNMS(R).
*
* Copyright (C) 2006-2011 The OpenNMS Group, Inc.
* OpenNMS(R) is Copyright (C) 1999-2011 The OpenNMS Group, Inc.
*
* OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
*
* OpenNMS(R) 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.
*
* OpenNMS(R) 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 OpenNMS(R). If not, see:
* http://www.gnu.org/licenses/
*
* For more information contact:
* OpenNMS(R) Licensing <license@opennms.org>
* http://www.opennms.org/
* http://www.opennms.com/
*******************************************************************************/
package org.opennms.web.vulnerability.filter;
import java.sql.PreparedStatement;
import java.sql.SQLException;
/**
* Encapsulates all negative protocol filtering functionality.
*
* @author ranger
* @version $Id: $
* @since 1.8.1
*/
public class NegativeProtocolFilter extends Object implements Filter {
/** Constant <code>TYPE="protocolnot"</code> */
public static final String TYPE = "protocolnot";
protected String protocol;
/**
* <p>Constructor for NegativeProtocolFilter.</p>
*
* @param protocol a {@link java.lang.String} object.
*/
public NegativeProtocolFilter(String protocol) {
if (protocol == null) {
throw new IllegalArgumentException("Cannot take null parameters.");
}
this.protocol = protocol;
}
/**
* <p>getSql</p>
*
* @return a {@link java.lang.String} object.
*/
public String getSql() {
return (" (PROTOCOL<>'" + this.protocol + "' OR PROTOCOL IS NULL)");
}
/**
* <p>getParamSql</p>
*
* @return a {@link java.lang.String} object.
*/
public String getParamSql() {
return (" (PROTOCOL<>? OR PROTOCOL IS NULL)");
}
/** {@inheritDoc} */
public int bindParam(PreparedStatement ps, int parameterIndex) throws SQLException {
ps.setString(parameterIndex, this.protocol);
return 1;
}
/**
* <p>getDescription</p>
*
* @return a {@link java.lang.String} object.
*/
public String getDescription() {
return (TYPE + "=" + this.protocol);
}
/**
* <p>getTextDescription</p>
*
* @return a {@link java.lang.String} object.
*/
public String getTextDescription() {
return ("protocol is not " + this.protocol);
}
/**
* <p>toString</p>
*
* @return a {@link java.lang.String} object.
*/
public String toString() {
return ("<Vulnerability Negative Protocol Filter: " + this.getDescription() + ">");
}
/**
* <p>Getter for the field <code>protocol</code>.</p>
*
* @return a {@link java.lang.String} object.
*/
public String getProtocol() {
return (this.protocol);
}
/** {@inheritDoc} */
public boolean equals(Object obj) {
return (this.toString().equals(obj.toString()));
}
}