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

7 files changed, 191 insertions, 7 deletions

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