Uploader

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - java.awt.Panel
    - - java.applet.Applet
      - javax.swing.JApplet
        
        org.jets3t.apps.uploader.Uploader

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ListSelectionListener, javax.swing.RootPaneContainer, org.apache.http.client.CredentialsProvider, HyperlinkActivatedListener, S3ServiceEventListener
```
public class Uploader
extends javax.swing.JApplet
implements S3ServiceEventListener, java.awt.event.ActionListener, javax.swing.event.ListSelectionListener, HyperlinkActivatedListener, org.apache.http.client.CredentialsProvider
```
Dual application and applet for uploading files and XML metadata information to the Amazon S3 service.
For more information and help please see the Uploader Guide.

The Uploader is highly configurable through properties specified in a file uploader.properties. This file must be available at the root of the classpath.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JApplet
  javax.swing.JApplet.AccessibleJApplet
- Nested classes/interfaces inherited from class java.applet.Applet
  java.applet.Applet.AccessibleApplet
- Nested classes/interfaces inherited from class java.awt.Panel
  java.awt.Panel.AccessibleAWTPanel
- 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 javax.swing.JPanel`	`appContentPanel`
`static java.lang.String`	`APPLICATION_DESCRIPTION`
`private javax.swing.JButton`	`backButton`
`private javax.swing.JPanel`	`buttonsPanel`
`private java.awt.CardLayout`	`buttonsPanelCardLayout`
`private ByteFormatter`	`byteFormatter`
`private javax.swing.JButton`	`cancelUploadButton`
`private int`	`currentState`
`private JHtmlLabel`	`dragDropTargetLabel`
`static java.lang.String`	`ERROR_CODE__MISSING_REQUIRED_PARAM`
`static java.lang.String`	`ERROR_CODE__S3_UPLOAD_FAILED`
`static java.lang.String`	`ERROR_CODE__TRANSACTION_ID_REQUIRED_TO_CREATE_XML_SUMMARY`
`static java.lang.String`	`ERROR_CODE__UPLOAD_REQUEST_DECLINED`
`private boolean`	`fatalErrorOccurred` Set to true if an upload failed due to a key name clash in S3, in which case an error message is displayed in the final 'thankyou' screen.
`private JHtmlLabel`	`fileInformationLabel`
`private int`	`fileMaxCount`
`private long`	`fileMaxSizeMB`
`private long`	`fileMinSizeMB`
`private java.io.File[]`	`filesToUpload` The files to upload to S3.
`private JHtmlLabel`	`fileToUploadLabel`
`private JHtmlLabel`	`finalMessageLabel`
`private java.awt.GridBagLayout`	`GRID_BAG_LAYOUT`
`private GuiUtils`	`guiUtils`
`static int`	`HTTP_CONNECTION_TIMEOUT`
`private org.apache.http.client.HttpClient`	`httpClientGatekeeper`
`private boolean`	`includeXmlSummaryDoc` If set to true via the "xmlSummary" configuration property, the Uploader will generate an XML summary document describing the files uploaded by the user and will upload this summary document to S3.
`private java.awt.Insets`	`insetsDefault`
`private java.awt.Insets`	`insetsNone`
`private boolean`	`isRunningAsApplet`
`private static org.apache.commons.logging.Log`	`log`
`static int`	`MAX_CONNECTION_RETRIES`
`private org.apache.http.client.CredentialsProvider`	`mCredentialProvider`
`private javax.swing.JButton`	`nextButton`
`private java.awt.Frame`	`ownerFrame`
`private java.util.HashMap`	`parametersMap`
`private javax.swing.JPanel`	`primaryPanel`
`private java.awt.CardLayout`	`primaryPanelCardLayout`
`private java.lang.Exception`	`priorFailureException` Variable to store application exceptions, so that client failure information can be included in the information provided to the Gatekeeper when uploads are retried.
`private javax.swing.JProgressBar`	`progressBar`
`private JHtmlLabel`	`progressStatusTextLabel`
`private JHtmlLabel`	`progressTransferDetailsLabel`
`private S3ServiceMulti`	`s3ServiceMulti`
`private static long`	`serialVersionUID`
`private SkinsFactory`	`skinsFactory`
`static int`	`SOCKET_CONNECTION_TIMEOUT`
`private java.util.Properties`	`standAloneArgumentProperties` Properties set in stand-alone application from the command line arguments.
`private TimeFormatter`	`timeFormatter`
`private CancelEventTrigger`	`uploadCancelEventTrigger`
`private boolean`	`uploadCancelled` Set to true when a file upload has been cancelled, to prevent the Uploader from uploading an XML summary file when the prior file upload was cancelled.
`static java.lang.String`	`UPLOADER_PROPERTIES_FILENAME`
`private static java.lang.String`	`UPLOADER_VERSION_ID`
`private Jets3tProperties`	`uploaderProperties` Uploader's properties.
`private boolean`	`uploadingFinalObject` Set to true when the object/file being uploaded is the final in a set, eg when the XML metadata is being uploaded after a movie file.
`private JHtmlLabel`	`userGuidanceLabel`
`private UserInputFields`	`userInputFields`
`private java.util.Properties`	`userInputProperties`
`private java.util.ArrayList`	`validFileExtensions` The list of file extensions accepted by the Uploader.
`static int`	`WIZARD_SCREEN_1`
`static int`	`WIZARD_SCREEN_2`
`static int`	`WIZARD_SCREEN_3`
`static int`	`WIZARD_SCREEN_4`
`static int`	`WIZARD_SCREEN_5`

Fields inherited from class javax.swing.JApplet
accessibleContext, rootPane, rootPaneCheckingEnabled

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
Modifier	Constructor and Description
	`Uploader()` Constructor to run this application as an Applet.
`private`	`Uploader(boolean pIsRunningApplet)`
	`Uploader(javax.swing.JFrame ownerFrame, java.util.Properties standAloneArgumentProperties)` Constructor to run this application in a stand-alone window.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(java.awt.event.ActionEvent actionEvent)` Handles GUI actions.
