org.owasp.jbrofuzz.version.PrefEntry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jbrofuzz-encoder Show documentation

JBroFuzz is a stateless web application fuzzer for requests being made over HTTP and/or HTTPS. Its purpose is to provide a single, portable application that offers stable web protocol fuzzing capabilities. As a tool, it emerged from the needs of penetration testing.

There is a newer version: 2.5.1

Show newest version

/**
 * JbroFuzz 2.5
 *
 * JBroFuzz - A stateless network protocol fuzzer for web applications.
 * 
 * Copyright (C) 2007 - 2010 [email protected]
 *
 * This file is part of JBroFuzz.
 * 
 * JBroFuzz 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.
 * 
 * JBroFuzz 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 JBroFuzz.  If not, see .
 * Alternatively, write to the Free Software Foundation, Inc., 51 
 * Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * 
 * Verbatim copying and distribution of this entire program file is 
 * permitted in any medium without royalty provided this notice 
 * is preserved. 
 * 
 */
package org.owasp.jbrofuzz.version;

/**
 * A preference entry is a class holding the id (e.g.
 * ui.window.width) the title (as displayed in the 
 * Preferences menu, as well as the tool tip (i.e. a short
 * description) for that preference entry.
 * 
 * @author [email protected]
 * @version 2.0
 * @since 2.0
 */
public class PrefEntry {

	private final String id, title, tooltip;

	private final boolean requiresRestart;
	
	/**
	 * Constructor, passing the id (e.g. ui.window.width) the title 
	 * (as displayed in the Preferences menu, as well as the tool 
	 * tip (i.e. a short description) for that preference 
	 * entry.
	 * 
	 * @param id
	 * @param title
	 * @param tooltip
	 */
	protected PrefEntry(String id, String title, String tooltip) {
		super();
		this.id = id;
		this.title = title;
		this.tooltip = tooltip;
		requiresRestart = false;
	}

	/**
	 * Constructor, passing the id (e.g. ui.window.width) the title 
	 * (as displayed in the Preferences menu, as well as the tool 
	 * tip (i.e. a short description) for that preference 
	 * entry.
	 * 
	 * @param id
	 * @param title
	 * @param tooltip
	 * @param requiresRestart
	 * 			whether or not the preference requires a restart of 
	 * 			JBroFuzz to be applied correctly
	 */
	protected PrefEntry(String id, String title, String tooltip, boolean requiresRestart) {
		super();
		this.id = id;
		this.title = title;
		this.tooltip = tooltip;
		this.requiresRestart = requiresRestart;
	}

	/**
	 * Get the id, e.g. ui.window.width
	 * 
	 * @return A String value such as the above
	 * 
	 */
	public final String getId() {
		return id;
	}

	/**
	 * Return the title, e.g. "Fuzzing Directory (where data is saved)"
	 * 
	 * If the preference entry has been instaniated using the boolean
	 * "requiresRestart" set to true, then after the title the String 
	 * " (requires restart) " will be appended.
	 * 
	 * @return A String value such as the above
	 * 
	 */
	public final String getTitle() {
		if(requiresRestart) {
			return title + " (requires restart)";
		} else {
			return title;
		}
	}

	/**
	 * Return the tool tip, e.g. " Select Directory to Save Fuzzing Data "
	 * 
	 * @return A String value such as the above
	 * 
	 */
	public final String getTooltip() {
		return tooltip;
	}
}