org.zaproxy.zap.authentication.AbstractAuthenticationMethodOptionsPanel Maven / Gradle / Ivy

Go to download

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

The Zed Attack Proxy (ZAP) is an easy to use integrated penetration testing tool for finding vulnerabilities in web applications. It is designed to be used by people with a wide range of security experience and as such is ideal for developers and functional testers who are new to penetration testing. ZAP provides automated scanners as well as a set of tools that allow you to find security vulnerabilities manually.

The newest version!

/*
 * Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2013 The ZAP Development Team
 *
 * 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.authentication;

import javax.swing.JPanel;
import org.zaproxy.zap.authentication.AuthenticationMethodType.UnsupportedAuthenticationMethodException;

/**
 * An Options Panel that is used to configure all the settings corresponding to an {@link
 * AuthenticationMethod}.
 *
 * This panel will be displayed to users as part of the Authentication panel in the Session
 * Properties.
 */
public abstract class AbstractAuthenticationMethodOptionsPanel extends JPanel {

    /** The Constant serialVersionUID. */
    private static final long serialVersionUID = 9003182467823059637L;

    /**
     * Validate the fields of the configuration panel. If any of the fields are not in the proper
     * state, an {@link IllegalStateException} is thrown, containing a message describing the
     * problem.
     *
     * @throws IllegalStateException if any of the fields are not in the valid state
     */
    public abstract void validateFields() throws IllegalStateException;

    /**
     * Save the changes from the panel in the authentication method. After this method call, calls
     * to {@link AbstractAuthenticationMethodOptionsPanel#getMethod()} should return the {@link
     * AuthenticationMethod} with the saved changes.
     */
    public abstract void saveMethod();

    /**
     * Binds (loads) data from an existing Authentication method in the panel. After this method, to
     * {@link #getMethod()} should return the same object, eventually with some changes (if {@link
     * #saveMethod()} was called).
     *
     * @param method the method to be loaded/shown in the panel.
     * @throws UnsupportedAuthenticationMethodException if the {@code method} being bond is not
     *     supported
     */
    public abstract void bindMethod(AuthenticationMethod method)
            throws UnsupportedAuthenticationMethodException;

    /**
     * Binds (loads) data from an existing Authentication method in the panel. After this method, to
     * {@link #getMethod()} should return the same object, eventually with some changes (if {@link
     * #saveMethod()} was called).
     *
     * @param method the method to be loaded/shown in the panel.
     * @param indicatorsPanel the interface to manipulate the fields of the logged in/out indicators
     * @throws UnsupportedAuthenticationMethodException if the {@code method} being bond is not
     *     supported
     * @since 2.5.0
     */
    public void bindMethod(
            AuthenticationMethod method, AuthenticationIndicatorsPanel indicatorsPanel)
            throws UnsupportedAuthenticationMethodException {
        bindMethod(method);
    }

    /**
     * Gets the corresponding authentication method configured by this panel.
     *
     * @return the method
     */
    public abstract AuthenticationMethod getMethod();
}