org.openstreetmap.josm.gui.oauth
Class OAuthAuthorizationWizard

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by javax.swing.JDialog
                      extended by org.openstreetmap.josm.gui.oauth.OAuthAuthorizationWizard
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class OAuthAuthorizationWizard
extends javax.swing.JDialog

This wizard walks the user to the necessary steps to retrieve an OAuth Access Token which allows JOSM to access the OSM API on the users behalf.

See Also:
Serialized Form

Nested Class Summary
(package private)  class OAuthAuthorizationWizard.AcceptAccessTokenAction
           
(package private)  class OAuthAuthorizationWizard.AuthorisationProcedureChangeListener
           
(package private)  class OAuthAuthorizationWizard.CancelAction
           
(package private) static class OAuthAuthorizationWizard.ExternalBrowserLauncher
           
(package private)  class OAuthAuthorizationWizard.WindowEventHandler
           
 
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
 
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
private  java.lang.String apiUrl
           
private  boolean canceled
           
private  AuthorizationProcedureComboBox cbAuthorisationProcedure
           
private  FullyAutomaticAuthorizationUI pnlFullyAutomaticAuthorisationUI
           
private  ManualAuthorizationUI pnlManualAuthorisationUI
           
private  HtmlPanel pnlMessage
           
private  SemiAutomaticAuthorizationUI pnlSemiAutomaticAuthorisationUI
           
private  javax.swing.JScrollPane spAuthorisationProcedureUI
           
 
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 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
OAuthAuthorizationWizard(java.awt.Component parent, java.lang.String apiUrl)
          Creates the wizard.
OAuthAuthorizationWizard(java.lang.String apiUrl)
          Creates the wizard.
 
Method Summary
protected  void build()
          builds the UI
protected  javax.swing.JPanel buildButtonRow()
          Builds the row with the action buttons
protected  javax.swing.JPanel buildHeaderInfoPanel()
          Builds the panel with general information in the header
 OAuthToken getAccessToken()
          Replies the Access Token entered using the wizard
protected  AbstractAuthorizationUI getCurrentAuthorisationUI()
           
 OAuthParameters getOAuthParameters()
          Replies the current OAuth parameters.
 void initFromPreferences()
          Initializes the dialog with values from the preferences
 boolean isCanceled()
          Replies true if the dialog was canceled
 boolean isSaveAccessTokenToPreferences()
          Replies true if the currently selected Access Token shall be saved to the preferences.
protected  void refreshAuthorisationProcedurePanel()
          Refreshes the view of the authorisation panel, depending on the authorisation procedure currently selected
protected  void setCanceled(boolean canceled)
           
 void setVisible(boolean visible)
           
 
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, setModal, setModalityType, setResizable, setTitle, setUndecorated, show, toBack
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, paint, 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, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, 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, isMaximumSizeSet, isMinimumSizeSet, isOpaque, 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, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, 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

pnlMessage

private HtmlPanel pnlMessage

canceled

private boolean canceled

apiUrl

private final java.lang.String apiUrl

cbAuthorisationProcedure

private AuthorizationProcedureComboBox cbAuthorisationProcedure

pnlFullyAutomaticAuthorisationUI

private FullyAutomaticAuthorizationUI pnlFullyAutomaticAuthorisationUI

pnlSemiAutomaticAuthorisationUI

private SemiAutomaticAuthorizationUI pnlSemiAutomaticAuthorisationUI

pnlManualAuthorisationUI

private ManualAuthorizationUI pnlManualAuthorisationUI

spAuthorisationProcedureUI

private javax.swing.JScrollPane spAuthorisationProcedureUI
Constructor Detail

OAuthAuthorizationWizard

public OAuthAuthorizationWizard(java.lang.String apiUrl)
                         throws java.lang.IllegalArgumentException
Creates the wizard.

Parameters:
apiUrl - the API URL. Must not be null.
Throws:
java.lang.IllegalArgumentException - thrown if apiUrl is null

OAuthAuthorizationWizard

public OAuthAuthorizationWizard(java.awt.Component parent,
                                java.lang.String apiUrl)
Creates the wizard.

Parameters:
parent - the component relative to which the dialog is displayed
apiUrl - the API URL. Must not be null.
Throws:
java.lang.IllegalArgumentException - thrown if apiUrl is null
Method Detail

buildButtonRow

protected javax.swing.JPanel buildButtonRow()
Builds the row with the action buttons

Returns:

buildHeaderInfoPanel

protected javax.swing.JPanel buildHeaderInfoPanel()
Builds the panel with general information in the header

Returns:

refreshAuthorisationProcedurePanel

protected void refreshAuthorisationProcedurePanel()
Refreshes the view of the authorisation panel, depending on the authorisation procedure currently selected


build

protected void build()
builds the UI


isCanceled

public boolean isCanceled()
Replies true if the dialog was canceled

Returns:
true if the dialog was canceled

getCurrentAuthorisationUI

protected AbstractAuthorizationUI getCurrentAuthorisationUI()

getAccessToken

public OAuthToken getAccessToken()
Replies the Access Token entered using the wizard

Returns:
the access token. May be null if the wizard was canceled.

getOAuthParameters

public OAuthParameters getOAuthParameters()
Replies the current OAuth parameters.

Returns:
the current OAuth parameters.

isSaveAccessTokenToPreferences

public boolean isSaveAccessTokenToPreferences()
Replies true if the currently selected Access Token shall be saved to the preferences.

Returns:
true if the currently selected Access Token shall be saved to the preferences

initFromPreferences

public void initFromPreferences()
Initializes the dialog with values from the preferences


setVisible

public void setVisible(boolean visible)
Overrides:
setVisible in class java.awt.Dialog

setCanceled

protected void setCanceled(boolean canceled)


JOSM