From 3fada6cef21c9b16467177d866df778203b51b4d Mon Sep 17 00:00:00 2001 From: Thomas Date: Thu, 5 Dec 2019 09:52:48 +0100 Subject: some code code-style modifications active code-quality checks! --- .../core/api/idp/auth/IAuthenticationManager.java | 46 +++++---- .../egiz/eaaf/core/api/idp/auth/ISsoManager.java | 71 +++++++------- .../idp/auth/data/IAuthProcessDataContainer.java | 103 ++++++++++----------- .../eaaf/core/api/idp/auth/data/IIdentityLink.java | 64 ++++++------- .../eaaf/core/api/idp/auth/modules/AuthModule.java | 33 ++++--- .../services/IProtocolAuthenticationService.java | 48 +++++----- 6 files changed, 184 insertions(+), 181 deletions(-) (limited to 'eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth') diff --git a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/IAuthenticationManager.java b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/IAuthenticationManager.java index 7c100d1d..3dba4e78 100644 --- a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/IAuthenticationManager.java +++ b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/IAuthenticationManager.java @@ -21,6 +21,7 @@ package at.gv.egiz.eaaf.core.api.idp.auth; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; + import at.gv.egiz.eaaf.core.api.IRequest; import at.gv.egiz.eaaf.core.api.idp.process.ExecutionContext; import at.gv.egiz.eaaf.core.api.idp.slo.ISloInformationContainer; @@ -33,60 +34,57 @@ public interface IAuthenticationManager { int EVENT_AUTHENTICATION_PROCESS_FINISHED = 4001; int EVENT_AUTHENTICATION_PROCESS_ERROR = 4002; - /** - * Add a request parameter to whitelist. All parameters that are part of the white list are added - * into {@link ExecutionContext} + * Add a request parameter to whitelist. All parameters that are part of the + * white list are added into {@link ExecutionContext} * * @param httpReqParam http parameter name, but never null */ void addParameterNameToWhiteList(String httpReqParam); /** - * Add a request header to whitelist. All parameters that are part of the white list are added - * into {@link ExecutionContext} + * Add a request header to whitelist. All parameters that are part of the white + * list are added into {@link ExecutionContext} * * @param httpReqParam http header name, but never null */ void addHeaderNameToWhiteList(String httpReqParam); - /** * Starts an authentication process for a specific pending request. * - * @param httpReq http servlet request - * @param httpResp http servlet response + * @param httpReq http servlet request + * @param httpResp http servlet response * @param pendingReq Pending request for that an authentication is required * @return true if the pending request is already authenticated, otherwise false * @throws EaafException In case of an authentication error */ - boolean doAuthentication(HttpServletRequest httpReq, HttpServletResponse httpResp, - IRequest pendingReq) throws EaafException; + boolean doAuthentication(HttpServletRequest httpReq, HttpServletResponse httpResp, IRequest pendingReq) + throws EaafException; /** * Close an active authenticated session on IDP side. * - * @param request http servlet request - * @param response http servlet response - * @param pendingReq ReqPending request for that an authentication session should be closed + * @param request http servlet request + * @param response http servlet response + * @param pendingReq ReqPending request for that an authentication session + * should be closed */ - void performOnlyIdpLogOut(HttpServletRequest request, HttpServletResponse response, - IRequest pendingReq); - + void performOnlyIdpLogOut(HttpServletRequest request, HttpServletResponse response, IRequest pendingReq); /** - * Close an active authenticated session on IDP side and get a list authenticated service - * providers. + * Close an active authenticated session on IDP side and get a list + * authenticated service providers. * - * @param httpReq http servlet request - * @param httpResp http servlet response - * @param pendingReq ReqPending request for that an authentication session should be closed + * @param httpReq http servlet request + * @param httpResp http servlet response + * @param pendingReq ReqPending request for that an authentication session + * should be closed * @param internalSsoId internal SSO session identifier * @return A container that contains all active SP sessions * @throws EaafException In case of an internal SLO error */ - ISloInformationContainer performSingleLogOut(HttpServletRequest httpReq, - HttpServletResponse httpResp, IRequest pendingReq, String internalSsoId) throws EaafException; - + ISloInformationContainer performSingleLogOut(HttpServletRequest httpReq, HttpServletResponse httpResp, + IRequest pendingReq, String internalSsoId) throws EaafException; } diff --git a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/ISsoManager.java b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/ISsoManager.java index 65c388e8..f0d6cfca 100644 --- a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/ISsoManager.java +++ b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/ISsoManager.java @@ -21,6 +21,7 @@ package at.gv.egiz.eaaf.core.api.idp.auth; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; + import at.gv.egiz.eaaf.core.api.IRequest; import at.gv.egiz.eaaf.core.api.idp.slo.SloInformationInterface; import at.gv.egiz.eaaf.core.exceptions.EaafSsoException; @@ -31,97 +32,91 @@ public interface ISsoManager { int EVENT_SSO_SESSION_INVALID = -1; int EVENT_SSO_SESSION_VALID = -1; - String PROCESS_ENGINE_SSO_CONSENTS_EVALUATION = "ssoconsentsevaluation"; String AUTH_DATA_SSO_SESSIONID = "eaaf_authdata_sso_sessionId"; - /** - * Check if there is an active and valid SSO session for the current pending request.
- * If there is an active SSO session, the pending request will be populated with eID information - * from SSO session + * Check if there is an active and valid SSO session for the current pending + * request.
+ * If there is an active SSO session, the pending request will be populated with + * eID information from SSO session * * @param pendingReq Current incoming pending request - * @param httpReq http Servlet request - * @param httpResp http Servlet response + * @param httpReq http Servlet request + * @param httpResp http Servlet response * @return true if there is a valid SSO session, otherwise false * @throws EaafSsoException In case of an internal error */ - boolean checkAndValidateSsoSession(IRequest pendingReq, HttpServletRequest httpReq, - HttpServletResponse httpResp) throws EaafSsoException; + boolean checkAndValidateSsoSession(IRequest pendingReq, HttpServletRequest httpReq, HttpServletResponse httpResp) + throws EaafSsoException; /** * Populate service provider specific SSO settings. * *

- * Check if Single Sign-On is allowed for the current pending request and the requested service - * provider Set IRequest.needSingleSignOnFunctionality() to true if SSO is allowed + * Check if Single Sign-On is allowed for the current pending request and the + * requested service provider Set IRequest.needSingleSignOnFunctionality() to + * true if SSO is allowed *

* * @param pendingReq Current incoming pending request - * @param httpReq http Servlet request + * @param httpReq http Servlet request */ void isSsoAllowedForSp(IRequest pendingReq, HttpServletRequest httpReq); - /** - * Populate the current pending request with eID information from an existing SSO session. + * Populate the current pending request with eID information from an existing + * SSO session. * * @param pendingReq pending request that should be populated by SSO session - * @throws EaafSsoException if pending request contains no SSO information or population failed + * @throws EaafSsoException if pending request contains no SSO information or + * population failed */ void populatePendingRequestWithSsoInformation(IRequest pendingReq) throws EaafSsoException; - /** * Destroy an active SSO session on IDP site only. * - * @param httpReq http servlet request - * @param httpResp http servlet response + * @param httpReq http servlet request + * @param httpResp http servlet response * @param pendingReq current pending request * @return true if a SSO session was closed successfully, otherwise false * @throws EaafSsoException in case of an internal processing error */ - boolean destroySsoSessionOnIdpOnly(HttpServletRequest httpReq, - HttpServletResponse httpResp, IRequest pendingReq) throws EaafSsoException; - - + boolean destroySsoSessionOnIdpOnly(HttpServletRequest httpReq, HttpServletResponse httpResp, IRequest pendingReq) + throws EaafSsoException; /** - * Create a new SSO session-cookie for a specific pendingRequest and add it into http response. + * Create a new SSO session-cookie for a specific pendingRequest and add it into + * http response. * - * @param req http Request - * @param resp http Response + * @param req http Request + * @param resp http Response * @param pendingReq Current open PendingRequest * @return new created SSO identifier * @throws EaafSsoException In case of an internal error */ - String createNewSsoSessionCookie(HttpServletRequest req, HttpServletResponse resp, - IRequest pendingReq) throws EaafSsoException; - + String createNewSsoSessionCookie(HttpServletRequest req, HttpServletResponse resp, IRequest pendingReq) + throws EaafSsoException; /** * Create a new SSO session in database. * - * @param pendingReq current pending request + * @param pendingReq current pending request * @param newSsoSessionId new SSO sessionId * @throws EaafSsoException In case of an internal error */ - void createNewSsoSession(IRequest pendingReq, String newSsoSessionId) - throws EaafSsoException; - + void createNewSsoSession(IRequest pendingReq, String newSsoSessionId) throws EaafSsoException; /** * Updateing an existing SSO session in database. * - * @param pendingReq current pending request + * @param pendingReq current pending request * @param newSsoSessionId new SSO session Id - * @param sloInformation SLO information container + * @param sloInformation SLO information container * @throws EaafSsoException In case of an internal error */ - void updateSsoSession(IRequest pendingReq, String newSsoSessionId, - SloInformationInterface sloInformation) throws EaafSsoException; - - + void updateSsoSession(IRequest pendingReq, String newSsoSessionId, SloInformationInterface sloInformation) + throws EaafSsoException; } 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 77fc025c..60224ea6 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,4 +1,4 @@ -/******************************************************************************* +/* * 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. * @@ -11,15 +11,12 @@ * 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. - *******************************************************************************/ -/******************************************************************************* - *******************************************************************************/ -/******************************************************************************* - *******************************************************************************/ +*/ + package at.gv.egiz.eaaf.core.api.idp.auth.data; import java.util.Date; @@ -31,36 +28,36 @@ 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 - * + * 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 + * Mark the authentication as authenticated, which means that the authenication + * process is completed. + * + * @param authenticated If true, the authentication-process is marked as finished */ void setAuthenticated(boolean authenticated); /** * Returns the identityLink. - * + * * @return IdentityLink */ @Deprecated @@ -68,84 +65,84 @@ public interface IAuthProcessDataContainer { /** * Sets the identityLink. - * + * * @param identityLink The identityLink to set */ @Deprecated void setIdentityLink(IIdentityLink identityLink); - /** - * Flag marks the authentication process as new E-ID process - * + * Flag marks the authentication process as new E-ID process. + * * @return true if E-ID process, otherwise false */ - boolean isEIDProcess(); - + boolean isEidProcess(); /** - * Set the flag to make the process as new E-ID process - * + * 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); + 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 + * + * @param useMandates true, if mandates are used */ 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 + * + * @param isForeigner true, if citizenn is a foreigner */ 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 - * + * eIDAS QAA level. + * * @return the qAALevel */ - String getQAALevel(); + String getQaaLevel(); /** - * set QAA level in eIDAS form - * - * @param qAALevel the qAALevel to set + * set QAA level in eIDAS form. + * + * @param qaaLevel the qAALevel to set */ - void setQAALevel(String qAALevel); + void setQaaLevel(String qaaLevel); /** + * Get Timestamp when session was created. + * * @return the sessionCreated */ Date getSessionCreated(); @@ -153,30 +150,32 @@ public interface IAuthProcessDataContainer { Map getGenericSessionDataStorage(); /** - * Returns a generic session-data object with is stored with a specific identifier - * + * 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 + * 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 getGenericDataFromSession(String key, Class 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 + * 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 b37d41e3..74c82181 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,4 +1,4 @@ -/******************************************************************************* +/* * 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. * @@ -11,15 +11,12 @@ * 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. - *******************************************************************************/ -/******************************************************************************* - *******************************************************************************/ -/******************************************************************************* - *******************************************************************************/ +*/ + package at.gv.egiz.eaaf.core.api.idp.auth.data; import java.io.IOException; @@ -30,6 +27,8 @@ import javax.xml.transform.TransformerException; import org.w3c.dom.Element; /** + * Deprecated IdentityLink interface. + * * @author tlenz * */ @@ -37,38 +36,39 @@ 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'
- * This method should be used any more. Use getFamilyName() and getGivenName() separately. - * + * This method should be used any more. Use getFamilyName() and getGivenName() + * separately. + * * @return The name. */ @Deprecated String getName(); /** - * Returns the identificationValue. "identificationValue" is the translation of - * "Stammzahl". - * + * Returns the identificationValue. "identificationValue" is the + * translation of "Stammzahl". + * * @return String */ String getIdentificationValue(); @@ -76,106 +76,106 @@ public interface IIdentityLink { /** * Returns the identificationType. "identificationType" 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. "identificationValue" is the translation of - * "Stammzahl". - * + * Sets the identificationValue. "identificationValue" is the + * translation of "Stammzahl". + * * @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); diff --git a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/modules/AuthModule.java b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/modules/AuthModule.java index e74bed63..54a50920 100644 --- a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/modules/AuthModule.java +++ b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/modules/AuthModule.java @@ -23,37 +23,42 @@ import at.gv.egiz.eaaf.core.api.IRequest; import at.gv.egiz.eaaf.core.api.idp.process.ExecutionContext; /** - * Provides metadata of a certain module. Uses for module discovery and process selection. + * Provides metadata of a certain module. Uses for module discovery and process + * selection. */ public interface AuthModule { /** - * Returns the priority of the module. The priority defines the order of the respective module - * within the chain of discovered modules. Higher priorized modules are asked before lower - * priorized modules for a process that they can handle. + * Returns the priority of the module. The priority defines the order of the + * respective module within the chain of discovered modules. Higher priorized + * modules are asked before lower priorized modules for a process that they can + * handle. *

- * Internal default modules are priorized neutral ({@code 0}. Use a higher priority - * ({@code 1...Integer.MAX_VALUE}) in order to have your module(s) priorized or a lower priority - * ({@code Integer.MIN_VALUE...-1}) in order to put your modules behind default modules. + * Internal default modules are priorized neutral ({@code 0}. Use a higher + * priority ({@code 1...Integer.MAX_VALUE}) in order to have your module(s) + * priorized or a lower priority ({@code Integer.MIN_VALUE...-1}) in order to + * put your modules behind default modules. * * @return the priority of the module. */ int getPriority(); /** - * Selects a process (description), referenced by its unique id, which is able to perform - * authentication with the given {@link ExecutionContext}. Returns {@code null} if no appropriate - * process (description) was available within this module. + * Selects a process (description), referenced by its unique id, which is able + * to perform authentication with the given {@link ExecutionContext}. Returns + * {@code null} if no appropriate process (description) was available within + * this module. * - * @param context an ExecutionContext for a process. + * @param context an ExecutionContext for a process. * @param pendingReq the current processed pending request - * @return the process-ID of a process which is able to work with the given ExecutionContext, or - * {@code null}. + * @return the process-ID of a process which is able to work with the given + * ExecutionContext, or {@code null}. */ String selectProcess(ExecutionContext context, IRequest pendingReq); /** - * Returns the an Array of {@link ProcessDefinition}s of the processes included in this module. + * Returns the an Array of {@link ProcessDefinition}s of the processes included + * in this module. * * @return an array of resource uris of the processes included in this module. */ diff --git a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/services/IProtocolAuthenticationService.java b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/services/IProtocolAuthenticationService.java index e817720b..86d15d5b 100644 --- a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/services/IProtocolAuthenticationService.java +++ b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/auth/services/IProtocolAuthenticationService.java @@ -20,8 +20,10 @@ package at.gv.egiz.eaaf.core.api.idp.auth.services; import java.io.IOException; + import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; + import at.gv.egiz.eaaf.core.api.IRequest; import at.gv.egiz.eaaf.core.api.logging.IStatisticLogger; import at.gv.egiz.eaaf.core.exceptions.EaafException; @@ -33,14 +35,13 @@ public interface IProtocolAuthenticationService { String PARAM_GUI_ERRORCODEPARAMS = "errorParams"; String PARAM_GUI_ERRORSTACKTRACE = "stacktrace"; - /** * Initialize an authentication process for this protocol request. * - * @param httpReq HttpServletRequest - * @param httpResp HttpServletResponse + * @param httpReq HttpServletRequest + * @param httpResp HttpServletResponse * @param pendingReq Authentication request which is actually in process - * @throws IOException In case of a communication error + * @throws IOException In case of a communication error * @throws EaafException In case of an application error */ void performAuthentication(HttpServletRequest httpReq, HttpServletResponse httpResp, IRequest pendingReq) @@ -49,10 +50,11 @@ public interface IProtocolAuthenticationService { /** * Finalize the requested protocol operation. * - * @param httpReq HttpServletRequest - * @param httpResp HttpServletResponse + * @param httpReq HttpServletRequest + * @param httpResp HttpServletResponse * @param pendingReq Authentication request which is actually in process - * @throws IOException If response can not be written into {@link HttpServletResponse} + * @throws IOException If response can not be written into + * {@link HttpServletResponse} * @throws EaafException If an internal error occur */ void finalizeAuthentication(HttpServletRequest httpReq, HttpServletResponse httpResp, IRequest pendingReq) @@ -61,26 +63,30 @@ public interface IProtocolAuthenticationService { /** * Build protocol-specific error message. * - * @param throwable Exception that should be handled - * @param req Current open http request as {@link HttpServletRequest} - * @param resp Current open http response as {@link HttpServletResponse} + * @param throwable Exception that should be handled + * @param req Current open http request as {@link HttpServletRequest} + * @param resp Current open http response as {@link HttpServletResponse} * @param pendingReq Authentication request which is actually in process - * @throws IOException If response can not be written into {@link HttpServletResponse} + * @throws IOException If response can not be written into + * {@link HttpServletResponse} * @throws EaafException If an internal error occur */ - void buildProtocolSpecificErrorResponse(Throwable throwable, HttpServletRequest req, - HttpServletResponse resp, IRequest pendingReq) throws IOException, EaafException; + void buildProtocolSpecificErrorResponse(Throwable throwable, HttpServletRequest req, HttpServletResponse resp, + IRequest pendingReq) throws IOException, EaafException; /** - * Handles all exceptions with no pending request. Therefore, the error is written to the users - * browser + * Handles all exceptions with no pending request. Therefore, the error is + * written to the users browser * - * @param throwable Exception that should be handled - * @param req Current open http request as {@link HttpServletRequest} - * @param resp Current open http response as {@link HttpServletResponse} - * @param writeExceptionToStatisticLog if true, the exception get logged into - * {@link IStatisticLogger} - * @throws IOException If response can not be written into {@link HttpServletResponse} + * @param throwable Exception that should be handled + * @param req Current open http request as + * {@link HttpServletRequest} + * @param resp Current open http response as + * {@link HttpServletResponse} + * @param writeExceptionToStatisticLog if true, the exception get + * logged into {@link IStatisticLogger} + * @throws IOException If response can not be written into + * {@link HttpServletResponse} * @throws EaafException If an internal error occure */ void handleErrorNoRedirect(Throwable throwable, HttpServletRequest req, HttpServletResponse resp, -- cgit v1.2.3