`private GatekeeperMessage`	`buildGatekeeperResponse(S3Object[] objects)` Builds a Gatekeeper response based on AWS credential information available in the Uploader properties.
`private boolean`	`checkProposedUploadFiles(java.util.List fileList)` Checks that all the files in a list are acceptable for uploading.
`void`	`clear()` Clear credentials.
`private void`	`configureButton(javax.swing.JButton button, java.lang.String propertiesPrefix)` Configures a button's text, tooltip and image using uploader properties prefixed with the given properties prefix.
`private GatekeeperMessage`	`contactGatewayServer(S3Object[] objects)` Retrieves a signed PUT URL from the given URL address.
`private void`	`drawWizardScreen(int nextState)` Draws the wizard screen appropriate to the stage in the wizard process the user has reached.
`private void`	`failWithFatalError(java.lang.String errorCode)` When a fatal error occurs, go straight to last screen to display the error message and make the error code available as a variable (`${errorCode}`) to be used in the error message displayed to the user.
`void`	`followHyperlink(java.net.URL url, java.lang.String target)` Follows hyperlinks clicked on by a user.
`org.apache.http.auth.Credentials`	`getCredentials(org.apache.http.auth.AuthScope scope)` Implementation method for the CredentialsProvider interface.
`void`	`init()` Prepares application to run as a GUI by finding/creating a root owner JFrame, and (if necessary) creating a directory for storing remembered logins.
`private void`	`initDropTarget(java.awt.Component[] dropTargetComponents)` Initialise the application's File drop targets for drag and drop copying of local files to S3.
`private void`	`initGui()` Initialises the application's GUI elements.
`private org.apache.http.client.HttpClient`	`initHttpConnection()`
`static void`	`main(java.lang.String[] args)` Run the Uploader as a stand-alone application.
`private SignedUrlAndObject[]`	`prepareSignedObjects(S3Object[] objects, SignatureRequest[] signatureRequests, XmlGenerator xmlGenerator)`
`private java.lang.String`	`replaceMessageVariables(java.lang.String message)` Replaces variables of the form ${variableName} in the input string with the value of that variable name in the local uploaderProperties properties object, or with one of the following special variables: fileName : Name of file being uploaded fileSize : Size of the file being uploaded, eg 1.04 MB filePath : Absolute path of the file being uploaded maxFileSize : The maxiumum allowed file size in MB maxFileCount : The maximum number of files that may be uploaded validFileExtensions : A list of the file extensions allowed If the variable named in the input string is not available, or has no value, the variable reference is left in the result.
`private GatekeeperMessage`	`retrieveGatekeeperResponse(S3Object[] objects)`
`void`	`s3ServiceEventPerformed(CopyObjectsEvent event)`
`void`	`s3ServiceEventPerformed(CreateBucketsEvent event)`
`void`	`s3ServiceEventPerformed(CreateObjectsEvent event)` Listener method that responds to events from the jets3t toolkit when objects are created in S3 - ie when files are uploaded.
`void`	`s3ServiceEventPerformed(DeleteObjectsEvent event)`
`void`	`s3ServiceEventPerformed(DeleteVersionedObjectsEvent event)`
`void`	`s3ServiceEventPerformed(DownloadObjectsEvent event)`
`void`	`s3ServiceEventPerformed(GetObjectHeadsEvent event)`
`void`	`s3ServiceEventPerformed(GetObjectsEvent event)`
`void`	`s3ServiceEventPerformed(ListObjectsEvent event)`
`void`	`s3ServiceEventPerformed(LookupACLEvent event)`
`void`	`s3ServiceEventPerformed(UpdateACLEvent event)`
`void`	`setCredentials(org.apache.http.auth.AuthScope authscope, org.apache.http.auth.Credentials credentials)`
`private void`	`uploadFilesToS3()` Uploads to S3 the file referenced by the variable fileToUpload, providing progress feedback to the user all the while.
`void`	`valueChanged(javax.swing.event.ListSelectionEvent arg0)`
`private void`	`wizardStepBackward()` Move the wizard backward one step/screen.
`private void`	`wizardStepForward()` Move the wizard forward one step/screen.

