Package org.zaproxy.zap.extension.ascan

Class CustomScanDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

org.parosproxy.paros.extension.AbstractDialog

org.zaproxy.zap.view.StandardFieldsDialog

org.zaproxy.zap.extension.ascan.CustomScanDialog

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class CustomScanDialog
extends StandardFieldsDialog

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JDialog.AccessibleJDialog

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

java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String[]	STD_TAB_LABELS

Fields inherited from class org.parosproxy.paros.extension.AbstractDialog

thisDialog

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
CustomScanDialog(ExtensionActiveScan ext, java.lang.String[] tabLabels, java.util.List<CustomScanPanel> customPanels, java.awt.Frame owner, java.awt.Dimension dim)

Method Summary

Modifier and Type	Method	Description
void	enableUserDefinedRPC()	Force UserDefinedRPC setting
javax.swing.JButton[]	getExtraButtons()	Override if you need to add extra buttons inbetween the Cancel and Save ones
java.lang.String	getHelpIndex()
java.lang.String	getSaveButtonText()
void	init(Target target)
void	save()	Use the save method to launch a scan
void	setVisible(boolean show)
void	targetSelected(java.lang.String field, Target node)	Notifies that a target was selected.
java.lang.String	validateFields()	Called when the dialogue is saved, allowing to validate the fields and show an error message (as opposed to validations using the method StandardFieldsDialog.validateFieldsCustomMessage(), which allow to show custom/complex information or warning dialogues).

Methods inherited from class org.zaproxy.zap.view.StandardFieldsDialog

addCheckBoxField, addCheckBoxField, addComboField, addComboField, addComboField, addComboField, addComboField, addComboField, addComboField, addComboField, addComboField, addComboField, addComboField, addComboField, addComboField, addContextSelectField, addContextSelectField, addCustomComponent, addCustomComponent, addCustomComponent, addCustomComponent, addFieldListener, addFieldListener, addFileSelectField, addFileSelectField, addMultilineField, addMultilineField, addNodeSelectField, addNodeSelectField, addNumberField, addNumberField, addPadding, addPadding, addPasswordField, addPasswordField, addReadOnlyField, addReadOnlyField, addTableField, addTableField, addTableField, addTableField, addTableField, addTargetSelectField, addTargetSelectField, addTextField, addTextField, addTextFieldReadOnly, addTextFieldReadOnly, cancelPressed, createTabScrollable, getBoolValue, getCancelButtonText, getContextValue, getField, getIntValue, getPasswordValue, getStringValue, getTargetText, hasCancelSaveButtons, isEmptyField, isHideOnSave, isTabScrollable, removeAllFields, requestTabFocus, setComboBoxModel, setComboFields, setComboFields, setContextValue, setCustomTabPanel, setFieldMainPopupMenu, setFieldPopupMenu, setFieldValue, setFieldValue, setFieldValue, setHideOnSave, setTabScrollable, setTabsVisible, setXWeights, siteNodeSelected, validateFieldsCustomMessage

Methods inherited from class org.parosproxy.paros.extension.AbstractDialog

centreDialog

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

STD_TAB_LABELS

protected static final java.lang.String[] STD_TAB_LABELS

Constructor Detail

CustomScanDialog

public CustomScanDialog(ExtensionActiveScan ext,
                        java.lang.String[] tabLabels,
                        java.util.List<CustomScanPanel> customPanels,
                        java.awt.Frame owner,
                        java.awt.Dimension dim)

Method Detail

init

public void init(Target target)

getHelpIndex

public java.lang.String getHelpIndex()

Overrides:

getHelpIndex in class StandardFieldsDialog

targetSelected

public void targetSelected(java.lang.String field,
                           Target node)

Description copied from class: StandardFieldsDialog

Notifies that a target was selected.

By default it does nothing.

Overrides:

targetSelected in class StandardFieldsDialog

Parameters:

field - the name of the field that triggered the selection

node - the target selected

See Also:

StandardFieldsDialog.addTargetSelectField(int, String, Target, boolean, boolean)

getSaveButtonText

public java.lang.String getSaveButtonText()

Overrides:

getSaveButtonText in class StandardFieldsDialog

getExtraButtons

public javax.swing.JButton[] getExtraButtons()

Description copied from class: StandardFieldsDialog

Override if you need to add extra buttons inbetween the Cancel and Save ones

Overrides:

getExtraButtons in class StandardFieldsDialog

Returns:

an array with the extra buttons, or null if none needed.

save

public void save()

Use the save method to launch a scan

Specified by:

save in class StandardFieldsDialog

See Also:

StandardFieldsDialog.validateFields(), StandardFieldsDialog.validateFieldsCustomMessage(), StandardFieldsDialog.getSaveButtonText()

setVisible

public void setVisible(boolean show)

Overrides:

setVisible in class AbstractDialog

validateFields

public java.lang.String validateFields()

Description copied from class: StandardFieldsDialog

Called when the dialogue is saved, allowing to validate the fields and show an error message (as opposed to validations using the method StandardFieldsDialog.validateFieldsCustomMessage(), which allow to show custom/complex information or warning dialogues).

If no message is returned (that is, null), the saving process continues, otherwise it is shown a warning dialogue with the message.

Specified by:

validateFields in class StandardFieldsDialog

Returns:

a String containing the error message to be shown to the user, or null if there are no errors.

enableUserDefinedRPC

public void enableUserDefinedRPC()

Force UserDefinedRPC setting