common EGIZ code-style refactoring

2 files changed, 337 insertions, 325 deletions

diff --git a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/data/IAuthProcessDataContainer.java b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/data/IAuthProcessDataContainer.java
index 17ec6445..77fc025c 100644
--- a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/data/IAuthProcessDataContainer.java
+++ b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/data/IAuthProcessDataContainer.java
@@ -1,24 +1,20 @@
 /*******************************************************************************
- * Copyright 2017 Graz University of Technology
- * EAAF-Core Components has been developed in a cooperation between EGIZ,  
- * A-SIT Plus, A-SIT, and Graz University of Technology.
+ * Copyright 2017 Graz University of Technology EAAF-Core Components has been developed in a
+ * cooperation between EGIZ, A-SIT Plus, A-SIT, and Graz University of Technology.
  *
- * Licensed under the EUPL, Version 1.2 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:
+ * Licensed under the EUPL, Version 1.2 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:
  * https://joinup.ec.europa.eu/news/understanding-eupl-v12
  *
- * 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.
- *  
- * This product combines work with different licenses. See the "NOTICE" text
- * file for details on the various modules and licenses.
- * The "NOTICE" text file is part of the distribution. Any derivative works
- * that you distribute must include a readable copy of the "NOTICE" text file.
+ * 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.
+ * 
+ * This product combines work with different licenses. See the "NOTICE" text file for details on the
+ * various modules and licenses. The "NOTICE" text file is part of the distribution. Any derivative
+ * works that you distribute must include a readable copy of the "NOTICE" text file.
  *******************************************************************************/
 /*******************************************************************************
  *******************************************************************************/
@@ -29,157 +25,158 @@ package at.gv.egiz.eaaf.core.api.idp.auth.data;
 import java.util.Date;
 import java.util.Map;
 