Methods inherited from class javax.swing.JApplet
addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isRootPaneCheckingEnabled, paramString, remove, repaint, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.applet.Applet
destroy, getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, isValidateRoot, newAudioClip, play, play, resize, resize, setStub, showStatus, start, stop

Methods inherited from class java.awt.Panel
addNotify

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, 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, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, 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, reshape, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, 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
  - log
```
private static final org.apache.commons.logging.Log log
```
  - APPLICATION_DESCRIPTION
```
public static final java.lang.String APPLICATION_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - UPLOADER_PROPERTIES_FILENAME
```
public static final java.lang.String UPLOADER_PROPERTIES_FILENAME
```
    See Also:
    
    Constant Field Values
  - UPLOADER_VERSION_ID
```
private static final java.lang.String UPLOADER_VERSION_ID
```
    See Also:
    
    Constant Field Values
  - WIZARD_SCREEN_1
```
public static final int WIZARD_SCREEN_1
```
    See Also:
    
    Constant Field Values
  - WIZARD_SCREEN_2
```
public static final int WIZARD_SCREEN_2
```
    See Also:
    
    Constant Field Values
  - WIZARD_SCREEN_3
```
public static final int WIZARD_SCREEN_3
```
    See Also:
    
    Constant Field Values
  - WIZARD_SCREEN_4
```
public static final int WIZARD_SCREEN_4
```
    See Also:
    
    Constant Field Values
  - WIZARD_SCREEN_5
```
public static final int WIZARD_SCREEN_5
```
    See Also:
    
    Constant Field Values
  - ERROR_CODE__MISSING_REQUIRED_PARAM
```
public static final java.lang.String ERROR_CODE__MISSING_REQUIRED_PARAM
```
    See Also:
    
    Constant Field Values
  - ERROR_CODE__S3_UPLOAD_FAILED
```
public static final java.lang.String ERROR_CODE__S3_UPLOAD_FAILED
```
    See Also:
    
    Constant Field Values
  - ERROR_CODE__UPLOAD_REQUEST_DECLINED
```
public static final java.lang.String ERROR_CODE__UPLOAD_REQUEST_DECLINED
```
    See Also:
    
    Constant Field Values
  - ERROR_CODE__TRANSACTION_ID_REQUIRED_TO_CREATE_XML_SUMMARY
```
public static final java.lang.String ERROR_CODE__TRANSACTION_ID_REQUIRED_TO_CREATE_XML_SUMMARY
```
    See Also:
    
    Constant Field Values
  - HTTP_CONNECTION_TIMEOUT
```
public static final int HTTP_CONNECTION_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - SOCKET_CONNECTION_TIMEOUT
```
public static final int SOCKET_CONNECTION_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - MAX_CONNECTION_RETRIES
```
public static final int MAX_CONNECTION_RETRIES
```
    See Also:
    
    Constant Field Values
  - ownerFrame
```
private java.awt.Frame ownerFrame
```
  - userInputFields
```
private UserInputFields userInputFields
```
  - userInputProperties
```
private java.util.Properties userInputProperties
```
  - httpClientGatekeeper
```
private org.apache.http.client.HttpClient httpClientGatekeeper
```
  - s3ServiceMulti
```
private S3ServiceMulti s3ServiceMulti
```
  - filesToUpload
```
private java.io.File[] filesToUpload
```
    The files to upload to S3.
  - validFileExtensions
```
private java.util.ArrayList validFileExtensions
```
    The list of file extensions accepted by the Uploader.
  - uploaderProperties
```
private Jets3tProperties uploaderProperties
```
    Uploader's properties.
  - standAloneArgumentProperties
```
private java.util.Properties standAloneArgumentProperties
```
    Properties set in stand-alone application from the command line arguments.
  - byteFormatter
```
private final ByteFormatter byteFormatter
```
  - timeFormatter
```
private final TimeFormatter timeFormatter
```
  - fileMaxCount
```
private int fileMaxCount
```
  - fileMaxSizeMB
```
private long fileMaxSizeMB
```
  - fileMinSizeMB
```
private long fileMinSizeMB
```
  - insetsDefault
```
private final java.awt.Insets insetsDefault
```
  - insetsNone
```
private final java.awt.Insets insetsNone
```
  - guiUtils
```
private final GuiUtils guiUtils
```
  - currentState
```
private int currentState
```
  - isRunningAsApplet
```
private final boolean isRunningAsApplet
```
  - parametersMap
```
private java.util.HashMap parametersMap
```
  - skinsFactory
```
private SkinsFactory skinsFactory
```
  - GRID_BAG_LAYOUT
```
private final java.awt.GridBagLayout GRID_BAG_LAYOUT
```
  - userGuidanceLabel
```
private JHtmlLabel userGuidanceLabel
```
  - appContentPanel
```
private javax.swing.JPanel appContentPanel
```
  - buttonsPanel
```
private javax.swing.JPanel buttonsPanel
```
  - primaryPanel
```
private javax.swing.JPanel primaryPanel
```
  - primaryPanelCardLayout
```
private java.awt.CardLayout primaryPanelCardLayout
```
  - buttonsPanelCardLayout
```
private java.awt.CardLayout buttonsPanelCardLayout
```
  - backButton
```
private javax.swing.JButton backButton
```
  - nextButton
```
private javax.swing.JButton nextButton
```
  - cancelUploadButton
```
private javax.swing.JButton cancelUploadButton
```
  - dragDropTargetLabel
```
private JHtmlLabel dragDropTargetLabel
```
  - fileToUploadLabel
```
private JHtmlLabel fileToUploadLabel
```
  - fileInformationLabel
```
private JHtmlLabel fileInformationLabel
```
  - progressTransferDetailsLabel
```
private JHtmlLabel progressTransferDetailsLabel
```
  - progressBar
```
private javax.swing.JProgressBar progressBar
```
  - progressStatusTextLabel
```
private JHtmlLabel progressStatusTextLabel
```
  - finalMessageLabel
```
private JHtmlLabel finalMessageLabel
```
  - uploadCancelEventTrigger
```
private CancelEventTrigger uploadCancelEventTrigger
```
  - uploadingFinalObject
```
private volatile boolean uploadingFinalObject
```
    Set to true when the object/file being uploaded is the final in a set, eg when the XML metadata is being uploaded after a movie file.
  - includeXmlSummaryDoc
```
private volatile boolean includeXmlSummaryDoc
```
    If set to true via the "xmlSummary" configuration property, the Uploader will generate an XML summary document describing the files uploaded by the user and will upload this summary document to S3.
  - uploadCancelled
```
private volatile boolean uploadCancelled
```
    Set to true when a file upload has been cancelled, to prevent the Uploader from uploading an XML summary file when the prior file upload was cancelled.
  - fatalErrorOccurred
```
private boolean fatalErrorOccurred
```
    Set to true if an upload failed due to a key name clash in S3, in which case an error message is displayed in the final 'thankyou' screen.
  - priorFailureException
```
private java.lang.Exception priorFailureException
```
    Variable to store application exceptions, so that client failure information can be included in the information provided to the Gatekeeper when uploads are retried.
  - mCredentialProvider
```
private final org.apache.http.client.CredentialsProvider mCredentialProvider
```
- Constructor Detail
  - Uploader
```
private Uploader(boolean pIsRunningApplet)
```
  - Uploader
```
public Uploader()
```
    Constructor to run this application as an Applet.
  - Uploader
```
public Uploader(javax.swing.JFrame ownerFrame,
                java.util.Properties standAloneArgumentProperties)
         throws S3ServiceException
