Added class templates

Old class files edited to match templates
Fixed missing comments

git-svn-id: https://joinup.ec.europa.eu/svn/pdf-over/trunk@12 174cde9d-5d70-4d2a-aa98-46368bc2aaf7

9 files changed, 260 insertions, 20 deletions

diff --git a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/Workflow.java b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/Workflow.java
index bc0e290c..9688a747 100644
--- a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/Workflow.java
+++ b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/Workflow.java
@@ -1,5 +1,23 @@
+/*
+ * Copyright 2012 by A-SIT, Secure Information Technology Center Austria
+ *
+ * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
+ * the European Commission - subsequent versions of the EUPL (the "Licence");
+ * You may not use this work except in compliance with the Licence.
+ * You may obtain a copy of the Licence at:
+ * http://joinup.ec.europa.eu/software/page/eupl
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the Licence is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Licence for the specific language governing permissions and
+ * limitations under the Licence.
+ */
 package at.asit.pdfover.gui.workflow;
 
+//Imports
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import java.util.Properties;
 
 import org.eclipse.swt.SWT;
@@ -9,7 +27,21 @@ import org.eclipse.swt.widgets.Shell;
 
 import at.asit.pdfover.gui.workflow.states.PrepareConfigurationState;
 
+/**
+ * Workflow holds logical state of signing process and updates the current logical state
+ */
 public class Workflow {
+	
+	/**
+	 * SFL4J Logger instance
+	 **/
+	@SuppressWarnings("unused")
+	private static final Logger log = LoggerFactory.getLogger(Workflow.class);
+	
+	/**
+	 * Default constructor
+	 * @param cmdLineArgs
+	 */
 	public Workflow(String[] cmdLineArgs) {
 		setCmdLineAargs(cmdLineArgs);
 	}
@@ -47,7 +79,7 @@ public class Workflow {
 	 * 
 	 * @return the command line arguments
 	 */
-	public String[] GetCmdArgs() {
+	public String[] cetCmdArgs() {
 		return this.cmdLineArgs;
 	}
 
@@ -58,14 +90,14 @@ public class Workflow {
 	 * 
 	 * @return the persistent state
 	 */
-	public Properties GetPersistentState() {
+	public Properties getPersistentState() {
 		return this.persistentState;
 	}
 
 	/**
 	 * Update Workflow logic and let state machine do its job...
 	 */
-	public void Update() {
+	public void update() {
 		WorkflowState next = null;
 		do {
 			this.state.update(this);
@@ -79,7 +111,7 @@ public class Workflow {
 	
 	private Composite container = null;
 	
-	private void CreateMainWindow() {
+	private void createMainWindow() {
 		//TODO: Instantiate Main Window Class
 		this.display = Display.getDefault();
 		this.shell = new Shell();
@@ -98,13 +130,13 @@ public class Workflow {
 	 * 
 	 * @return Composite
 	 */
-	public Composite GetComposite() {
+	public Composite getComposite() {
 		// TODO: implement
 		// Main window will be build on first call
 		// returns SWT Composite container for states to draw their GUI
 		
 		if(this.container == null) {
-			this.CreateMainWindow();
+			this.createMainWindow();
 		}
 		
 		if(this.container == null) {
@@ -119,7 +151,7 @@ public class Workflow {
 	 * 
 	 * @return
 	 */
-	private Shell NonCreatingGetShell() {
+	private Shell nonCreatingGetShell() {
 		return this.shell;
 	}
 
@@ -128,20 +160,20 @@ public class Workflow {
 	 * 
 	 * @return
 	 */
-	private Display NonCreatingGetDisplay() {
+	private Display nonCreatingGetDisplay() {
 		return this.display;
 	}
 
 	/**
 	 * Workflow main entrance point
 	 */
-	public void Start() {
+	public void start() {
 		// Call update to start processing ...
-		this.Update();
+		this.update();
 
 		// if a user interaction is required we have a shell ...
-		Shell shell = this.NonCreatingGetShell();
-		Display display = this.NonCreatingGetDisplay();
+		Shell shell = this.nonCreatingGetShell();
+		Display display = this.nonCreatingGetDisplay();
 
 		if (shell != null && display != null) {
 			while (!shell.isDisposed()) {
diff --git a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/WorkflowState.java b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/WorkflowState.java
index f9d10d08..b5bb9e23 100644
--- a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/WorkflowState.java
+++ b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/WorkflowState.java
@@ -1,11 +1,35 @@
+/*
+ * Copyright 2012 by A-SIT, Secure Information Technology Center Austria
+ *
+ * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
+ * the European Commission - subsequent versions of the EUPL (the "Licence");
+ * You may not use this work except in compliance with the Licence.
+ * You may obtain a copy of the Licence at:
+ * http://joinup.ec.europa.eu/software/page/eupl
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the Licence is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Licence for the specific language governing permissions and
+ * limitations under the Licence.
+ */
 package at.asit.pdfover.gui.workflow;
 
+//Imports
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 /**
  * Base state class 
- * @author afitzek
  */
 public abstract class WorkflowState {
 
+	/**
+	 * SFL4J Logger instance
+	 **/
+	@SuppressWarnings("unused")
+	private static final Logger log = LoggerFactory.getLogger(WorkflowState.class);
+	
 	private WorkflowState _next = null;
 	
 	/**
diff --git a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/BKUSelectionState.java b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/BKUSelectionState.java
index 657de4be..e92128ac 100644
--- a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/BKUSelectionState.java
+++ b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/BKUSelectionState.java
@@ -1,11 +1,37 @@
+/*
+ * Copyright 2012 by A-SIT, Secure Information Technology Center Austria
+ *
+ * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
+ * the European Commission - subsequent versions of the EUPL (the "Licence");
+ * You may not use this work except in compliance with the Licence.
+ * You may obtain a copy of the Licence at:
+ * http://joinup.ec.europa.eu/software/page/eupl
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the Licence is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Licence for the specific language governing permissions and
+ * limitations under the Licence.
+ */
 package at.asit.pdfover.gui.workflow.states;
 
+//Imports
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import at.asit.pdfover.gui.workflow.Workflow;
 import at.asit.pdfover.gui.workflow.WorkflowState;
 
-
+/**
+ * Decides which BKU to use (preconfigured or let user choose)
+ */
 public class BKUSelectionState extends WorkflowState {
 
+	/**
+	 * SFL4J Logger instance
+	 **/
+	@SuppressWarnings("unused")
+	private static final Logger log = LoggerFactory.getLogger(BKUSelectionState.class);
+	
 	@Override
 	public void update(Workflow workflow) {
 		// TODO Auto-generated method stub
diff --git a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/DataSourceSelectionState.java b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/DataSourceSelectionState.java
index 11b8c4ae..1458958f 100644
--- a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/DataSourceSelectionState.java
+++ b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/DataSourceSelectionState.java
@@ -1,11 +1,37 @@
+/*
+ * Copyright 2012 by A-SIT, Secure Information Technology Center Austria
+ *
+ * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
+ * the European Commission - subsequent versions of the EUPL (the "Licence");
+ * You may not use this work except in compliance with the Licence.
+ * You may obtain a copy of the Licence at:
+ * http://joinup.ec.europa.eu/software/page/eupl
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the Licence is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Licence for the specific language governing permissions and
+ * limitations under the Licence.
+ */
 package at.asit.pdfover.gui.workflow.states;
 
+//Imports
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import at.asit.pdfover.gui.workflow.Workflow;
 import at.asit.pdfover.gui.workflow.WorkflowState;
 
-
+/**
+ * Selects the data source for the signature process.
+ */
 public class DataSourceSelectionState extends WorkflowState {
 
+	/**
+	 * SFL4J Logger instance
+	 **/
+	@SuppressWarnings("unused")
+	private static final Logger log = LoggerFactory.getLogger(DataSourceSelectionState.class);
+	
 	@Override
 	public void update(Workflow workflow) {
 		// TODO Auto-generated method stub
diff --git a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/OutputState.java b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/OutputState.java
index a11364f2..162fb051 100644
--- a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/OutputState.java
+++ b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/OutputState.java
@@ -1,11 +1,37 @@
+/*
+ * Copyright 2012 by A-SIT, Secure Information Technology Center Austria
+ *
+ * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
+ * the European Commission - subsequent versions of the EUPL (the "Licence");
+ * You may not use this work except in compliance with the Licence.
+ * You may obtain a copy of the Licence at:
+ * http://joinup.ec.europa.eu/software/page/eupl
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the Licence is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Licence for the specific language governing permissions and
+ * limitations under the Licence.
+ */
 package at.asit.pdfover.gui.workflow.states;
 
+//Imports
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import at.asit.pdfover.gui.workflow.Workflow;
 import at.asit.pdfover.gui.workflow.WorkflowState;
 
-
+/**
+ * Procduces the output of the signature process. (save file, open file)
+ */
 public class OutputState extends WorkflowState {
 
+	/**
+	 * SFL4J Logger instance
+	 **/
+	@SuppressWarnings("unused")
+	private static final Logger log = LoggerFactory.getLogger(OutputState.class);
+	
 	@Override
 	public void update(Workflow workflow) {
 		// TODO Auto-generated method stub
diff --git a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/PositioningState.java b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/PositioningState.java
index c2b31247..1d21aeca 100644
--- a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/PositioningState.java
+++ b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/PositioningState.java
@@ -1,11 +1,37 @@
+/*
+ * Copyright 2012 by A-SIT, Secure Information Technology Center Austria
+ *
+ * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
+ * the European Commission - subsequent versions of the EUPL (the "Licence");
+ * You may not use this work except in compliance with the Licence.
+ * You may obtain a copy of the Licence at:
+ * http://joinup.ec.europa.eu/software/page/eupl
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the Licence is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Licence for the specific language governing permissions and
+ * limitations under the Licence.
+ */
 package at.asit.pdfover.gui.workflow.states;
 
+//Imports
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import at.asit.pdfover.gui.workflow.Workflow;
 import at.asit.pdfover.gui.workflow.WorkflowState;
 
-
+/**
+ * Decides where to position the signature block
+ */
 public class PositioningState extends WorkflowState {
 
+	/**
+	 * SFL4J Logger instance
+	 **/
+	@SuppressWarnings("unused")
+	private static final Logger log = LoggerFactory.getLogger(PositioningState.class);
+	
 	@Override
 	public void update(Workflow workflow) {
 		// TODO Auto-generated method stub
diff --git a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/PrepareConfigurationState.java b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/PrepareConfigurationState.java
index 31d8a604..3cde0e19 100644
--- a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/PrepareConfigurationState.java
+++ b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/PrepareConfigurationState.java
@@ -1,11 +1,39 @@
+/*
+ * Copyright 2012 by A-SIT, Secure Information Technology Center Austria
+ *
+ * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
+ * the European Commission - subsequent versions of the EUPL (the "Licence");
+ * You may not use this work except in compliance with the Licence.
+ * You may obtain a copy of the Licence at:
+ * http://joinup.ec.europa.eu/software/page/eupl
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the Licence is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Licence for the specific language governing permissions and
+ * limitations under the Licence.
+ */
 package at.asit.pdfover.gui.workflow.states;
 
+//Imports
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import at.asit.pdfover.gui.workflow.Workflow;
 import at.asit.pdfover.gui.workflow.WorkflowState;
 
-
+/**
+ * Starting state of workflow proccess
+ * 
+ * Reads configuration, command arguments and initializes configured variables
+ */
 public class PrepareConfigurationState extends WorkflowState {
 
+	/**
+	 * SFL4J Logger instance
+	 **/
+	@SuppressWarnings("unused")
+	private static final Logger log = LoggerFactory.getLogger(PrepareConfigurationState.class);
+	
 	@Override
 	public void update(Workflow workflow) {
 		// TODO Auto-generated method stub
diff --git a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/PrepareSigningState.java b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/PrepareSigningState.java
index ba6e7dc4..8f627dbf 100644
--- a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/PrepareSigningState.java
+++ b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/PrepareSigningState.java
@@ -1,11 +1,37 @@
+/*
+ * Copyright 2012 by A-SIT, Secure Information Technology Center Austria
+ *
+ * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
+ * the European Commission - subsequent versions of the EUPL (the "Licence");
+ * You may not use this work except in compliance with the Licence.
+ * You may obtain a copy of the Licence at:
+ * http://joinup.ec.europa.eu/software/page/eupl
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the Licence is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Licence for the specific language governing permissions and
+ * limitations under the Licence.
+ */
 package at.asit.pdfover.gui.workflow.states;
 
+//Imports
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import at.asit.pdfover.gui.workflow.Workflow;
 import at.asit.pdfover.gui.workflow.WorkflowState;
 
-
+/**
+ * User waiting state, wait for PDF Signator library to prepare document for signing.
+ */
 public class PrepareSigningState extends WorkflowState {
 
+	/**
+	 * SFL4J Logger instance
+	 **/
+	@SuppressWarnings("unused")
+	private static final Logger log = LoggerFactory.getLogger(PrepareSigningState.class);
+	
 	@Override
 	public void update(Workflow workflow) {
 		// TODO Auto-generated method stub
diff --git a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/SigningState.java b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/SigningState.java
index ed54d82f..2e052552 100644
--- a/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/SigningState.java
+++ b/pdf-over-gui/src/main/java/at/asit/pdfover/gui/workflow/states/SigningState.java
@@ -1,11 +1,37 @@
+/*
+ * Copyright 2012 by A-SIT, Secure Information Technology Center Austria
+ *
+ * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
+ * the European Commission - subsequent versions of the EUPL (the "Licence");
+ * You may not use this work except in compliance with the Licence.
+ * You may obtain a copy of the Licence at:
+ * http://joinup.ec.europa.eu/software/page/eupl
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the Licence is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Licence for the specific language governing permissions and
+ * limitations under the Licence.
+ */
 package at.asit.pdfover.gui.workflow.states;
 
+//Imports
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import at.asit.pdfover.gui.workflow.Workflow;
 import at.asit.pdfover.gui.workflow.WorkflowState;
 
-
+/**
+ * Logical state for signing process, usually show BKU Dialog during this state.
+ */
 public class SigningState extends WorkflowState {
 
+	/**
+	 * SFL4J Logger instance
+	 **/
+	@SuppressWarnings("unused")
+	private static final Logger log = LoggerFactory.getLogger(SigningState.class);
+	
 	@Override
 	public void update(Workflow workflow) {
 		// TODO Auto-generated method stub