org.zaproxy.zap.authentication

Class ScriptBasedAuthenticationMethodType.ScriptBasedAuthenticationMethodOptionsPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.zaproxy.zap.authentication.AbstractAuthenticationMethodOptionsPanel

org.zaproxy.zap.authentication.ScriptBasedAuthenticationMethodType.ScriptBasedAuthenticationMethodOptionsPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Enclosing class:

ScriptBasedAuthenticationMethodType

public class ScriptBasedAuthenticationMethodType.ScriptBasedAuthenticationMethodOptionsPanel
extends AbstractAuthenticationMethodOptionsPanel

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
ScriptBasedAuthenticationMethodOptionsPanel()

Method Summary

Modifier and Type	Method and Description
void	bindMethod(AuthenticationMethod method) Binds (loads) data from an existing Authentication method in the panel.
void	bindMethod(AuthenticationMethod method, AuthenticationIndicatorsPanel indicatorsPanel) Binds (loads) data from an existing Authentication method in the panel.
AuthenticationMethod	getMethod() Gets the corresponding authentication method configured by this panel.
void	saveMethod() Save the changes from the panel in the authentication method.
void	validateFields() Validate the fields of the configuration panel.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ScriptBasedAuthenticationMethodOptionsPanel

public ScriptBasedAuthenticationMethodOptionsPanel()

Method Detail

validateFields

public void validateFields()
                    throws IllegalStateException

Description copied from class: AbstractAuthenticationMethodOptionsPanel

Validate the fields of the configuration panel. If any of the fields are not in the proper state, an IllegalStateException is thrown, containing a message describing the problem.

Specified by:

validateFields in class AbstractAuthenticationMethodOptionsPanel

Throws:

IllegalStateException - if any of the fields are not in the valid state

saveMethod

public void saveMethod()

Description copied from class: AbstractAuthenticationMethodOptionsPanel

Save the changes from the panel in the authentication method. After this method call, calls to AbstractAuthenticationMethodOptionsPanel.getMethod() should return the AuthenticationMethod with the saved changes.

Specified by:

saveMethod in class AbstractAuthenticationMethodOptionsPanel

bindMethod

public void bindMethod(AuthenticationMethod method)
                throws AuthenticationMethodType.UnsupportedAuthenticationMethodException

Description copied from class: AbstractAuthenticationMethodOptionsPanel

Binds (loads) data from an existing Authentication method in the panel. After this method, to AbstractAuthenticationMethodOptionsPanel.getMethod() should return the same object, eventually with some changes (if AbstractAuthenticationMethodOptionsPanel.saveMethod() was called).

Specified by:

bindMethod in class AbstractAuthenticationMethodOptionsPanel

Parameters:

method - the method to be loaded/shown in the panel.

Throws:

AuthenticationMethodType.UnsupportedAuthenticationMethodException - if the method being bond is not supported

bindMethod

public void bindMethod(AuthenticationMethod method,
                       AuthenticationIndicatorsPanel indicatorsPanel)
                throws AuthenticationMethodType.UnsupportedAuthenticationMethodException

Description copied from class: AbstractAuthenticationMethodOptionsPanel

Binds (loads) data from an existing Authentication method in the panel. After this method, to AbstractAuthenticationMethodOptionsPanel.getMethod() should return the same object, eventually with some changes (if AbstractAuthenticationMethodOptionsPanel.saveMethod() was called).

Overrides:

bindMethod in class AbstractAuthenticationMethodOptionsPanel

Parameters:

method - the method to be loaded/shown in the panel.

indicatorsPanel - the interface to manipulate the fields of the logged in/out indicators

Throws:

AuthenticationMethodType.UnsupportedAuthenticationMethodException - if the method being bond is not supported

getMethod

public AuthenticationMethod getMethod()

Description copied from class: AbstractAuthenticationMethodOptionsPanel

Gets the corresponding authentication method configured by this panel.

Specified by:

getMethod in class AbstractAuthenticationMethodOptionsPanel

Returns:

the method