com.ca.directory.jxplorer
Class LdifExport

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--com.ca.commons.cbutil.CBDialog
                                      |
                                      +--com.ca.directory.jxplorer.LdifExport

All Implemented Interfaces:

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

public class LdifExport

extends CBDialog

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Nested classes inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

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

Field Summary

Fields inherited from class com.ca.commons.cbutil.CBDialog

buttonPanel, Cancel, display, Help, OK, owner

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

LdifExport(DN D, DataSource broker, SmartTree searchTree, boolean usingSearch, java.awt.Frame owner)
Constructor for the LdifExport window.

Method Summary

protected java.io.File	adjustFileName(java.io.File readFile) A quick spot of mucking around to add '.ldif' to naked files.
protected void	doFileWrite(java.io.File saveFile) Launch a DataQuery that will write the ldif file.
void	doOK() This method is called by the base class when the OK button is pressed.
void	saveLdifList(java.util.Vector dns, java.io.FileWriter saveFile, java.lang.String originalPrefix, java.lang.String replacementPrefix, Broker broker) Writes a list of entries to an ldif file.
boolean	saveLdifTree(DN treeApex, java.io.FileWriter saveFile, java.lang.String origPrefix, java.lang.String newPrefix, Broker broker) Write a subtree to an ldif file by recursing through the tree, calling saveLdifEntry as it goes...

Methods inherited from class com.ca.commons.cbutil.CBDialog

add, addln, doCancel, escKeyCheck, getDisplayPanel, makeHeavy, makeLight, makeWide, quit, setHelpLink, wasCancelled

Methods inherited from class javax.swing.JDialog

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

Methods inherited from class java.awt.Dialog

addNotify, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

LdifExport

public LdifExport(DN D,
                  DataSource broker,
                  SmartTree searchTree,
                  boolean usingSearch,
                  java.awt.Frame owner)

Constructor for the LdifExport window. Takes a DN, and a jndi broker. If it is exporting from a search result set, it takes the search tree as a parameter, and a boolean flag specifying that the tree should be used to list the DNs to be exported; otherwise it does a full dump from the provided DN.

The constructor sets up the GUI, defining buttons and fields and registering button listeners.

Parameters:

D - the base DN to work from

broker - the jndi broker to use to read entry attribtues from, and to physically write the ldif file

searchTree - (possibly) a tree containing a list of search results, to be used if the search flag is set

usingSearch - a boolean flag that forces the reading of the list of DNs to save from the tree, rather than directly from the directory...

Method Detail

adjustFileName

protected java.io.File adjustFileName(java.io.File readFile)

A quick spot of mucking around to add '.ldif' to naked files.

doOK

public void doOK()

This method is called by the base class when the OK button is pressed. Handles actually writing the ldif file (relying heavily on LdifUtility for the grunt work). Does the actual file writing in a separate thread.

Overrides:

doOK in class CBDialog

doFileWrite

protected void doFileWrite(java.io.File saveFile)

Launch a DataQuery that will write the ldif file.

saveLdifTree

public boolean saveLdifTree(DN treeApex,
                            java.io.FileWriter saveFile,
                            java.lang.String origPrefix,
                            java.lang.String newPrefix,
                            Broker broker)

Write a subtree to an ldif file by recursing through the tree, calling saveLdifEntry as it goes...

Parameters:

treeApex - the root node of the sub tree to be written out.

origPrefix - the original DN prefix, that may be modified on write to be replacementPrefix. This may be null if no action is to be taken.

newPrefix - another DN to replace the originalPrefix.

Returns:

number of entries written

saveLdifList

public void saveLdifList(java.util.Vector dns,
                         java.io.FileWriter saveFile,
                         java.lang.String originalPrefix,
                         java.lang.String replacementPrefix,
                         Broker broker)

Writes a list of entries to an ldif file.

Parameters:

originalPrefix - the original DN prefix, that may be modified on write to be replacementPrefix. This may be null if no action is to be taken.

replacementPrefix - another DN to replace the originalPrefix.