br.com.softplan.security.zap.commons.boot.ZapBoot Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of zap-utils Show documentation

Utils module responsible for ZAP automatic initialization

There is a newer version: 1.2.1-0

package br.com.softplan.security.zap.commons.boot;

import br.com.softplan.security.zap.commons.ZapInfo;

/**
 * This interface should be implemented by any class capable 
 * of starting and stopping ZAP, no matter how.
 * 
 * @author pdsec
 */
interface ZapBoot {

	/**
	 * Starts ZAP.
	 * 
	 * It should throw {@link br.com.softplan.security.zap.commons.exception.ZapInitializationTimeoutException ZapInitializationTimeoutException} 
	 * in case ZAP is not started before a timeout, defined by {@code zapInfo.initializationTimeout}
	 * (the default value is {@code 120000}).
	 * 
	 * @param zapInfo an object with all the information needed to start ZAP.
	 */
	void startZap(ZapInfo zapInfo);
	
	/**
	 * Stops ZAP.
	 */
	void stopZap();
	
}