-import at.gv.egiz.eaaf.core.exceptions.EAAFStorageException;
+import at.gv.egiz.eaaf.core.exceptions.EaafStorageException;
 
 public interface IAuthProcessDataContainer {
 
-	/**
-	 * Returns the issuing time of the AUTH-Block SAML assertion.
-	 * 
-	 * @return The issuing time of the AUTH-Block SAML assertion.
-	 */
-	String getIssueInstant();
-
-	/**
-	 * Sets the issuing time of the AUTH-Block SAML assertion.
-	 * 
-	 * @param issueInstant
-	 *            The issueInstant to set.
-	 */
-	void setIssueInstant(String issueInstant);
-	
-	/**
-	 * Indicate if the authentication process is finished
-	 * 
-	 * @return
-	 */
-	boolean isAuthenticated();
-
-	/**
-	 * Mark the authentication as authenticated, which means that the authenication process is completed
-	 * 
-	 * @param authenticated
-	 */
-	void setAuthenticated(boolean authenticated);
-	
-	/**
-	 * Returns the identityLink.
-	 * 
-	 * @return IdentityLink
-	 */
-	@Deprecated
-	IIdentityLink getIdentityLink();
-	
-	/**
-	 * Sets the identityLink.
-	 * 
-	 * @param identityLink
-	 *            The identityLink to set
-	 */
-	@Deprecated
-	void setIdentityLink(IIdentityLink identityLink);
-	
-	
-	/**
-	 * Flag marks the authentication process as new E-ID process 
-	 * 
-	 * @return true if E-ID process, otherwise false
-	 */
-	boolean isEIDProcess();
-	
-	
-	/**
-	 * Set the flag to make the process as new E-ID process 
-	 * 
-	 * @param value true if new E-ID process, otherwise false
-	 */
-	void setEIDProcess(boolean value);
-	
-	/**
-	 * Indicate that mandates was used in this auth. process
-	 * 
-	 * @return
-	 */
-	boolean isMandateUsed();
-	
-	/**
-	 * Mark that mandates was used in this auth. process
-	 * 
-	 * @param useMandates
-	 */
-	void setUseMandates(boolean useMandates);
-
-	/**
-	 * Indicate that the auth. process was performed by a foreigner
-	 * 
-	 * @return
-	 */
-	boolean isForeigner();
-
-	/**
-	 * Mark that the auth. process was done by a foreigner
-	 * 
-	 * @param isForeigner
-	 */
-	void setForeigner(boolean isForeigner);
-	
-	/**
-	 * Indicate that the auth. process was performed by an official representatives 
-	 * 
-	 * @return is official representatives 
-	 */
-	boolean isOW();
-
-	/**
-	 * Mark that the auth. process was done by an official representatives 
-	 *            
-	 */
-	void setOW(boolean isOW);
-	
-	/**
-	 * eIDAS QAA level
-	 * 
-	 * @return the qAALevel
-	 */
-	String getQAALevel();
-
-	/**
-	 * set QAA level in eIDAS form
-	 * 
-	 * @param qAALevel the qAALevel to set
-	 */
-	void setQAALevel(String qAALevel);
-
-	/**
-	 * @return the sessionCreated
-	 */
-	Date getSessionCreated();
-
-	Map<String, Object> getGenericSessionDataStorage();
-
-	/**
-	 * Returns a generic session-data object with is stored with a specific identifier 
-	 * 
-	 * @param key The specific identifier of the session-data object
-	 * @return The session-data object or null if no data is found with this key
-	 */
-	Object getGenericDataFromSession(String key);
-
-	/**
-	 * Returns a generic session-data object with is stored with a specific identifier 
-	 * 
-	 * @param key The specific identifier of the session-data object
-	 * @param clazz The class type which is stored with this key
-	 * @return The session-data object or null if no data is found with this key
-	 */
-	<T> T getGenericDataFromSession(String key, Class<T> clazz);
-
-	/**
-	 * Store a generic data-object to session with a specific identifier
-	 * 
-	 * @param key Identifier for this data-object
-	 * @param object Generic data-object which should be stored. This data-object had to be implement the 'java.io.Serializable' interface
-	 * @throws EAAFStorageException Error message if the data-object can not stored to generic session-data storage
-	 */
-	void setGenericDataToSession(String key, Object object) throws EAAFStorageException;
+  /**
+   * Returns the issuing time of the AUTH-Block SAML assertion.
+   * 
+   * @return The issuing time of the AUTH-Block SAML assertion.
+   */
+  String getIssueInstant();
+
+  /**
+   * Sets the issuing time of the AUTH-Block SAML assertion.
+   * 
+   * @param issueInstant The issueInstant to set.
+   */
+  void setIssueInstant(String issueInstant);
+
+  /**
+   * Indicate if the authentication process is finished
+   * 
+   * @return
+   */
+  boolean isAuthenticated();
+
+  /**
+   * Mark the authentication as authenticated, which means that the authenication process is
+   * completed
+   * 
+   * @param authenticated
+   */
+  void setAuthenticated(boolean authenticated);
+
+  /**
+   * Returns the identityLink.
+   * 
+   * @return IdentityLink
+   */
+  @Deprecated
+  IIdentityLink getIdentityLink();
+
+  /**
+   * Sets the identityLink.
+   * 
+   * @param identityLink The identityLink to set
+   */
+  @Deprecated
+  void setIdentityLink(IIdentityLink identityLink);
+
+
+  /**
+   * Flag marks the authentication process as new E-ID process
+   * 
+   * @return true if E-ID process, otherwise false
+   */
+  boolean isEIDProcess();
+
+
+  /**
+   * Set the flag to make the process as new E-ID process
+   * 
+   * @param value true if new E-ID process, otherwise false
+   */
+  void setEIDProcess(boolean value);
+
+  /**
+   * Indicate that mandates was used in this auth. process
+   * 
+   * @return
+   */
+  boolean isMandateUsed();
+
+  /**
+   * Mark that mandates was used in this auth. process
+   * 
+   * @param useMandates
+   */
+  void setUseMandates(boolean useMandates);
+
+  /**
+   * Indicate that the auth. process was performed by a foreigner
+   * 
+   * @return
+   */
+  boolean isForeigner();
+
+  /**
+   * Mark that the auth. process was done by a foreigner
+   * 
+   * @param isForeigner
+   */
+  void setForeigner(boolean isForeigner);
+
+  /**
+   * Indicate that the auth. process was performed by an official representatives
+   * 
+   * @return is official representatives
+   */
+  boolean isOW();
+
+  /**
+   * Mark that the auth. process was done by an official representatives
+   * 
+   */
+  void setOW(boolean isOW);
+
+  /**
+   * eIDAS QAA level
+   * 
+   * @return the qAALevel
+   */
+  String getQAALevel();
+
+  /**
+   * set QAA level in eIDAS form
+   * 
+   * @param qAALevel the qAALevel to set
+   */
+  void setQAALevel(String qAALevel);
+
+  /**
+   * @return the sessionCreated
+   */
+  Date getSessionCreated();
+
+  Map<String, Object> getGenericSessionDataStorage();
+
+  /**
+   * Returns a generic session-data object with is stored with a specific identifier
+   * 
+   * @param key The specific identifier of the session-data object
+   * @return The session-data object or null if no data is found with this key
+   */
+  Object getGenericDataFromSession(String key);
+
+  /**
+   * Returns a generic session-data object with is stored with a specific identifier
+   * 
+   * @param key The specific identifier of the session-data object
+   * @param clazz The class type which is stored with this key
+   * @return The session-data object or null if no data is found with this key
+   */
+  <T> T getGenericDataFromSession(String key, Class<T> clazz);
+
+  /**
+   * Store a generic data-object to session with a specific identifier
+   * 
+   * @param key Identifier for this data-object
+   * @param object Generic data-object which should be stored. This data-object had to be implement
+   *        the 'java.io.Serializable' interface
+   * @throws EaafStorageException Error message if the data-object can not stored to generic
+   *         session-data storage
+   */
+  void setGenericDataToSession(String key, Object object) throws EaafStorageException;
 }