```
    Constructor to run this application in a stand-alone window.
    
    Parameters:
    
    ownerFrame - the frame the application will be displayed in
    
    Throws:
    
    S3ServiceException
- Method Detail
  - init
```
public void init()
```
    Prepares application to run as a GUI by finding/creating a root owner JFrame, and (if necessary) creating a directory for storing remembered logins.
    
    Overrides:
    
    init in class java.applet.Applet
  - initGui
```
private void initGui()
```
    Initialises the application's GUI elements.
  - initDropTarget
```
private void initDropTarget(java.awt.Component[] dropTargetComponents)
```
    Initialise the application's File drop targets for drag and drop copying of local files to S3.
    
    Parameters:
    
    dropTargetComponents - the components files can be dropped on to transfer them to S3
  - checkProposedUploadFiles
```
private boolean checkProposedUploadFiles(java.util.List fileList)
```
    Checks that all the files in a list are acceptable for uploading. Files are checked against the following criteria:
    - There are not too many
    - The size is greater than the minimum size, and less that the maximum size.
    - The file has a file extension matching one of those explicitly allowed
    Any deviations from the rules result in an error message, and the method returns false. A side-effect of this method is that the wizard is moved forward one screen if the files are all valid.
    Parameters:
    
    fileList - A list of Files to check.
    
    Returns:
    
    true if the files in the list are all acceptable, false otherwise.
  - buildGatekeeperResponse
```
private GatekeeperMessage buildGatekeeperResponse(S3Object[] objects)
                                           throws java.lang.Exception
