ScanListener.java

/*
 * Zed Attack Proxy (ZAP) and its related class files.
 * 
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License at 
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0 
 *   
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 * See the License for the specific language governing permissions and 
 * limitations under the License. 
 */
package org.zaproxy.zap.scan;

/**
 * A listener interface for events related to Scanner Threads on Contexts.
 * 
 * @see BaseContextScannerThread
 */
public interface ScanListener {

	/**
	 * Callback method called when the scan has started.
	 *
	 * @param contextId the context id
	 */
	void scanStarted(int contextId);

	/**
	 * Callback method called when the scan has finished.
	 *
	 * @param contextId the context id
	 */
	void scanFinished(int contextId);

	/**
	 * Callback method called when the scan has changes its progress.
	 *
	 * @param contextId the context id
	 * @param progress the progress
	 * @param maximumProgress the maximum
	 */
	void scanProgress(int contextId, int progress, int maximumProgress);
}