From b573a90aa69b3d66b0a800d76398ef41f5ccb022 Mon Sep 17 00:00:00 2001 From: "peter.danner" Date: Tue, 31 Jul 2007 14:56:27 +0000 Subject: Fixed Javadoc git-svn-id: https://joinup.ec.europa.eu/svn/moa-idspss/trunk@864 d688527b-c9ab-4aba-bd8d-4036d912da1d --- .../moa/id/auth/AuthenticationServer.java | 4 ++-- .../AuthenticationBlockAssertionBuilder.java | 2 +- .../egovernment/moa/id/auth/builder/Builder.java | 4 ++-- .../builder/CreateXMLSignatureRequestBuilder.java | 2 +- .../moa/id/auth/data/AuthenticationSession.java | 18 ++++++++-------- .../id/auth/data/CreateXMLSignatureResponse.java | 2 +- .../id/auth/data/ExtendedSAMLAttributeImpl.java | 2 +- .../id/auth/data/InfoboxValidatorParamsImpl.java | 5 +++-- .../parser/CreateXMLSignatureResponseParser.java | 6 +++--- .../moa/id/auth/parser/ErrorResponseParser.java | 2 +- .../id/auth/parser/InfoboxReadResponseParser.java | 10 +++++---- .../CreateXMLSignatureResponseValidator.java | 3 +-- .../VerifyXMLSignatureResponseValidator.java | 4 ++-- .../moa/id/config/ConfigurationBuilder.java | 14 ++++++------- .../gv/egovernment/moa/id/config/OAParameter.java | 8 ++++---- .../moa/id/config/auth/OAAuthParameter.java | 10 ++++----- .../moa/id/config/proxy/OAConfiguration.java | 10 ++++----- .../moa/id/config/proxy/OAProxyParameter.java | 24 +++++++++++----------- .../moa/id/data/AuthenticationData.java | 8 ++++---- .../src/at/gv/egovernment/moa/id/data/Cookie.java | 6 +++--- .../gv/egovernment/moa/id/data/CookieManager.java | 14 ++++++------- .../iaik/config/RevocationConfigurationImpl.java | 2 +- .../iaik/servertools/observer/ObservableImpl.java | 6 +++--- .../moa/id/proxy/DefaultConnectionBuilder.java | 2 +- .../id/proxy/DefaultLoginParameterResolver.java | 4 ++-- .../moa/id/proxy/ElakConnectionBuilder.java | 2 +- .../moa/id/proxy/EnhancedConnectionBuilder.java | 2 +- .../XMLLoginParameterResolverEncryptedData.java | 12 +++++------ .../moa/id/util/AxisSecureSocketFactory.java | 3 +-- .../moa/id/util/ECDSAKeyValueConverter.java | 2 -- .../moa/id/util/InOrderServletRequestWrapper.java | 16 +++++++-------- 31 files changed, 104 insertions(+), 105 deletions(-) (limited to 'id.server/src') diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/AuthenticationServer.java b/id.server/src/at/gv/egovernment/moa/id/auth/AuthenticationServer.java index 0d3166090..a79cba4d7 100644 --- a/id.server/src/at/gv/egovernment/moa/id/auth/AuthenticationServer.java +++ b/id.server/src/at/gv/egovernment/moa/id/auth/AuthenticationServer.java @@ -992,14 +992,14 @@ public class AuthenticationServer implements MOAIDAuthConstants { /** * Sets the sessionTimeOut. - * @param sessionTimeOut time out in seconds + * @param seconds Time out of the session in seconds */ public void setSecondsSessionTimeOut(long seconds) { sessionTimeOut = 1000 * seconds; } /** * Sets the authDataTimeOut. - * @param authDataTimeOut time out in seconds + * @param seconds Time out for signing AuthData in seconds */ public void setSecondsAuthDataTimeOut(long seconds) { authDataTimeOut = 1000 * seconds; diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/builder/AuthenticationBlockAssertionBuilder.java b/id.server/src/at/gv/egovernment/moa/id/auth/builder/AuthenticationBlockAssertionBuilder.java index 4493333c2..60cd11ed6 100644 --- a/id.server/src/at/gv/egovernment/moa/id/auth/builder/AuthenticationBlockAssertionBuilder.java +++ b/id.server/src/at/gv/egovernment/moa/id/auth/builder/AuthenticationBlockAssertionBuilder.java @@ -76,7 +76,7 @@ public class AuthenticationBlockAssertionBuilder extends AuthenticationAssertion * element derived from the Identitylink; this is the * value of the wbPK; * maybe null if the application is a public service - * @param identiyLinkType the content of the <pr:Type> + * @param identityLinkType the content of the <pr:Type> * child element of the <pr:Identification> * element derived from the Identitylink; this includes the * URN prefix and the identification number of the business diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/builder/Builder.java b/id.server/src/at/gv/egovernment/moa/id/auth/builder/Builder.java index a5614655b..3a2ee07de 100644 --- a/id.server/src/at/gv/egovernment/moa/id/auth/builder/Builder.java +++ b/id.server/src/at/gv/egovernment/moa/id/auth/builder/Builder.java @@ -13,13 +13,13 @@ public class Builder { /** * Replaces a given number of occurences of a special tag in an XML or HTML template by a value. - * @param htmlTemplate template + * @param template html template * @param tag special tag * @param value value replacing the tag * @param expected specifies if the tag is expected to present; if true and the tag * is not present, an exception is thrown; if false and the tag is * not present, the original string is returned - * @param maxreplacements: -1 to replace each occurence of tag, or limit replacements by a given positive number + * @param maxreplacements Set -1 to replace each occurence of tag, or limit replacements by a given positive number * @return XML or HTML code, the tag replaced * @throws BuildException when template does not contain the tag */ diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/builder/CreateXMLSignatureRequestBuilder.java b/id.server/src/at/gv/egovernment/moa/id/auth/builder/CreateXMLSignatureRequestBuilder.java index 51429251e..e9a9f308d 100644 --- a/id.server/src/at/gv/egovernment/moa/id/auth/builder/CreateXMLSignatureRequestBuilder.java +++ b/id.server/src/at/gv/egovernment/moa/id/auth/builder/CreateXMLSignatureRequestBuilder.java @@ -47,7 +47,7 @@ public class CreateXMLSignatureRequestBuilder implements Constants { * Builds the <CreateXMLSignatureRequest>. * * @param authBlock String representation of XML authentication block - * @param keyBoxIdentfier the key box identifier which will be used (e.g. CertifiedKeypair) + * @param keyBoxIdentifier the key box identifier which will be used (e.g. CertifiedKeypair) * @param slVersion12 specifies whether the Security Layer version number is 1.2 or not * @return String representation of <CreateXMLSignatureRequest> */ diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/data/AuthenticationSession.java b/id.server/src/at/gv/egovernment/moa/id/auth/data/AuthenticationSession.java index 12d29ba82..90d79a46d 100644 --- a/id.server/src/at/gv/egovernment/moa/id/auth/data/AuthenticationSession.java +++ b/id.server/src/at/gv/egovernment/moa/id/auth/data/AuthenticationSession.java @@ -126,7 +126,7 @@ public class AuthenticationSession { /** * Sets the sessionID. - * @param sessionID The sessionID to set + * @param sessionId The sessionID to set */ public void setSessionID(String sessionId) { this.sessionID = sessionId; @@ -168,24 +168,24 @@ public class AuthenticationSession { * Sets the oaURLRequested. * @param oaURLRequested The oaURLRequested to set */ - public void setOAURLRequested(String url) { - this.oaURLRequested = url; + public void setOAURLRequested(String oaURLRequested) { + this.oaURLRequested = oaURLRequested; } /** * Sets the oaPublicURLPrefix - * @param url The oaPublicURLPrefix to set + * @param oaPublicURLPrefix The oaPublicURLPrefix to set */ - public void setPublicOAURLPrefix(String url) { - this.oaPublicURLPrefix = url; + public void setPublicOAURLPrefix(String oaPublicURLPrefix) { + this.oaPublicURLPrefix = oaPublicURLPrefix; } /** * Sets the bkuURL - * @param url The BKU URL to set + * @param bkuURL The BKU URL to set */ - public void setBkuURL(String url) { - this.bkuURL = url; + public void setBkuURL(String bkuURL) { + this.bkuURL = bkuURL; } /** diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/data/CreateXMLSignatureResponse.java b/id.server/src/at/gv/egovernment/moa/id/auth/data/CreateXMLSignatureResponse.java index 81945f644..d121f2c55 100644 --- a/id.server/src/at/gv/egovernment/moa/id/auth/data/CreateXMLSignatureResponse.java +++ b/id.server/src/at/gv/egovernment/moa/id/auth/data/CreateXMLSignatureResponse.java @@ -54,7 +54,7 @@ public void setSamlAssertion(Element samlAssertion) { /** * Sets the samlAttribute. - * @param samlAttribute The samlAttribute to set + * @param samlAttributes The samlAttributes to set */ public void setSamlAttributes(SAMLAttribute[] samlAttributes) { this.samlAttributes = samlAttributes; diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/data/ExtendedSAMLAttributeImpl.java b/id.server/src/at/gv/egovernment/moa/id/auth/data/ExtendedSAMLAttributeImpl.java index 9aedd86e6..27b512717 100644 --- a/id.server/src/at/gv/egovernment/moa/id/auth/data/ExtendedSAMLAttributeImpl.java +++ b/id.server/src/at/gv/egovernment/moa/id/auth/data/ExtendedSAMLAttributeImpl.java @@ -100,7 +100,7 @@ public class ExtendedSAMLAttributeImpl implements ExtendedSAMLAttribute { * {@link at.gv.egovernment.moa.id.auth.data.ExtendedSAMLAttribute#ADD_TO_AUTHBLOCK_ONLY} * * - * {@link at.gv.egovernment.moa.id.auth.data.ExtendedSAMLAttribute#ADD_TO_AUTHBLOCK) + * {@link at.gv.egovernment.moa.id.auth.data.ExtendedSAMLAttribute#ADD_TO_AUTHBLOCK} */ public void setAddToAUTHBlock(int addToAUTHBlock) { addToAUTHBlock_ = addToAUTHBlock; diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidatorParamsImpl.java b/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidatorParamsImpl.java index fcfc054d8..123d57157 100644 --- a/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidatorParamsImpl.java +++ b/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidatorParamsImpl.java @@ -190,7 +190,7 @@ public class InfoboxValidatorParamsImpl implements InfoboxValidatorParams { } /** - * @see at.gv.egovernment.moa.id.auth.data.InfoboxValidatorParams#hideStammzahl + * @see at.gv.egovernment.moa.id.auth.data.InfoboxValidatorParams#getHideStammzahl() */ public boolean getHideStammzahl() { return hideStammzahl_; @@ -334,7 +334,8 @@ public class InfoboxValidatorParamsImpl implements InfoboxValidatorParams { } /** - * Sets the {@link #hideStammzahl_} parameter. + * Sets the hideStammzahl_ parameter. This indicates whether source pins + * (Stammzahlen) must be hidden or not. * * @param hideStammzahl True if source pins (Stammzahlen) should * be hidden, otherwise false. diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/parser/CreateXMLSignatureResponseParser.java b/id.server/src/at/gv/egovernment/moa/id/auth/parser/CreateXMLSignatureResponseParser.java index 5e1df5157..a8b870f04 100644 --- a/id.server/src/at/gv/egovernment/moa/id/auth/parser/CreateXMLSignatureResponseParser.java +++ b/id.server/src/at/gv/egovernment/moa/id/auth/parser/CreateXMLSignatureResponseParser.java @@ -71,10 +71,10 @@ public class CreateXMLSignatureResponseParser { * Parses and validates the document given as stream and extracts the * root element. * - * @param xmlResponse <CreateXMLSignatureResponse> as String + * @param is <InfoboxReadResponse> as InputStream * - * @throws AuthenticationException if any authentication error occurs - * @throws ParseException if an element cannot be parsed + * @throws AuthenticationException If any authentication error occurs + * @throws ParseException If an element cannot be parsed */ public CreateXMLSignatureResponseParser(InputStream is) throws AuthenticationException, ParseException { init(is); diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/parser/ErrorResponseParser.java b/id.server/src/at/gv/egovernment/moa/id/auth/parser/ErrorResponseParser.java index 8edeec8ae..e3c54095d 100644 --- a/id.server/src/at/gv/egovernment/moa/id/auth/parser/ErrorResponseParser.java +++ b/id.server/src/at/gv/egovernment/moa/id/auth/parser/ErrorResponseParser.java @@ -62,7 +62,7 @@ public class ErrorResponseParser { /** * Returns the information included in this error response. - * @return + * @return The error infomation String */ public String getErrorInfo() { return errorInfo_ ; diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/parser/InfoboxReadResponseParser.java b/id.server/src/at/gv/egovernment/moa/id/auth/parser/InfoboxReadResponseParser.java index 0cedda28d..e59c88ddc 100644 --- a/id.server/src/at/gv/egovernment/moa/id/auth/parser/InfoboxReadResponseParser.java +++ b/id.server/src/at/gv/egovernment/moa/id/auth/parser/InfoboxReadResponseParser.java @@ -28,7 +28,8 @@ public class InfoboxReadResponseParser { * root element. * * @param xmlResponse <InfoboxReadResponse> as String - * @throws ParseException on any parsing error + * @throws ParseException If an element cannot be parsed + * @throws AuthenticationException If any authentication error occurs */ public InfoboxReadResponseParser(String xmlResponse) throws ParseException, AuthenticationException { @@ -45,8 +46,9 @@ public class InfoboxReadResponseParser { * Parses and validates the document given as stream and extracts the * root element. * - * @param xmlResponse <InfoboxReadResponse> as InputStream - * @throws ParseException on any parsing error + * @param is <InfoboxReadResponse> as InputStream + * @throws ParseException If an element cannot be parsed + * @throws AuthenticationException If any authentication error occurs */ public InfoboxReadResponseParser(InputStream is) throws ParseException, AuthenticationException { init(is); @@ -58,7 +60,7 @@ public class InfoboxReadResponseParser { * root element. * * @param is The InfoBoxReadResponse as stream. - * @throws AuthenticationException if an authentication error occurs. + * @throws AuthenticationException If an authentication error occurs. * @throws ParseException If an error occurs on parsing the the document. */ private void init(InputStream is) throws AuthenticationException, ParseException { diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/validator/CreateXMLSignatureResponseValidator.java b/id.server/src/at/gv/egovernment/moa/id/auth/validator/CreateXMLSignatureResponseValidator.java index efb33ea59..e6c9f4bee 100644 --- a/id.server/src/at/gv/egovernment/moa/id/auth/validator/CreateXMLSignatureResponseValidator.java +++ b/id.server/src/at/gv/egovernment/moa/id/auth/validator/CreateXMLSignatureResponseValidator.java @@ -51,8 +51,7 @@ public class CreateXMLSignatureResponseValidator { /** * The Method validate is used for validating an explicit {@link CreateXMLSignatureResponse} * @param createXMLSignatureResponse - * @param gbTarget - * @param oaURL + * @param session * @throws ValidateException */ public void validate(CreateXMLSignatureResponse createXMLSignatureResponse, AuthenticationSession session) diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/validator/VerifyXMLSignatureResponseValidator.java b/id.server/src/at/gv/egovernment/moa/id/auth/validator/VerifyXMLSignatureResponseValidator.java index 3f08f103c..1f2ebc37c 100644 --- a/id.server/src/at/gv/egovernment/moa/id/auth/validator/VerifyXMLSignatureResponseValidator.java +++ b/id.server/src/at/gv/egovernment/moa/id/auth/validator/VerifyXMLSignatureResponseValidator.java @@ -129,8 +129,8 @@ public class VerifyXMLSignatureResponseValidator { /** * Method validateCertificate. - * @param vsr is the VerifyXMLSignatureResponse - * @param idl + * @param verifyXMLSignatureResponse The VerifyXMLSignatureResponse + * @param idl The Identitylink * @throws ValidateException */ public void validateCertificate( diff --git a/id.server/src/at/gv/egovernment/moa/id/config/ConfigurationBuilder.java b/id.server/src/at/gv/egovernment/moa/id/config/ConfigurationBuilder.java index c4483b250..90b780526 100644 --- a/id.server/src/at/gv/egovernment/moa/id/config/ConfigurationBuilder.java +++ b/id.server/src/at/gv/egovernment/moa/id/config/ConfigurationBuilder.java @@ -220,8 +220,8 @@ public class ConfigurationBuilder { /** * Build a string array with all filenames leading * to the Transforms Information for the Security Layer - * @param businessService true if the application is a - * business application, otherwise false + * @param contextNode The node from which should be searched + * @param xpathExpr The XPATH expression for the search * @return String[] of filenames to the Security Layer Transforms Information * or null if no transforms are included */ @@ -483,15 +483,15 @@ public class ConfigurationBuilder { * the uri string from the MOA ID configuration file via the given xpath expression * and returns either this string or the default value. * - * @param oaAUTHComponent The AuthComponent element to get the template from. + * @param oaAuthComponent The AuthComponent element to get the template from. * @param xpathExpr The xpath expression for selecting the template uri. * @param defaultURL The default template url. * @return The template url. This may either the via xpath selected uri * or, if no template is specified within the online appliacation, * the default url. Both may be null. */ - protected String buildTemplateURL(Element oaAAuthComponent, String xpathExpr, String defaultURL) { - String templateURL = XPathUtils.getAttributeValue(oaAAuthComponent, xpathExpr, defaultURL); + protected String buildTemplateURL(Element oaAuthComponent, String xpathExpr, String defaultURL) { + String templateURL = XPathUtils.getAttributeValue(oaAuthComponent, xpathExpr, defaultURL); if (templateURL != null) { templateURL = FileUtils.makeAbsoluteURL(templateURL, rootConfigFileDir_); } @@ -502,7 +502,7 @@ public class ConfigurationBuilder { /** * Method buildConnectionParameter: internal Method for creating a * ConnectionParameter object with all data found in the incoming element - * @param root: this Element contains the ConnectionParameter + * @param root This Element contains the ConnectionParameter * @return ConnectionParameter */ protected ConnectionParameter buildConnectionParameter(Element root) @@ -659,7 +659,7 @@ public class ConfigurationBuilder { * * @param number The element holding the identification number of the business * company. - * @return + * @return The domain identifier */ protected String buildIdentityLinkDomainIdentifier(Element number) { if (number == null) { diff --git a/id.server/src/at/gv/egovernment/moa/id/config/OAParameter.java b/id.server/src/at/gv/egovernment/moa/id/config/OAParameter.java index b3f46c532..19a27b463 100644 --- a/id.server/src/at/gv/egovernment/moa/id/config/OAParameter.java +++ b/id.server/src/at/gv/egovernment/moa/id/config/OAParameter.java @@ -16,7 +16,7 @@ public class OAParameter { /** * specifies whether the online application is a business application or not - * (true if value of {@link oaType} is "businessService" + * (true if value of {@link #oaType} is "businessService" */ private boolean businessService; @@ -54,9 +54,9 @@ public class OAParameter { /** * * Sets the type of the online application. - * If the type is "businessService" the value of {@link businessService} is - * also set to true - * @param the type of the online application. + * If the type is "businessService" the value of businessService + * ({@link #getBusinessService()}) is also set to true + * @param oaType The type of the online application. */ public void setOaType(String oaType) { this.oaType = oaType; diff --git a/id.server/src/at/gv/egovernment/moa/id/config/auth/OAAuthParameter.java b/id.server/src/at/gv/egovernment/moa/id/config/auth/OAAuthParameter.java index abdf13dd1..ba3b61f9d 100644 --- a/id.server/src/at/gv/egovernment/moa/id/config/auth/OAAuthParameter.java +++ b/id.server/src/at/gv/egovernment/moa/id/config/auth/OAAuthParameter.java @@ -175,9 +175,9 @@ public class OAAuthParameter extends OAParameter { /** * Sets the security layer version. - * Also sets {@link slVersion12} to true if the Security Layer - * version is 1.2. - * @param the security layer version to be used. + * Also sets slVersion12 ({@link #getSlVersion12()}) + * to true if the Security Layer version is 1.2. + * @param slVersion The security layer version to be used. */ public void setSlVersion(String slVersion) { this.slVersion = slVersion; @@ -187,14 +187,14 @@ public class OAAuthParameter extends OAParameter { } /** * Sets the IdentityLinkDomainIdentifier. - * @param the IdentityLinkDomainIdentifiern number of the online application. + * @param identityLinkDomainIdentifier The IdentityLinkDomainIdentifiern number of the online application. */ public void setIdentityLinkDomainIdentifier(String identityLinkDomainIdentifier) { this.identityLinkDomainIdentifier = identityLinkDomainIdentifier; } /** * Sets the transformsInfos. - * @param the transformsInfos to be used. + * @param transformsInfos The transformsInfos to be used. */ public void setTransformsInfos(String[] transformsInfos) { this.transformsInfos = transformsInfos; diff --git a/id.server/src/at/gv/egovernment/moa/id/config/proxy/OAConfiguration.java b/id.server/src/at/gv/egovernment/moa/id/config/proxy/OAConfiguration.java index 3ec9e14fd..d25cb3b2b 100644 --- a/id.server/src/at/gv/egovernment/moa/id/config/proxy/OAConfiguration.java +++ b/id.server/src/at/gv/egovernment/moa/id/config/proxy/OAConfiguration.java @@ -108,7 +108,7 @@ public class OAConfiguration { /** * Sets the basicAuthPasswordMapping. - * @param basicAuthPasswordMapping The basicAuthPasswordMapping to set + * @param basicAuthPassword The basicAuthPasswordMapping to set */ public void setBasicAuthPasswordMapping(String basicAuthPassword) { this.basicAuthPasswordMapping = basicAuthPassword; @@ -116,7 +116,7 @@ public class OAConfiguration { /** * Sets the basicAuthUserIDMapping. - * @param basicAuthUserIDMapping The basicAuthUserIDMapping to set + * @param basicAuthUserID The basicAuthUserIDMapping to set */ public void setBasicAuthUserIDMapping(String basicAuthUserID) { this.basicAuthUserIDMapping = basicAuthUserID; @@ -124,7 +124,7 @@ public class OAConfiguration { /** * Sets the headerAuthMapping. - * @param headerAuthMapping The headerAuthMapping to set + * @param headerAuth The headerAuthMapping to set */ public void setHeaderAuthMapping(HashMap headerAuth) { this.headerAuthMapping = headerAuth; @@ -140,7 +140,7 @@ public class OAConfiguration { /** * Sets the paramAuthMapping. - * @param paramAuthMapping The paramAuthMapping to set + * @param paramAuth The paramAuthMapping to set */ public void setParamAuthMapping(HashMap paramAuth) { this.paramAuthMapping = paramAuth; @@ -156,7 +156,7 @@ public class OAConfiguration { /** * Sets the authType. - * @param authType The authType to set + * @param authLoginType The authType to set */ public void setAuthType(String authLoginType) { this.authType = authLoginType; diff --git a/id.server/src/at/gv/egovernment/moa/id/config/proxy/OAProxyParameter.java b/id.server/src/at/gv/egovernment/moa/id/config/proxy/OAProxyParameter.java index 12b16c115..83ab73dcd 100644 --- a/id.server/src/at/gv/egovernment/moa/id/config/proxy/OAProxyParameter.java +++ b/id.server/src/at/gv/egovernment/moa/id/config/proxy/OAProxyParameter.java @@ -78,24 +78,24 @@ public class OAProxyParameter extends OAParameter { } /** - * Sets the configFileURL. - * @param configFileURL The configFileURL to set + * Sets the configFileURL for the proxy. + * @param oaProxyConfigFileURL The configFileURL to set */ public void setConfigFileURL(String oaProxyConfigFileURL) { this.configFileURL = oaProxyConfigFileURL; } /** - * Sets the sessionTimeOut. - * @param sessionTimeOut The sessionTimeOut to set + * Sets the sessionTimeOut for the proxy. + * @param oaProxySessionTimeOut The sessionTimeOut to set */ public void setSessionTimeOut(int oaProxySessionTimeOut) { this.sessionTimeOut = oaProxySessionTimeOut; } /** - * Sets the connectionParameter. - * @param connectionParameter The connectionParameter to set + * Sets the connectionParameter for the proxy. + * @param proxyConnectionParameter The connectionParameter to set */ public void setConnectionParameter(ConnectionParameter proxyConnectionParameter) { this.connectionParameter = proxyConnectionParameter; @@ -142,15 +142,15 @@ public class OAProxyParameter extends OAParameter { } /** - * Sets the connectionBuilderImpl. + * Sets the connectionBuilderImpl for the proxy. * @param connectionBuilderImpl The connectionBuilderImpl to set */ - public void setConnectionBuilderImpl(String connectionBuilderImp) { - this.connectionBuilderImpl = connectionBuilderImp; + public void setConnectionBuilderImpl(String connectionBuilderImpl) { + this.connectionBuilderImpl = connectionBuilderImpl; } /** - * Sets the loginParameterResolverImpl. + * Sets the loginParameterResolverImpl for the proxy. * @param loginParameterResolverImpl The loginParameterResolverImpl to set */ public void setLoginParameterResolverImpl(String loginParameterResolverImpl) { @@ -158,8 +158,8 @@ public class OAProxyParameter extends OAParameter { } /** - * Sets the loginParameterResolverConfiguration. - * @param loginParameterResolverImpl The loginParameterResolverImpl to set + * Sets the loginParameterResolverConfiguration for the proxy. + * @param loginParameterResolverConfiguration The loginParameterResolverImpl to set */ public void setLoginParameterResolverConfiguration(String loginParameterResolverConfiguration) { this.loginParameterResolverConfiguration = loginParameterResolverConfiguration; diff --git a/id.server/src/at/gv/egovernment/moa/id/data/AuthenticationData.java b/id.server/src/at/gv/egovernment/moa/id/data/AuthenticationData.java index c1588fe22..4fc35c1e6 100644 --- a/id.server/src/at/gv/egovernment/moa/id/data/AuthenticationData.java +++ b/id.server/src/at/gv/egovernment/moa/id/data/AuthenticationData.java @@ -161,7 +161,7 @@ public class AuthenticationData { /** * Sets the publicAuthorityCode. - * @param publicAuthorityCode The publicAuthorityCode to set + * @param publicAuthorityIdentification The publicAuthorityCode to set */ public void setPublicAuthorityCode(String publicAuthorityIdentification) { this.publicAuthorityCode = publicAuthorityIdentification; @@ -299,8 +299,8 @@ public class AuthenticationData { * Sets the familyName. * @param familyName The familyName to set */ - public void setFamilyName(String gamilyName) { - this.familyName = gamilyName; + public void setFamilyName(String familyName) { + this.familyName = familyName; } /** @@ -361,7 +361,7 @@ public class AuthenticationData { /** * Sets the signer certificate - * @param url The signer certificate + * @param signerCertificate The signer certificate */ public void setSignerCertificate(String signerCertificate) { this.signerCertificate = signerCertificate; diff --git a/id.server/src/at/gv/egovernment/moa/id/data/Cookie.java b/id.server/src/at/gv/egovernment/moa/id/data/Cookie.java index 5729e54c3..6ed133c5a 100644 --- a/id.server/src/at/gv/egovernment/moa/id/data/Cookie.java +++ b/id.server/src/at/gv/egovernment/moa/id/data/Cookie.java @@ -23,7 +23,7 @@ public class Cookie { /** * Adds a Cookie from a response with response-code 401 to the cookie-pool * for sending it back to the browser / client - * @param String: the complete 'Set-Cookie' - String + * @param cookieString The complete 'Set-Cookie' - String */ public void add401(String cookieString) { @@ -50,7 +50,7 @@ public class Cookie { /** * Set a cookie that comes from the Online-Application * and save it in our "normal" cookie-pool - * @param String the complete "Set-Cookie" - String from the Online-Application + * @param value The complete "Set-Cookie" - String from the Online-Application */ public void setCookie(String value) { cookies.put(getKey(value), getValue(value)); @@ -58,7 +58,7 @@ public class Cookie { /** * Method saveOldCookies. - * @param String the complete "Set-Cookie" - String from the Online-Application + * @param value The complete "Set-Cookie" - String from the Online-Application */ public void saveOldCookies(String value) { StringTokenizer st = new StringTokenizer(value,";"); diff --git a/id.server/src/at/gv/egovernment/moa/id/data/CookieManager.java b/id.server/src/at/gv/egovernment/moa/id/data/CookieManager.java index 98f84c429..1762a52b7 100644 --- a/id.server/src/at/gv/egovernment/moa/id/data/CookieManager.java +++ b/id.server/src/at/gv/egovernment/moa/id/data/CookieManager.java @@ -27,10 +27,10 @@ public class CookieManager { /** * Save a cookie to a specified session-id - * @param String id the session id - * @param String cookie_string - the complete 'Set-Cookie' String from the OnlineApplication + * @param id The session id + * @param cookie_string The complete 'Set-Cookie' String from the OnlineApplication */ - public void saveCookie(String id,String cookie_string) + public void saveCookie(String id, String cookie_string) { getCookieWithID(id).setCookie(cookie_string); } @@ -47,8 +47,8 @@ public class CookieManager { /** * Get a Cookie-Object for a specified session-id - * @param String id the session id - * @return Cookie object containing all saved cookies for this session + * @param id The session id + * @return Cookie object containing all saved cookies for this session */ public Cookie getCookieWithID(String id) { @@ -84,8 +84,8 @@ public class CookieManager { * Adds a Cookie for a special session from a response with * response-code 401 to the cookie-pool for sending it back * to the browser / client - * @param id the session-id - * @param String: the complete 'Set-Cookie' - String + * @param id The session-id + * @param value The complete 'Set-Cookie' - String */ public void add401(String id,String value) { diff --git a/id.server/src/at/gv/egovernment/moa/id/iaik/config/RevocationConfigurationImpl.java b/id.server/src/at/gv/egovernment/moa/id/iaik/config/RevocationConfigurationImpl.java index f6c9ddcc0..fbb0af29b 100644 --- a/id.server/src/at/gv/egovernment/moa/id/iaik/config/RevocationConfigurationImpl.java +++ b/id.server/src/at/gv/egovernment/moa/id/iaik/config/RevocationConfigurationImpl.java @@ -17,7 +17,7 @@ import at.gv.egovernment.moa.id.iaik.servertools.observer.*; public class RevocationConfigurationImpl extends ObservableImpl implements RevocationConfiguration { /** - * @see iaik.pki.revocation.RevocationConfiguration#getAlternativeDistributionPoints(java.security.cert.X509Certificate, java.util.Date) + * @see iaik.pki.revocation.RevocationConfiguration#getAlternativeDistributionPoints(X509Certificate, X509Certificate, Date) */ public Set getAlternativeDistributionPoints( X509Certificate arg0, diff --git a/id.server/src/at/gv/egovernment/moa/id/iaik/servertools/observer/ObservableImpl.java b/id.server/src/at/gv/egovernment/moa/id/iaik/servertools/observer/ObservableImpl.java index 6f6949ad6..f582e9b78 100644 --- a/id.server/src/at/gv/egovernment/moa/id/iaik/servertools/observer/ObservableImpl.java +++ b/id.server/src/at/gv/egovernment/moa/id/iaik/servertools/observer/ObservableImpl.java @@ -19,21 +19,21 @@ public class ObservableImpl implements Observable { private List observers = new ArrayList(); /** - * @see iaik.servertools.observer.Observable#addObserver(iaik.servertools.observer.Observable) + * @see iaik.servertools.observer.Observable#addObserver(Observer) */ public void addObserver(Observer observer) { observers.add(observer); } /** - * @see iaik.servertools.observer.Observable#removeObserver(iaik.servertools.observer.Observable) + * @see iaik.servertools.observer.Observable#removeObserver(Observer) */ public boolean removeObserver(Observer observer) { return observers.remove(observer); } /** - * @see iaik.servertools.observer.Observable#notify(iaik.servertools.observer.NotificationData) + * @see iaik.servertools.observer.Observable#notify(NotificationData) */ public void notify(NotificationData data) { Iterator iter = observers.iterator(); diff --git a/id.server/src/at/gv/egovernment/moa/id/proxy/DefaultConnectionBuilder.java b/id.server/src/at/gv/egovernment/moa/id/proxy/DefaultConnectionBuilder.java index dbbc49870..151b1cec3 100644 --- a/id.server/src/at/gv/egovernment/moa/id/proxy/DefaultConnectionBuilder.java +++ b/id.server/src/at/gv/egovernment/moa/id/proxy/DefaultConnectionBuilder.java @@ -96,7 +96,7 @@ public class DefaultConnectionBuilder implements ConnectionBuilder { * The implementation of the Connectionbuilder decides wether * if this should be happen or not. * - * @param con the HttpURLConnection which is normaly to be closed + * @param conn the HttpURLConnection which is normaly to be closed */ public void disconnect(HttpURLConnection conn) { conn.disconnect(); diff --git a/id.server/src/at/gv/egovernment/moa/id/proxy/DefaultLoginParameterResolver.java b/id.server/src/at/gv/egovernment/moa/id/proxy/DefaultLoginParameterResolver.java index 5c2e805e7..3df76656b 100644 --- a/id.server/src/at/gv/egovernment/moa/id/proxy/DefaultLoginParameterResolver.java +++ b/id.server/src/at/gv/egovernment/moa/id/proxy/DefaultLoginParameterResolver.java @@ -32,7 +32,7 @@ public class DefaultLoginParameterResolver implements LoginParameterResolver { /** - * @see at.gv.egovernment.moa.id.proxy.LoginParameterResolver#getAuthenticationHeaders(at.gv.egovernment.moa.id.config.proxy.OAConfiguration, at.gv.egovernment.moa.id.auth.data.AuthenticationData, java.lang.String) + * @see at.gv.egovernment.moa.id.proxy.LoginParameterResolver#getAuthenticationHeaders(OAConfiguration, AuthenticationData, String, boolean, String) */ public Map getAuthenticationHeaders( OAConfiguration oaConf, @@ -70,7 +70,7 @@ public class DefaultLoginParameterResolver implements LoginParameterResolver { } /** - * @see at.gv.egovernment.moa.id.proxy.LoginParameterResolver#getAuthenticationParameters(at.gv.egovernment.moa.id.config.proxy.OAConfiguration, at.gv.egovernment.moa.id.auth.data.AuthenticationData, java.lang.String) + * @see at.gv.egovernment.moa.id.proxy.LoginParameterResolver#getAuthenticationParameters(OAConfiguration, AuthenticationData, String, boolean, String) */ public Map getAuthenticationParameters( OAConfiguration oaConf, diff --git a/id.server/src/at/gv/egovernment/moa/id/proxy/ElakConnectionBuilder.java b/id.server/src/at/gv/egovernment/moa/id/proxy/ElakConnectionBuilder.java index 476650eb0..909e2d51e 100644 --- a/id.server/src/at/gv/egovernment/moa/id/proxy/ElakConnectionBuilder.java +++ b/id.server/src/at/gv/egovernment/moa/id/proxy/ElakConnectionBuilder.java @@ -197,7 +197,7 @@ public class ElakConnectionBuilder implements ConnectionBuilder { * The implementation of the Connectionbuilder decides wether * if this should be happen or not. * - * @param con the HttpURLConnection which is normaly to be closed + * @param conn the HttpURLConnection which is normaly to be closed */ public void disconnect(HttpURLConnection conn) { conn.disconnect(); diff --git a/id.server/src/at/gv/egovernment/moa/id/proxy/EnhancedConnectionBuilder.java b/id.server/src/at/gv/egovernment/moa/id/proxy/EnhancedConnectionBuilder.java index 9d8dc694c..f934ab80b 100644 --- a/id.server/src/at/gv/egovernment/moa/id/proxy/EnhancedConnectionBuilder.java +++ b/id.server/src/at/gv/egovernment/moa/id/proxy/EnhancedConnectionBuilder.java @@ -132,7 +132,7 @@ public class EnhancedConnectionBuilder implements ConnectionBuilder { * The implementation of the Connectionbuilder decides wether * if this should be happen or not. * - * @param con the HttpURLConnection which is normaly to be closed + * @param conn the HttpURLConnection which is normaly to be closed */ public void disconnect(java.net.HttpURLConnection conn) { // In HTTPClient there must not be an diconnect! diff --git a/id.server/src/at/gv/egovernment/moa/id/proxy/XMLLoginParameterResolverEncryptedData.java b/id.server/src/at/gv/egovernment/moa/id/proxy/XMLLoginParameterResolverEncryptedData.java index 4feb1f432..9bfd9de9b 100644 --- a/id.server/src/at/gv/egovernment/moa/id/proxy/XMLLoginParameterResolverEncryptedData.java +++ b/id.server/src/at/gv/egovernment/moa/id/proxy/XMLLoginParameterResolverEncryptedData.java @@ -255,7 +255,7 @@ public class XMLLoginParameterResolverEncryptedData implements LoginParameterRes * @param plaintext * @param bPK * @param masterSecret - * @returns encrypted data (blowfish encrypted, base64 encoded) + * @return encrypted data (blowfish encrypted, base64 encoded) * @throws LoginParameterResolverException */ public String encryptData(String plaintext, String bPK, String masterSecret) throws LoginParameterResolverException @@ -291,7 +291,7 @@ public class XMLLoginParameterResolverEncryptedData implements LoginParameterRes * @param ciphertext (blowfish encrypted, base64encoded) * @param bPK * @param masterSecret - * @returns decrypted Data (plaintext) + * @return decrypted Data (plaintext) * @throws LoginParameterResolverException */ public String decryptData(String ciphertext, String bPK, String masterSecret) throws LoginParameterResolverException @@ -323,7 +323,7 @@ public class XMLLoginParameterResolverEncryptedData implements LoginParameterRes /** - * @see at.gv.egovernment.moa.id.proxy.LoginParameterResolver#getAuthenticationHeaders(at.gv.egovernment.moa.id.config.proxy.OAConfiguration, at.gv.egovernment.moa.id.auth.data.AuthenticationData, java.lang.String) + * @see at.gv.egovernment.moa.id.proxy.LoginParameterResolver#getAuthenticationHeaders(OAConfiguration, AuthenticationData, String, boolean, String) */ public Map getAuthenticationHeaders( OAConfiguration oaConf, @@ -397,7 +397,7 @@ public class XMLLoginParameterResolverEncryptedData implements LoginParameterRes } /** - * @see at.gv.egovernment.moa.id.proxy.LoginParameterResolver#getAuthenticationParameters(at.gv.egovernment.moa.id.config.proxy.OAConfiguration, at.gv.egovernment.moa.id.auth.data.AuthenticationData, java.lang.String) + * @see at.gv.egovernment.moa.id.proxy.LoginParameterResolver#getAuthenticationParameters(OAConfiguration, AuthenticationData, String, boolean, String) */ public Map getAuthenticationParameters( OAConfiguration oaConf, @@ -606,7 +606,7 @@ public class XMLLoginParameterResolverEncryptedData implements LoginParameterRes /** * searches for a given bPK and returns the appropriate LPRParams structure * @param bPK search argument - * @returns LPRParams if bPK could be found in internal mappings or null otherwise. + * @return LPRParams if bPK could be found in internal mappings or null otherwise. */ LPRParams bPKIdentitySearch(String bPK, String wType) { //search for mapping with (w)bPK of the user @@ -629,7 +629,7 @@ public class XMLLoginParameterResolverEncryptedData implements LoginParameterRes * @param surName surname search argument * @param givenName givenname search argument * @param dateOfBirth dateofbirth search argument - * @returns LPRParams if (w)bPK could be found in internal mappings or null otherwise. + * @return LPRParams if (w)bPK could be found in internal mappings or null otherwise. */ LPRParams namedIdentitySearch(String surName, String givenName, String dateOfBirth) { Logger.info("XMLLoginParameterResolver: search for login data for SurName:" + surName + " GivenName: " + givenName + " DateOfBirth" + dateOfBirth); diff --git a/id.server/src/at/gv/egovernment/moa/id/util/AxisSecureSocketFactory.java b/id.server/src/at/gv/egovernment/moa/id/util/AxisSecureSocketFactory.java index 8967bdbba..954a87e62 100644 --- a/id.server/src/at/gv/egovernment/moa/id/util/AxisSecureSocketFactory.java +++ b/id.server/src/at/gv/egovernment/moa/id/util/AxisSecureSocketFactory.java @@ -57,8 +57,7 @@ public class AxisSecureSocketFactory * Initializes the factory by setting the connection parameters to be used for * setting the secure socket factory, and by setting the system property * axis.socketSecureFactory. - * @param connParam ConnectionParameter to derive the - * secure socket factory from + * @param ssf SSLSocketFactory to initialize with */ public static void initialize(SSLSocketFactory ssf) throws IOException, GeneralSecurityException { diff --git a/id.server/src/at/gv/egovernment/moa/id/util/ECDSAKeyValueConverter.java b/id.server/src/at/gv/egovernment/moa/id/util/ECDSAKeyValueConverter.java index 2567cd739..6fb78edb7 100644 --- a/id.server/src/at/gv/egovernment/moa/id/util/ECDSAKeyValueConverter.java +++ b/id.server/src/at/gv/egovernment/moa/id/util/ECDSAKeyValueConverter.java @@ -38,8 +38,6 @@ public class ECDSAKeyValueConverter * @param keyValueElem ECDSAKeyValue Element * @return ECPublicKey encoded in PublicKey data structure * @throws Exception - * - * @author gregor karlinger */ public static PublicKey element2ECDSAPublicKey(Element keyValueElem) throws Exception { diff --git a/id.server/src/at/gv/egovernment/moa/id/util/InOrderServletRequestWrapper.java b/id.server/src/at/gv/egovernment/moa/id/util/InOrderServletRequestWrapper.java index 18fc0587e..4330133f0 100644 --- a/id.server/src/at/gv/egovernment/moa/id/util/InOrderServletRequestWrapper.java +++ b/id.server/src/at/gv/egovernment/moa/id/util/InOrderServletRequestWrapper.java @@ -251,7 +251,7 @@ public class InOrderServletRequestWrapper extends HttpServletRequestWrapper { * *