```
    Builds a Gatekeeper response based on AWS credential information available in the Uploader properties. The response signs URLs to be valid for 1 day.
    The required properties are:
    - AwsAccessKey
    - AwsSecretKey
    - S3BucketName
    Parameters:
    
    objects -
    
    Returns:
    
    Throws:
    
    java.lang.Exception
  - contactGatewayServer
```
private GatekeeperMessage contactGatewayServer(S3Object[] objects)
                                        throws java.lang.Exception
```
    Retrieves a signed PUT URL from the given URL address. The URL must point at a server-side script or service that accepts POST messages. The POST message will include parameters for all the items in uploaderProperties, that is everything in the file uploader.properties plus all the applet's parameters. Based on this input, the server-side script decides whether to allow access and return a signed PUT URL.
    
    Parameters:
    
    credsProviderParamName - the name of the parameter containing the server URL target for the PUT request.
    
    Returns:
    
    the AWS credentials provided by the server-side script if access was allowed, null otherwise.
    
    Throws:
    
    HttpException
    
    java.lang.Exception
  - retrieveGatekeeperResponse
```
private GatekeeperMessage retrieveGatekeeperResponse(S3Object[] objects)
                                              throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - uploadFilesToS3
```
private void uploadFilesToS3()
```
    Uploads to S3 the file referenced by the variable fileToUpload, providing progress feedback to the user all the while.
  - prepareSignedObjects