diff --git a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/data/IIdentityLink.java b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/data/IIdentityLink.java
index df71b30a..b37d41e3 100644
--- a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/data/IIdentityLink.java
+++ b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/data/IIdentityLink.java
@@ -1,24 +1,20 @@
 /*******************************************************************************
- * Copyright 2017 Graz University of Technology
- * EAAF-Core Components has been developed in a cooperation between EGIZ,  
- * A-SIT Plus, A-SIT, and Graz University of Technology.
+ * Copyright 2017 Graz University of Technology EAAF-Core Components has been developed in a
+ * cooperation between EGIZ, A-SIT Plus, A-SIT, and Graz University of Technology.
  *
- * Licensed under the EUPL, Version 1.2 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:
+ * Licensed under the EUPL, Version 1.2 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:
  * https://joinup.ec.europa.eu/news/understanding-eupl-v12
  *
- * 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.
- *  
- * This product combines work with different licenses. See the "NOTICE" text
- * file for details on the various modules and licenses.
- * The "NOTICE" text file is part of the distribution. Any derivative works
- * that you distribute must include a readable copy of the "NOTICE" text file.
+ * 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.
+ * 
+ * This product combines work with different licenses. See the "NOTICE" text file for details on the
+ * various modules and licenses. The "NOTICE" text file is part of the distribution. Any derivative
+ * works that you distribute must include a readable copy of the "NOTICE" text file.
  *******************************************************************************/
 /*******************************************************************************
  *******************************************************************************/
