org.zaproxy.zap.view

Class AbstractContextPropertiesPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.parosproxy.paros.view.AbstractParamPanel

org.zaproxy.zap.view.AbstractContextPropertiesPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

ContextAuthenticationPanel, ContextAuthorizationPanel, ContextExcludePanel, ContextForcedUserPanel, ContextGeneralPanel, ContextIncludePanel, ContextSessionManagementPanel, ContextStructurePanel, ContextTechnologyPanel, ContextUsersPanel

public abstract class AbstractContextPropertiesPanel
extends AbstractParamPanel

The abstract class that should be extended by panels that are shown in the "Session Properties" dialog, for each of the Contexts.

The UI shared context is a duplicate of the Context to which the panel corresponds and should be used to load any data in the UI and store any changes done in the UI until permanent saving. This Context is shared between all the Context Properties Panels so any change in one of the panels can be reflected in other panels, if needed. It can be obtained through calls to getUISharedContext().

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
AbstractContextPropertiesPanel(int contextId) Instantiates a new abstract context properties panel.

Method Summary

Modifier and Type	Method and Description
int	getContextIndex() Gets the index of the context to which this panel corresponds.
protected Context	getUISharedContext() Gets the UI shared context.
abstract void	initContextData(Session session, Context uiSharedContext) Inits the data shown on the panel.
void	initParam(Object obj) Initialises the panel with the given data.
void	onHide() Called when the panel is hidden (another panel becomes visible) in the containing AbstractParamDialog.
abstract void	saveContextData(Session session) Saves and permanently persists the changes done in the UI.
void	saveParam(Object obj) Saves (the data of) the panel, throwing an exception if there's any error.
abstract void	saveTemporaryContextData(Context uiSharedContext) Saves the changes done in the UI into the UI Shared Context, so it is available when other context panels require it.
void	setSessionDialog(SessionDialog sessionDialog) Sets the session dialog to which this panel corresponds.
abstract void	validateContextData(Session session) Validate the context data shown in the UI.
void	validateParam(Object obj) Validates the panel, throwing an exception if there's any validation error.

Methods inherited from class org.parosproxy.paros.view.AbstractParamPanel

getHelpIndex, onShow, reset

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

AbstractContextPropertiesPanel

public AbstractContextPropertiesPanel(int contextId)

Instantiates a new abstract context properties panel.

Parameters:

contextId - the context id

Method Detail

setSessionDialog

public void setSessionDialog(SessionDialog sessionDialog)

Sets the session dialog to which this panel corresponds.

Parameters:

sessionDialog - the new session dialog

getUISharedContext

protected Context getUISharedContext()

Gets the UI shared context. The UI shared context is a duplicate of the Context to which the panel corresponds and should be used to load any data in the UI and store any changes done in the UI until permanent saving. This Context is shared between all the Context Properties Panels so any change in one of the panels can be reflected in other panels, if needed.

Returns:

the UI shared context

initParam

public void initParam(Object obj)

Description copied from class: AbstractParamPanel

Initialises the panel with the given data.

Specified by:

initParam in class AbstractParamPanel

Parameters:

obj - the object used to initialise the panel and save the data

validateParam

public void validateParam(Object obj)
                   throws Exception

Description copied from class: AbstractParamPanel

Validates the panel, throwing an exception if there's any validation error.

The message of the exception is expected to be internationalised (as it might be shown in GUI components, for example, an error dialogue).

Does nothing by default.

Overrides:

validateParam in class AbstractParamPanel

Parameters:

obj - the object used to initialise the panel and save the data

Throws:

Exception - if there's any validation error.

saveParam

public void saveParam(Object obj)
               throws Exception

Description copied from class: AbstractParamPanel

Saves (the data of) the panel, throwing an exception if there's any error.

The message of the exception is expected to be internationalised (as it might be shown in GUI components, for example, an error dialogue).

Specified by:

saveParam in class AbstractParamPanel

Parameters:

obj - the object used to initialise the panel and save the data

Throws:

Exception - if there's any error while saving the data.

initContextData

public abstract void initContextData(Session session,
                                     Context uiSharedContext)

Inits the data shown on the panel. This method is the equivalent of AbstractParamPanel.initParam(Object).

The uiSharedContext parameter provided is a duplicate of the Context to which the panel corresponds and should be used to load any data in the UI and store any changes done in the UI until saving. This Context is shared between all the Context Properties Panels so any change in one of the panels can be reflected in other panels, if needed. It can also be obtained through calls to getUISharedContext()

Parameters:

session - the session

uiSharedContext - the Context shared between the Context Properties Panels

validateContextData

public abstract void validateContextData(Session session)
                                  throws Exception

Validate the context data shown in the UI. This method is the equivalent of AbstractParamPanel.validateParam(Object).

The message of the exception is expected to be internationalised (as it might be shown in GUI components, for example, an error dialogue).

Parameters:

session - the session

Throws:

Exception - if there's any validation error.

saveTemporaryContextData

public abstract void saveTemporaryContextData(Context uiSharedContext)

Saves the changes done in the UI into the UI Shared Context, so it is available when other context panels require it. Usually, this method is called when the panel is hidden ( onHide()).

The @{code uiSharedContext} parameter provided is a duplicate of the Context to which the panel corresponds and should be used to load any data in the UI and store any changes done in the UI until saving. This Context is shared between all the Context Properties Panels so any change in one of the panels can be reflected in other panels, if needed.

Parameters:

uiSharedContext - the ui shared context

saveContextData

public abstract void saveContextData(Session session)
                              throws Exception

Saves and permanently persists the changes done in the UI. This method is the equivalent of AbstractParamPanel.saveParam(Object).

Parameters:

session - the session

Throws:

Exception - if there's any error while saving the data.

getContextIndex

public int getContextIndex()

Gets the index of the context to which this panel corresponds.

Returns:

the context index

onHide

public void onHide()

Description copied from class: AbstractParamPanel

Called when the panel is hidden (another panel becomes visible) in the containing AbstractParamDialog.

Overrides:

onHide in class AbstractParamPanel