```
private SignedUrlAndObject[] prepareSignedObjects(S3Object[] objects,
                                                  SignatureRequest[] signatureRequests,
                                                  XmlGenerator xmlGenerator)
                                           throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - s3ServiceEventPerformed
```
public void s3ServiceEventPerformed(CreateObjectsEvent event)
```
    Listener method that responds to events from the jets3t toolkit when objects are created in S3 - ie when files are uploaded.
    
    Specified by:
    
    s3ServiceEventPerformed in interface S3ServiceEventListener
  - configureButton
```
private void configureButton(javax.swing.JButton button,
                             java.lang.String propertiesPrefix)
```
    Configures a button's text, tooltip and image using uploader properties prefixed with the given properties prefix.
    
    Parameters:
    
    button -
    
    propertiesPrefix -
  - drawWizardScreen
```
private void drawWizardScreen(int nextState)
```
    Draws the wizard screen appropriate to the stage in the wizard process the user has reached.
    
    Parameters:
    
    nextState - an integer detailing the screen the user is moving to.
  - wizardStepForward
```
private void wizardStepForward()
```
    Move the wizard forward one step/screen.
  - wizardStepBackward
```
private void wizardStepBackward()
```
    Move the wizard backward one step/screen.
  - failWithFatalError
```
private void failWithFatalError(java.lang.String errorCode)
```
    When a fatal error occurs, go straight to last screen to display the error message and make the error code available as a variable (${errorCode}) to be used in the error message displayed to the user.
    If there is an Uploader property errorCodeMessage.<code> corresponding to this error code, the value of this property is made available as a variable (${errorMessage}). If there is no such property available the ${errorMessage} variable will be an empty string.
    
    Parameters:
    
    errorCode - the error code, which may correspond with an error message in uploader.properties.
  - replaceMessageVariables
```
private java.lang.String replaceMessageVariables(java.lang.String message)
```
    Replaces variables of the form ${variableName} in the input string with the value of that variable name in the local uploaderProperties properties object, or with one of the following special variables:
    - fileName : Name of file being uploaded
    - fileSize : Size of the file being uploaded, eg 1.04 MB
    - filePath : Absolute path of the file being uploaded
    - maxFileSize : The maxiumum allowed file size in MB
    - maxFileCount : The maximum number of files that may be uploaded
    - validFileExtensions : A list of the file extensions allowed
    If the variable named in the input string is not available, or has no value, the variable reference is left in the result.
    Parameters:
    
    message - string that may have variables to replace
    
    Returns:
    
    the input string with any variable referenced replaced with the variable's value.
  - actionPerformed
```
public void actionPerformed(java.awt.event.ActionEvent actionEvent)
```
    Handles GUI actions.
    
    Specified by:
    
    actionPerformed in interface java.awt.event.ActionListener
  - initHttpConnection
```
private org.apache.http.client.HttpClient initHttpConnection()
```
  - followHyperlink
```
public void followHyperlink(java.net.URL url,
                            java.lang.String target)
```
    Follows hyperlinks clicked on by a user. This is achieved differently depending on whether Cockpit is running as an applet or as a stand-alone application:
    - Application: Detects the default browser application for the user's system (using BareBonesBrowserLaunch) and opens the link as a new window in that browser
    - Applet: Opens the link in the current browser using the applet's context
    Specified by:
    
    followHyperlink in interface HyperlinkActivatedListener
    
    Parameters:
    
    url - the url to open
    
    target - the target pane to open the url in, eg "_blank". This may be null.
  - setCredentials
```
public void setCredentials(org.apache.http.auth.AuthScope authscope,
                           org.apache.http.auth.Credentials credentials)
