ICaptchaService.java

/*
 * Copyright (c) 2002-2016, Mairie de Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.portal.service.captcha;

import java.util.List;

import javax.servlet.http.HttpServletRequest;

/**
 * Interface for captcha validator
 */
public interface ICaptchaService
{
    /**
     * Validate the captcha field
     * 
     * @param request
     *            The HTTP request
     * @return True if OK, otherwise false
     */
    boolean validate( HttpServletRequest request );

    /**
     * Gets the captcha HTML code
     * 
     * @return The captcha HTML code
     */
    String getHtmlCode( );

    /**
     * Get the list of captcha providers
     * 
     * @return The list of captcha providers
     */
    List<String> getCaptchaEngineNameList( );

    /**
     * Get the default captcha engine to use
     * 
     * @return The name of the default captcha engine
     */
    String getDefaultCaptchaEngineName( );

    /**
     * Set the default captcha engine to use
     * 
     * @param strDefaultCaptchaEngine
     *            the name of the default captcha engine to use
     */
    void setDefaultCaptchaEngineName( String strDefaultCaptchaEngine );
}