@@ -39,144 +35,163 @@ import org.w3c.dom.Element;
  */
 public interface IIdentityLink {
 
-	/**
-	   * Returns the dateOfBirth.
-	   * @return Calendar
-	   */
-	String getDateOfBirth();
-
-	/**
-	   * Returns the familyName.
-	   * @return String
-	   */
-	String getFamilyName();
-
-	/**
-	   * Returns the givenName.
-	   * @return String
-	   */
-	String getGivenName();
-
-	/**
-	 * Return  the name as 'givenName + " " + familyName'<br>
-	 * This method should be used any more. Use getFamilyName() and getGivenName() separately.
-	 * 
-	 * @return The name.
-	*/
-	@Deprecated
-	String getName();
-
-	/**
-	   * Returns the identificationValue.
-		 * <code>"identificationValue"</code> is the translation of <code>"Stammzahl"</code>.
-	   * @return String
-	   */
-	String getIdentificationValue();
-
-	/**
-	 * Returns the identificationType.
-	 * <code>"identificationType"</code> type of the identificationValue in the IdentityLink.
-	 * @return String
-	 */
-	String getIdentificationType();
-
-	/**
-	   * Sets the dateOfBirth.
-	   * @param dateOfBirth The dateOfBirth to set
-	   */
-	void setDateOfBirth(String dateOfBirth);
-
-	/**
-	   * Sets the familyName.
-	   * @param familyName The familyName to set
-	   */
-	void setFamilyName(String familyName);
-
-	/**
-	   * Sets the givenName.
-	   * @param givenName The givenName to set
-	   */
-	void setGivenName(String givenName);
-
-	/**
-	   * Sets the identificationValue.
-		 * <code>"identificationValue"</code> is the translation of <code>"Stammzahl"</code>.
-	   * @param identificationValue The identificationValue to set
-	   */
-	void setIdentificationValue(String identificationValue);
-
-	/**
-	 * Sets the Type of the identificationValue.
-	 * @param identificationType The type of identificationValue to set
-	 */
-	void setIdentificationType(String identificationType);
-
-	/**
-	   * Returns the samlAssertion.
-	   * @return Element
-	   */
-	Element getSamlAssertion();
-
-	/**
-	   * Returns the samlAssertion.
-	   * @return Element
-	   */
-	String getSerializedSamlAssertion();
-
-	/**
-	   * Sets the samlAssertion and the serializedSamlAssertion.
-	   * @param samlAssertion The samlAssertion to set
-	   */
-	void setSamlAssertion(Element samlAssertion) throws TransformerException, IOException;
-
-	/**
-	   * Returns the dsigReferenceTransforms.
-	   * @return Element[]
-	   */
-	Element[] getDsigReferenceTransforms();
-
-	/**
-	   * Sets the dsigReferenceTransforms.
-	   * @param dsigReferenceTransforms The dsigReferenceTransforms to set
-	   */
-	void setDsigReferenceTransforms(Element[] dsigReferenceTransforms);
-
-	/**
-	   * Returns the publicKey.
-	   * @return PublicKey[]
-	   */
-	PublicKey[] getPublicKey();
-
-	/**
-	   * Sets the publicKey.
-	   * @param publicKey The publicKey to set
-	   */
-	void setPublicKey(PublicKey[] publicKey);
-
-	/**
-	   * Returns the prPerson.
-	   * @return Element
-	   */
-	Element getPrPerson();
-
-	/**
-	   * Sets the prPerson.
-	   * @param prPerson The prPerson to set
-	   */
-	void setPrPerson(Element prPerson);
-
-	/**
-	   * Returns the issuing time of the identity link SAML assertion.
-	   *
-	   * @return The issuing time of the identity link SAML assertion.
-	   */
-	String getIssueInstant();
-
-	/**
-	   * Sets the issuing time of the identity link SAML assertion.
-	   *
-	   * @param issueInstant The issueInstant to set.
-	   */
-	void setIssueInstant(String issueInstant);
-
-}
\ No newline at end of file
+  /**
+   * Returns the dateOfBirth.
+   * 
+   * @return Calendar
+   */
+  String getDateOfBirth();
+
+  /**
+   * Returns the familyName.
+   * 
+   * @return String
+   */
+  String getFamilyName();
+
+  /**
+   * Returns the givenName.
+   * 
+   * @return String
+   */
+  String getGivenName();
+
+  /**
+   * Return the name as 'givenName + " " + familyName'<br>
+   * This method should be used any more. Use getFamilyName() and getGivenName() separately.
+   * 
+   * @return The name.
+   */
+  @Deprecated
+  String getName();
+
+  /**
+   * Returns the identificationValue. <code>"identificationValue"</code> is the translation of
+   * <code>"Stammzahl"</code>.
+   * 
+   * @return String
+   */
+  String getIdentificationValue();
+
+  /**
+   * Returns the identificationType. <code>"identificationType"</code> type of the
+   * identificationValue in the IdentityLink.
+   * 
+   * @return String
+   */
+  String getIdentificationType();
+
+  /**
+   * Sets the dateOfBirth.
+   * 
+   * @param dateOfBirth The dateOfBirth to set
+   */
+  void setDateOfBirth(String dateOfBirth);
+
+  /**
+   * Sets the familyName.
+   * 
+   * @param familyName The familyName to set
+   */
+  void setFamilyName(String familyName);
+
+  /**
+   * Sets the givenName.
+   * 
+   * @param givenName The givenName to set
+   */
+  void setGivenName(String givenName);
+
+  /**
+   * Sets the identificationValue. <code>"identificationValue"</code> is the translation of
+   * <code>"Stammzahl"</code>.
+   * 
+   * @param identificationValue The identificationValue to set
+   */
+  void setIdentificationValue(String identificationValue);
+
+  /**
+   * Sets the Type of the identificationValue.
+   * 
+   * @param identificationType The type of identificationValue to set
+   */
+  void setIdentificationType(String identificationType);
+
+  /**
+   * Returns the samlAssertion.
+   * 
+   * @return Element
+   */
+  Element getSamlAssertion();
+
+  /**
+   * Returns the samlAssertion.
+   * 
+   * @return Element
+   */
+  String getSerializedSamlAssertion();
+
+  /**
+   * Sets the samlAssertion and the serializedSamlAssertion.
+   * 
+   * @param samlAssertion The samlAssertion to set
+   */
+  void setSamlAssertion(Element samlAssertion) throws TransformerException, IOException;
+
+  /**
+   * Returns the dsigReferenceTransforms.
+   * 
+   * @return Element[]
+   */
+  Element[] getDsigReferenceTransforms();
+
+  /**
+   * Sets the dsigReferenceTransforms.
+   * 
+   * @param dsigReferenceTransforms The dsigReferenceTransforms to set
+   */
+  void setDsigReferenceTransforms(Element[] dsigReferenceTransforms);
+
+  /**
+   * Returns the publicKey.
+   * 
+   * @return PublicKey[]
+   */
+  PublicKey[] getPublicKey();
+
+  /**
+   * Sets the publicKey.
+   * 
+   * @param publicKey The publicKey to set
+   */
+  void setPublicKey(PublicKey[] publicKey);
+
+  /**
+   * Returns the prPerson.
+   * 
+   * @return Element
+   */
+  Element getPrPerson();
+
+  /**
+   * Sets the prPerson.
+   * 
+   * @param prPerson The prPerson to set
+   */
+  void setPrPerson(Element prPerson);
+
+  /**
+   * Returns the issuing time of the identity link SAML assertion.
+   *
+   * @return The issuing time of the identity link SAML assertion.
+   */
+  String getIssueInstant();
+
+  /**
+   * Sets the issuing time of the identity link SAML assertion.
+   *
+   * @param issueInstant The issueInstant to set.
+   */
+  void setIssueInstant(String issueInstant);
+
+}