```
    Specified by:
    
    setCredentials in interface org.apache.http.client.CredentialsProvider
  - clear
```
public void clear()
```
    Clear credentials.
    
    Specified by:
    
    clear in interface org.apache.http.client.CredentialsProvider
  - getCredentials
```
public org.apache.http.auth.Credentials getCredentials(org.apache.http.auth.AuthScope scope)
```
    Implementation method for the CredentialsProvider interface.
    Based on sample code: InteractiveAuthenticationExample
    
    Specified by:
    
    getCredentials in interface org.apache.http.client.CredentialsProvider
  - s3ServiceEventPerformed
```
public void s3ServiceEventPerformed(ListObjectsEvent event)
```
    Specified by:
    
    s3ServiceEventPerformed in interface S3ServiceEventListener
  - s3ServiceEventPerformed
```
public void s3ServiceEventPerformed(CreateBucketsEvent event)
```
    Specified by:
    
    s3ServiceEventPerformed in interface S3ServiceEventListener
  - s3ServiceEventPerformed
```
public void s3ServiceEventPerformed(DeleteObjectsEvent event)
```
    Specified by:
    
    s3ServiceEventPerformed in interface S3ServiceEventListener
  - s3ServiceEventPerformed
```
public void s3ServiceEventPerformed(GetObjectsEvent event)
```
    Specified by:
    
    s3ServiceEventPerformed in interface S3ServiceEventListener
  - s3ServiceEventPerformed
```
public void s3ServiceEventPerformed(GetObjectHeadsEvent event)
```
    Specified by:
    
    s3ServiceEventPerformed in interface S3ServiceEventListener
  - s3ServiceEventPerformed
```
public void s3ServiceEventPerformed(LookupACLEvent event)
```
    Specified by:
    
    s3ServiceEventPerformed in interface S3ServiceEventListener
  - s3ServiceEventPerformed
```
public void s3ServiceEventPerformed(UpdateACLEvent event)
```
    Specified by:
    
    s3ServiceEventPerformed in interface S3ServiceEventListener
  - s3ServiceEventPerformed
```
public void s3ServiceEventPerformed(DownloadObjectsEvent event)
```
    Specified by:
    
    s3ServiceEventPerformed in interface S3ServiceEventListener
  - s3ServiceEventPerformed
```
public void s3ServiceEventPerformed(CopyObjectsEvent event)
```
    Specified by:
    
    s3ServiceEventPerformed in interface S3ServiceEventListener
  - s3ServiceEventPerformed
```
public void s3ServiceEventPerformed(DeleteVersionedObjectsEvent event)
```
    Specified by:
    
    s3ServiceEventPerformed in interface S3ServiceEventListener
  - valueChanged
```
public void valueChanged(javax.swing.event.ListSelectionEvent arg0)
```
    Specified by:
    
    valueChanged in interface javax.swing.event.ListSelectionListener
  - main
```
public static void main(java.lang.String[] args)
                 throws java.lang.Exception
```
    Run the Uploader as a stand-alone application.
    
    Parameters:
    
    args -
    
    Throws:
    
    java.lang.Exception

Class Uploader

Nested Class Summary

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

Nested classes/interfaces inherited from class java.applet.Applet

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

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.JApplet

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JApplet

Methods inherited from class java.applet.Applet

Methods inherited from class java.awt.Panel

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

log

APPLICATION_DESCRIPTION

UPLOADER_PROPERTIES_FILENAME

UPLOADER_VERSION_ID

WIZARD_SCREEN_1

WIZARD_SCREEN_2

WIZARD_SCREEN_3

WIZARD_SCREEN_4

WIZARD_SCREEN_5

ERROR_CODE__MISSING_REQUIRED_PARAM

ERROR_CODE__S3_UPLOAD_FAILED

ERROR_CODE__UPLOAD_REQUEST_DECLINED

ERROR_CODE__TRANSACTION_ID_REQUIRED_TO_CREATE_XML_SUMMARY

HTTP_CONNECTION_TIMEOUT

SOCKET_CONNECTION_TIMEOUT

MAX_CONNECTION_RETRIES

ownerFrame

userInputFields

userInputProperties

httpClientGatekeeper

s3ServiceMulti

filesToUpload

validFileExtensions

uploaderProperties

standAloneArgumentProperties

byteFormatter

timeFormatter

fileMaxCount

fileMaxSizeMB

fileMinSizeMB

insetsDefault

insetsNone

guiUtils

currentState

isRunningAsApplet

parametersMap

skinsFactory

GRID_BAG_LAYOUT

userGuidanceLabel

appContentPanel

buttonsPanel

primaryPanel

primaryPanelCardLayout

buttonsPanelCardLayout

backButton

nextButton

cancelUploadButton

dragDropTargetLabel

fileToUploadLabel

fileInformationLabel

progressTransferDetailsLabel

progressBar

progressStatusTextLabel

finalMessageLabel

uploadCancelEventTrigger

uploadingFinalObject

includeXmlSummaryDoc

uploadCancelled

fatalErrorOccurred