WriteKeyPanel (TrueZIP Driver ZIP.RAES (TZP) 7.2-rc-2 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - de.schlichtherle.truezip.swing.EnhancedPanel
        
        de.schlichtherle.truezip.crypto.raes.param.swing.KeyPanel
        
        de.schlichtherle.truezip.crypto.raes.param.swing.WriteKeyPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
```
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public class WriteKeyPanel
extends KeyPanel
```
This panel prompts the user for a key to create or overwrite a protected resource. It currently supports password and key file authentication.

Author:

Christian Schlichtherle

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JPanel
  javax.swing.JPanel.AccessibleJPanel
- Nested classes/interfaces inherited from class javax.swing.JComponent
  javax.swing.JComponent.AccessibleJComponent
- 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 and Description
`private AuthenticationPanel`	`authenticationPanel`
`private static java.lang.String`	`CLASS_NAME`
`private java.awt.Color`	`defaultForeground`
`private javax.swing.JLabel`	`error`
`private javax.swing.JComponent`	`extraDataUI`
`private static int`	`MIN_PASSWD_LEN` The minimum acceptable length of a password.
`private javax.swing.JPasswordField`	`newPasswd1Field`
`private javax.swing.JLabel`	`newPasswd1Label`
`private javax.swing.JPasswordField`	`newPasswd2Field`
`private javax.swing.JLabel`	`newPasswd2Label`
`private EnhancedPanel`	`passwdPanel`
`private javax.swing.JTextPane`	`resource`
`private static java.util.ResourceBundle`	`resources`
`private static long`	`serialVersionUID`

Fields inherited from class javax.swing.JComponent
accessibleContext, 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
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

WriteKeyPanel()
Constructs a new write key panel.

Constructors
Constructor and Description
`WriteKeyPanel()` Constructs a new write key panel.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`checkKeyFileKey(byte[] key)` Checks the entropy of the given key.
`protected void`	`checkPasswdKey(char[] key)` Checks the entropy of the given key.
`java.lang.String`	`getError()` Getter for property `error`.
`javax.swing.JComponent`	`getExtraDataUI()` Getter for property `extraDataUI`.
`java.net.URI`	`getResource()` Getter for property `resource`.
`private void`	`initComponents()` This method is called from within the constructor to initialize the form.
`private static java.lang.String`	`localizedMessage(java.util.ResourceBundle resources, java.lang.String key, java.lang.Object param)`
`private void`	`passwdPanelAncestorWindowShown(PanelEvent evt)`
`void`	`setError(java.lang.String error)` Setter for property error.
`void`	`setExtraDataUI(javax.swing.JComponent extraDataUI)` Setter for property `extraDataUI`.
`void`	`setResource(java.net.URI resource)` Setter for property `resource`.
`(package private) boolean`	`updateParam(AesCipherParameters param)`

Methods inherited from class de.schlichtherle.truezip.crypto.raes.param.swing.KeyPanel
getFeedback, setFeedback

Methods inherited from class de.schlichtherle.truezip.swing.EnhancedPanel
addPanelListener, coalesceEvents, getAncestorWindow, getPanelListeners, processEvent, processPanelEvent, removePanelListener

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, 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, 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, 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, hide, 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

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    Constant Field Values
  - CLASS_NAME
```
private static final java.lang.String CLASS_NAME
```
  - resources
```
private static final java.util.ResourceBundle resources
```
  - MIN_PASSWD_LEN
```
private static final int MIN_PASSWD_LEN
```
    The minimum acceptable length of a password.
    
    See Also:
    Constant Field Values
  - defaultForeground
```
private final java.awt.Color defaultForeground
```
  - extraDataUI
```
private javax.swing.JComponent extraDataUI
```
  - authenticationPanel
```
private AuthenticationPanel authenticationPanel
```
  - error
```
private javax.swing.JLabel error
```
  - newPasswd1Field
```
private javax.swing.JPasswordField newPasswd1Field
```
  - newPasswd1Label
```
private javax.swing.JLabel newPasswd1Label
```
  - newPasswd2Field
```
private javax.swing.JPasswordField newPasswd2Field
```
  - newPasswd2Label
```
private javax.swing.JLabel newPasswd2Label
```
  - passwdPanel
```
private EnhancedPanel passwdPanel
```
  - resource
```
private javax.swing.JTextPane resource
```
- Constructor Detail
  - WriteKeyPanel
```
public WriteKeyPanel()
```
    Constructs a new write key panel.
- Method Detail
  - getResource
```
public java.net.URI getResource()
```
    Description copied from class: KeyPanel
    
    Getter for property resource.
    
    Specified by:
    
    getResource in class KeyPanel
    
    Returns:
    Value of property resource.
  - setResource
```
public void setResource(java.net.URI resource)
```
    Description copied from class: KeyPanel
    
    Setter for property resource.
    
    Specified by:
    
    setResource in class KeyPanel
    
    Parameters:
    resource - New value of property resource.
  - getError
```
public java.lang.String getError()
```
    Description copied from class: KeyPanel
    
    Getter for property error.
    
    Specified by:
    
    getError in class KeyPanel
  - setError
```
public void setError(java.lang.String error)
```
    Description copied from class: KeyPanel
    
    Setter for property error.
    
    Specified by:
    
    setError in class KeyPanel
    
    Parameters:
    error - New value of property error.
  - updateParam
```
boolean updateParam(AesCipherParameters param)
```
    Specified by:
    
    updateParam in class KeyPanel
  - checkKeyFileKey
```
protected void checkKeyFileKey(byte[] key)
                        throws WeakKeyException
```
    Checks the entropy of the given key.
    
    Parameters:
    key - the key to check.
    
    Throws:
    
    WeakKeyException - if the entropy of the given key is too weak.
  - checkPasswdKey
```
protected void checkPasswdKey(char[] key)
                       throws WeakKeyException
```
    Checks the entropy of the given key.
    
    Parameters:
    key - the key to check.
    
    Throws:
    
    WeakKeyException - if the entropy of the given key is too weak.
  - localizedMessage
```
private static java.lang.String localizedMessage(java.util.ResourceBundle resources,
                                java.lang.String key,
                                @CheckForNull
                                java.lang.Object param)
```
  - getExtraDataUI
```
public javax.swing.JComponent getExtraDataUI()
```
    Getter for property extraDataUI.
    
    Returns:
    Value of property extraDataUI.
  - setExtraDataUI
```
public void setExtraDataUI(javax.swing.JComponent extraDataUI)
```
    Setter for property extraDataUI. This component is placed below the two password fields and above the error label. It may be used to prompt the user for additional data which may form part of the key or is separately stored in the key provider. The panel is automatically revalidated.
    
    Parameters:
    extraDataUI - New value of property extraDataUI.
  - initComponents
```
private void initComponents()
```
    This method is called from within the constructor to initialize the form. WARNING: Do NOT modify this code. The content of this method is always regenerated by the Form Editor.
  - passwdPanelAncestorWindowShown
```
private void passwdPanelAncestorWindowShown(PanelEvent evt)
```

Class WriteKeyPanel

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class de.schlichtherle.truezip.crypto.raes.param.swing.KeyPanel

Methods inherited from class de.schlichtherle.truezip.swing.EnhancedPanel

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

CLASS_NAME

resources

MIN_PASSWD_LEN

defaultForeground

extraDataUI

authenticationPanel

error

newPasswd1Field

newPasswd1Label

newPasswd2Field

newPasswd2Label

passwdPanel

resource

Constructor Detail

WriteKeyPanel

Method Detail

getResource

setResource

getError

setError

updateParam

checkKeyFileKey

checkPasswdKey

localizedMessage

getExtraDataUI

setExtraDataUI

initComponents

passwdPanelAncestorWindowShown