Merge pull request #54 from Ashi1993/build

Fixing javadoc issues in maven release build
wso2 · Mar 28, 2024 · 5ee70ae · 5ee70ae
2 parents 9566f11 + 71efcc3
commit 5ee70ae
Show file tree

Hide file tree

Showing 43 changed files with 295 additions and 296 deletions.
diff --git a/.../com/wso2/openbanking/accelerator/consent/extensions/admin/model/ConsentAdminHandler.java b/.../com/wso2/openbanking/accelerator/consent/extensions/admin/model/ConsentAdminHandler.java
@@ -42,21 +42,21 @@ public interface ConsentAdminHandler {
     /**
      * Method to handle the temporary retention data syncing with the retention database.
      * @param consentAdminData consentAdminData
-     * @throws ConsentException
+     * @throws ConsentException if any error occurs while syncing the retention database
      */
     public void handleTemporaryRetentionDataSyncing(ConsentAdminData consentAdminData) throws ConsentException;
 
     /**
      * Method to handle the consent status audit search.
      * @param consentAdminData consentAdminData
-     * @throws ConsentException
+     * @throws ConsentException if any error occurs while searching the consent status audit
      */
     public void handleConsentStatusAuditSearch(ConsentAdminData consentAdminData) throws ConsentException;
 
     /**
      * Method to handle the consent file search.
      * @param consentAdminData consentAdminData
-     * @throws ConsentException
+     * @throws ConsentException if any error occurs while searching the consent file
      */
     public void handleConsentFileSearch(ConsentAdminData consentAdminData) throws ConsentException;
 

diff --git a/...penbanking/accelerator/consent/extensions/authorize/impl/DefaultConsentRetrievalStep.java b/...penbanking/accelerator/consent/extensions/authorize/impl/DefaultConsentRetrievalStep.java
@@ -111,9 +111,8 @@ public void execute(ConsentData consentData, JSONObject jsonObject) throws Conse
 
     /**
      * Method to retrieve consent related data from the initiation payload.
-     * @param consentResource
+     * @param consentResource  Consent Resource
      * @return  consent
-     * @throws ConsentException
      */
     public JSONArray getConsentDataSet(ConsentResource consentResource) {
 

diff --git a/...r/consent/extensions/authorize/impl/handler/persist/AccountConsentPersistenceHandler.java b/...r/consent/extensions/authorize/impl/handler/persist/AccountConsentPersistenceHandler.java
@@ -46,7 +46,7 @@ public class AccountConsentPersistenceHandler implements ConsentPersistenceHandl
      *
      * @param consentPersistData    Consent Persist Data Object
      * @param consentResource       Consent Resource Object
-     * @throws ConsentManagementException
+     * @throws ConsentManagementException if  an error occurs while persisting the consent data
      */
     @Override
     public void consentPersist(ConsentPersistData consentPersistData, ConsentResource consentResource)

diff --git a/...rator/consent/extensions/authorize/impl/handler/persist/CofConsentPersistenceHandler.java b/...rator/consent/extensions/authorize/impl/handler/persist/CofConsentPersistenceHandler.java
@@ -48,7 +48,7 @@ public class CofConsentPersistenceHandler implements ConsentPersistenceHandler {
      *
      * @param consentPersistData    Consent Persist Data Object
      * @param consentResource       Consent Resource Object
-     * @throws ConsentManagementException
+     * @throws ConsentManagementException if an error occurs while persisting the consent data
      */
     @Override
     public void consentPersist(ConsentPersistData consentPersistData, ConsentResource consentResource)

diff --git a/...elerator/consent/extensions/authorize/impl/handler/persist/ConsentPersistenceHandler.java b/...elerator/consent/extensions/authorize/impl/handler/persist/ConsentPersistenceHandler.java
@@ -34,7 +34,7 @@ public interface ConsentPersistenceHandler {
      *
      * @param consentPersistData    Consent Persist Data Object
      * @param consentResource       Consent Resource Object
-     * @throws ConsentManagementException
+     * @throws ConsentManagementException if an error occurs while persisting the consent data
      */
     void consentPersist(ConsentPersistData consentPersistData, ConsentResource consentResource)
             throws ConsentManagementException;

diff --git a/...r/consent/extensions/authorize/impl/handler/persist/PaymentConsentPersistenceHandler.java b/...r/consent/extensions/authorize/impl/handler/persist/PaymentConsentPersistenceHandler.java
@@ -47,7 +47,7 @@ public class PaymentConsentPersistenceHandler implements ConsentPersistenceHandl
      *
      * @param consentPersistData Consent Persist Data Object
      * @param consentResource    Consent Resource Object
-     * @throws ConsentManagementException
+     * @throws ConsentManagementException  if an error occurs while persisting the consent data
      */
     @Override
     public void consentPersist(ConsentPersistData consentPersistData, ConsentResource consentResource)

diff --git a/...wso2/openbanking/accelerator/consent/extensions/authorize/utils/ConsentRetrievalUtil.java b/...wso2/openbanking/accelerator/consent/extensions/authorize/utils/ConsentRetrievalUtil.java
@@ -47,8 +47,8 @@ public class ConsentRetrievalUtil {
     /**
      * Method to extract request object from query params.
      *
-     * @param spQueryParams
-     * @return
+     * @param spQueryParams  Query params
+     * @return  requestObject
      */
     public static String extractRequestObject(String spQueryParams) {
 
@@ -71,8 +71,8 @@ public static String extractRequestObject(String spQueryParams) {
     /**
      * Method to validate the request object and extract consent ID.
      *
-     * @param requestObject
-     * @return
+     * @param requestObject  Request object
+     * @return consentId
      */
     public static String extractConsentId(String requestObject) {
 
@@ -193,8 +193,8 @@ public static void populateDebtorAccount(JSONObject initiation, JSONArray consen
     /**
      * Method to add debtor account details to consent data to send it to the consent page.
      *
-     * @param initiation
-     * @param consentDataJSON
+     * @param initiation     Initiation object from the request
+     * @param consentDataJSON  Consent information object
      */
     public static void populateCreditorAccount(JSONObject initiation, JSONArray consentDataJSON) {
         if (initiation.get(ConsentExtensionConstants.CREDITOR_ACC) != null) {

diff --git a/...java/com/wso2/openbanking/accelerator/consent/extensions/authservlet/impl/util/Utils.java b/...java/com/wso2/openbanking/accelerator/consent/extensions/authservlet/impl/util/Utils.java
@@ -47,9 +47,9 @@ public class Utils {
      * To get the property value for the given key from the ResourceBundle.
      * Retrieve the value of property entry for key, return key if a value is not found for key
      *
-     * @param resourceBundle
-     * @param key
-     * @return
+     * @param resourceBundle  ResourceBundle
+     * @param key  Key
+     * @return  Value of the property entry for key
      */
     public static String i18n(ResourceBundle resourceBundle, String key) {
 
@@ -66,8 +66,8 @@ public static String i18n(ResourceBundle resourceBundle, String key) {
     /**
      * Split claims based on a deliminator and create map of claimID and displayName.
      *
-     * @param requestedClaimList
-     * @return
+     * @param requestedClaimList   Requested claim list
+     * @return  List of claims
      */
     public static List<Map<String, String>> splitClaims(String[] requestedClaimList) {
 
@@ -88,9 +88,9 @@ public static List<Map<String, String>> splitClaims(String[] requestedClaimList)
     /**
      * Method to populate accounts data to be sent to consent page.
      *
-     * @param request
-     * @param dataSet
-     * @return
+     * @param request  HttpServletRequest
+     * @param dataSet  Request payload JSONObject
+     * @return  Map of Accounts data
      */
     public static Map<String, Object> populateAccountsData(HttpServletRequest request, JSONObject dataSet) {
 
@@ -124,9 +124,9 @@ public static Map<String, Object> populateAccountsData(HttpServletRequest reques
     /**
      * Method to populate payments data to be sent to consent page.
      *
-     * @param request
-     * @param dataSet
-     * @return
+     * @param request  HttpServletRequest
+     * @param dataSet  Request payload JSONObject
+     * @return Map of Payments data
      */
     public static Map<String, Object> populatePaymentsData(HttpServletRequest request, JSONObject dataSet) {
 
@@ -167,9 +167,9 @@ public static Map<String, Object> populatePaymentsData(HttpServletRequest reques
     /**
      * Method to populate Confirmation of Funds data to be sent to consent page.
      *
-     * @param httpServletRequest
-     * @param dataSet
-     * @return
+     * @param httpServletRequest  HttpServletRequest
+     * @param dataSet  Request payload JSONObject
+     * @return  Map of Confirmation of Funds data
      */
     public static Map<String, Object> populateCoFData(HttpServletRequest httpServletRequest, JSONObject dataSet) {
 
@@ -208,7 +208,7 @@ public static Map<String, Object> populateCoFData(HttpServletRequest httpServlet
      * Method to retrieve debtor account from consent data object.
      *
      * @param consentDataObject Object containing consent related data
-     * @return
+     * @return Debtor account
      */
     public static String getDebtorAccFromConsentData(JSONArray consentDataObject) {
 
@@ -253,9 +253,9 @@ private static List<Map<String, String>>  addAccList (JSONObject dataSet) {
     /**
      * Method to populate vrp data to be sent to consent page.
      *
-     * @param request
-     * @param dataSet
-     * @return
+     * @param request  HttpServletRequest
+     * @param dataSet  Request payload JSONObject
+     * @return  Map of VRP data
      */
     public static Map<String, Object> populateVRPDataRetrieval(HttpServletRequest request, JSONObject dataSet) {
 

diff --git a/.../openbanking/accelerator/consent/extensions/ciba/authenticator/CIBAPushAuthenticator.java b/.../openbanking/accelerator/consent/extensions/ciba/authenticator/CIBAPushAuthenticator.java
@@ -127,7 +127,7 @@ public static synchronized void initializeConsentSteps() {
      *
      * @param consentData Consent Data
      * @param jsonObject Json object to store consent data
-     * @throws ConsentException
+     * @throws ConsentException when an error occurs while executing retrieval steps
      */
     protected void executeRetrieval(ConsentData consentData, JSONObject jsonObject) throws ConsentException {
 
@@ -146,7 +146,7 @@ protected void executeRetrieval(ConsentData consentData, JSONObject jsonObject)
      * @param response HTTP response
      * @param sessionDataKey Session data key
      * @return Consent data
-     * @throws ConsentException
+     * @throws ConsentException when an error occurs while retrieving consent
      */
     protected JSONObject retrieveConsent(HttpServletRequest request, HttpServletResponse response,
                                   String sessionDataKey) throws ConsentException {
@@ -256,9 +256,9 @@ protected AuthenticationContext getAutenticationContext(String sessionDataKey) {
 
     /**
      * OB specific implementation to retrieve consent data.
-     * @param sessionDataKey
+     * @param sessionDataKey Session data key
      * @return consent data
-     * @throws AuthenticationFailedException
+     * @throws AuthenticationFailedException  Authentication failed exception
      */
     @Override
     protected Optional<String> getAdditionalInfo(HttpServletRequest request, HttpServletResponse response,
@@ -324,6 +324,7 @@ protected void handlePreConsent(AuthenticationContext context, Map<String, Strin
      * Returns a map of query parameters from the given query param string.
      * @param queryParamsString HTTP request query parameters
      * @return Query parameter map
+     * @throws UnsupportedEncodingException  Unsupported encoding exception
      */
     protected Map<String, String> splitQuery(String queryParamsString) throws UnsupportedEncodingException {
         final Map<String, String> queryParams = new HashMap<>();
@@ -345,6 +346,7 @@ protected Map<String, String> splitQuery(String queryParamsString) throws Unsupp
      * @param httpStatusCode   Http status code
      * @param errorCode        Error code
      * @param errorDescription Error description
+     * @return CIBAAuthenticationEndpointErrorResponse  CIBA Authentication Endpoint Error Response
      */
     public static CIBAAuthenticationEndpointErrorResponse createErrorResponse(int httpStatusCode, String errorCode,
                                                                               String errorDescription) {

diff --git a/...c/main/java/com/wso2/openbanking/accelerator/consent/extensions/common/AuthErrorCode.java b/...c/main/java/com/wso2/openbanking/accelerator/consent/extensions/common/AuthErrorCode.java
@@ -24,82 +24,75 @@
 public enum AuthErrorCode {
 
     /**
-     * invalid_request, see {@link <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1">
-     * OAuth 2.0</a>}.
+     * invalid_request, see <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1">...</a>
      */
     INVALID_REQUEST("invalid_request"),
     /**
-     * unauthorized_client, see {@link <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1">
-     * OAuth 2.0</a>}.
+     * unauthorized_client, see <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1">...</a>
      */
     UNAUTHORIZED_CLIENT("unauthorized_client"),
     /**
-     * access_denied, see {@link <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1">
-     * OAuth 2.0</a>}.
+     * access_denied, see <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1">...</a>
      */
     ACCESS_DENIED("access_denied"),
     /**
-     * unsupported_response_type, see {@link <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1">
-     * OAuth 2.0</a>}.
+     * unsupported_response_type, see <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1">...</a>
      */
     UNSUPPORTED_RESPONSE_TYPE("unsupported_response_type"),
     /**
-     * invalid_scope, see {@link <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1">
-     * OAuth 2.0</a>}.
+     * invalid_scope, see <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1">...</a>
      */
     INVALID_SCOPE("invalid_scope"),
     /**
-     * server_error, see {@link <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1">
-     * OAuth 2.0</a>}.
+     * server_error, see <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1">...</a>
      */
     SERVER_ERROR("server_error"),
     /**
-     * temporarily_unavailable, see {@link <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1">
-     * OAuth 2.0</a>}.
+     * temporarily_unavailable, see <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1">...</a>
      */
     TEMPORARILY_UNAVAILABLE("temporarily_unavailable"),
     /**
-     * interaction_required, see {@link <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
+     * interaction_required, see <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
      * OpenID Connect Core 1.0</a>}.
      */
     INTERACTION_REQUIRED("interaction_required"),
     /**
-     * login_required, see {@link <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
+     * login_required, see <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
      * OpenID Connect Core 1.0</a>}.
      */
     LOGIN_REQUIRED("login_required"),
     /**
-     * account_selection_required, see {@link <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
+     * account_selection_required, see <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
      * OpenID Connect Core 1.0</a>}.
      */
     ACCOUNT_SELECTION_REQUIRED("account_selection_required"),
     /**
-     * consent_required, see {@link <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
+     * consent_required, see <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
      * OpenID Connect Core 1.0</a>}.
      */
     CONSENT_REQUIRED("consent_required"),
     /**
-     * invalid_request_uri, see {@link <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
+     * invalid_request_uri, see <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
      * OpenID Connect Core 1.0</a>}.
      */
     INVALID_REQUEST_URI("invalid_request_uri"),
     /**
-     * invalid_request_object, see {@link <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
+     * invalid_request_object, see <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
      * OpenID Connect Core 1.0</a>}.
      */
     INVALID_REQUEST_OBJECT("invalid_request_object"),
     /**
-     * request_not_supported, see {@link <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
+     * request_not_supported, see <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
      * OpenID Connect Core 1.0</a>}.
      */
     REQUEST_NOT_SUPPORTED("request_not_supported"),
     /**
-     * request_uri_not_supported, see {@link <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
+     * request_uri_not_supported, see <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
      * OpenID Connect Core 1.0</a>}.
      */
     REQUEST_URI_NOT_SUPPORTED("request_uri_not_supported"),
     /**
-     * registration_not_supported, see {@link <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
+     * registration_not_supported, see <a href="https://openid.net/specs/openid-connect-core-1_0.html#AuthError">
      * OpenID Connect Core 1.0</a>}.
      */
     REGISTRATION_NOT_SUPPORTED("registration_not_supported");

diff --git a/...rc/main/java/com/wso2/openbanking/accelerator/consent/extensions/common/ConsentCache.java b/...rc/main/java/com/wso2/openbanking/accelerator/consent/extensions/common/ConsentCache.java
@@ -77,6 +77,7 @@ public static IdentityCache getInstance() {
      * Add consent data to consent data cache.
      * @param sessionDataKey session data key
      * @param consentData consent data
+     * @throws ConsentManagementException if an error occurs while adding consent data to cache
      */
     public static void addConsentDataToCache(String sessionDataKey, ConsentData consentData)
             throws ConsentManagementException {
@@ -91,6 +92,7 @@ public static void addConsentDataToCache(String sessionDataKey, ConsentData cons
      * Add consent data to database.
      * @param sessionDataKey session data key
      * @param consentData consent data
+     * @throws ConsentManagementException if an error occurs while storing consent data
      */
     public static void storeConsent(ConsentData consentData, String sessionDataKey) throws ConsentManagementException {
 

diff --git a/...ava/com/wso2/openbanking/accelerator/consent/extensions/common/ConsentExtensionUtils.java b/...ava/com/wso2/openbanking/accelerator/consent/extensions/common/ConsentExtensionUtils.java
@@ -226,9 +226,9 @@ public static Map<String, Serializable> getSensitiveData(String key) {
 
     /**
      * @param consentDetails json object of consent data
-     * @param sessionDataKey
-     * @return
-     * @throws URISyntaxException
+     * @param sessionDataKey  session data key
+     * @return  ConsentData object
+     * @throws URISyntaxException  if the URI is invalid
      */
     public static ConsentData getConsentDataFromAttributes(JsonObject consentDetails, String sessionDataKey)
             throws URISyntaxException {
@@ -312,6 +312,8 @@ public static boolean isRequestAcceptedPastElapsedTime() {
     /**
      * Returns the DateTime by adding given number of days and the with the given Time.
      *
+     * @param daysToAdd Number of days to add
+     * @param time      Time to add
      * @return DateTime value for the day
      */
     public static String constructDateTime(long daysToAdd, String time) {
@@ -330,6 +332,7 @@ public static String constructDateTime(long daysToAdd, String time) {
      * Validates whether Cutoffdatetime is enabled, if the request is arriving past the cut off date and if it
      * should be rejected by policy.
      *
+     * @param timeStamp Initiation timestamp
      * @return if the request should be rejected, or not.
      */
     public static boolean shouldSubmissionRequestBeRejected(String timeStamp) {
@@ -377,8 +380,8 @@ public static String getCurrentCutOffDateTime() {
     }
     /**
      * Convert long date values to ISO 8601 format.
-     * @param dateValue
-     * @return
+     * @param dateValue  Date value in long
+     * @return ISO 8601 formatted date
      */
     public static String convertToISO8601(long dateValue) {