* You should only use this method when you are sure the parameter has only one value. If the parameter - * might have more than one value, use {@link #getParameterValues}. + * might have more than one value, use {@link #getParameterValues(String, int)}. * *

* If you use this method with a multivalued parameter, the value returned is equal to the first value in @@ -259,14 +259,14 @@ public class InOrderServletRequestWrapper extends HttpServletRequestWrapper { * *

* If the parameter data was sent in the request body, such as occurs with an HTTP POST request, then - * reading the body directly via {@link#getInputStream} or {@link #getReader}can interfere with the + * reading the body directly via {@link #getInputStream} or {@link #getReader}can interfere with the * execution of this method. * * @param name a String containing the name of the parameter whose value is requested * * @return a String representing the single value of the parameter * - * @see #getParameterValues + * @see #getParameterValues(String, int) * */ public final String getParameter(final String name) { @@ -280,9 +280,9 @@ public class InOrderServletRequestWrapper extends HttpServletRequestWrapper { * * @param name a String containing the name of the parameter whose value is requested * @param parameterType type of parameter - * @see at.gv.egovernment.moa.id.util.ParametersInOrderServlet#QUERY_PARAM - * and @see at.gv.egovernment.moa.id.util.ParametersInOrderServlet#BODY_PARAM - * @see getParameterValues(String name); + * @see at.gv.egovernment.moa.id.util.InOrderServletRequestWrapper#QUERY_PARAM + * and @see at.gv.egovernment.moa.id.util.InOrderServletRequestWrapper#BODY_PARAM + * @see #getParameterValues(String) * @return value of the (single) parameter or null if not availlable **/ public final String getParameter(final String name, final int parameterType) @@ -307,8 +307,8 @@ public class InOrderServletRequestWrapper extends HttpServletRequestWrapper { * * @param name a String containing the name of the parameter whose value is requested * @param parameterType type of parameter - * @see at.gv.egovernment.moa.id.util.ParametersInOrderServlet#QUERY_PARAM - * and @see at.gv.egovernment.moa.id.util.ParametersInOrderServlet#BODY_PARAM + * @see at.gv.egovernment.moa.id.util.InOrderServletRequestWrapper#QUERY_PARAM + * and @see at.gv.egovernment.moa.id.util.InOrderServletRequestWrapper#BODY_PARAM * @return an array of String objects containing the parameter's values or null * * @see #getParameter -- cgit v1.2.3