This is a functional interface * whose functional method is {@link #getId()}. * - * @author Werner KEIL - * @version 0.4 $Date: 2016/01/04 $ - * @see {@link Identifiable} + * @author Werner Keil + * @version 1.0 $Date: 2020/11/29 $ + * @see Identifiable */ public interface IntIdentifiable extends Serializable { /** diff --git a/agorava-core-api/src/main/java/org/agorava/api/function/LongIdentifiable.java b/agorava-core-api/src/main/java/org/agorava/api/function/LongIdentifiable.java index b934600..084ded4 100644 --- a/agorava-core-api/src/main/java/org/agorava/api/function/LongIdentifiable.java +++ b/agorava-core-api/src/main/java/org/agorava/api/function/LongIdentifiable.java @@ -1,5 +1,5 @@ /* - * Copyright 2016 Agorava + * Copyright 2016-2020 Agorava * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -24,9 +24,9 @@ *
This is a functional interface * whose functional method is {@link #getId()}. * - * @author Werner KEIL - * @version 1.0.0 $Date: 2016/03/04 $ - * @see {@link Identifiable} + * @author Werner Keil + * @version 1.1 $Date: 2020/11/29 $ + * @see Identifiable */ public interface LongIdentifiable { /** diff --git a/agorava-core-api/src/main/java/org/agorava/api/oauth/application/OAuthAppSettingsBuilder.java b/agorava-core-api/src/main/java/org/agorava/api/oauth/application/OAuthAppSettingsBuilder.java index bc90f4f..9923149 100644 --- a/agorava-core-api/src/main/java/org/agorava/api/oauth/application/OAuthAppSettingsBuilder.java +++ b/agorava-core-api/src/main/java/org/agorava/api/oauth/application/OAuthAppSettingsBuilder.java @@ -1,5 +1,5 @@ /* - * Copyright 2013 Agorava + * Copyright 2013-2020 Agorava * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,11 +21,12 @@ /** * Builder for an {@link OAuthAppSettings} can be initialized directly from * fields name or from an Array of {@link Param} in case of Annotation configuration with {@link OAuthApplication}. - *
+ ** For this last purpose, the interface {@link OAuthAppSettingsBuilder} contains constants * for fields name should the configuration being read from a text file. * * @author Antoine Sabot-Durand + * @author Werner Keil */ public interface OAuthAppSettingsBuilder { diff --git a/agorava-core-api/src/main/java/org/agorava/api/rest/HttpParameters.java b/agorava-core-api/src/main/java/org/agorava/api/rest/HttpParameters.java index 98f2402..3886081 100644 --- a/agorava-core-api/src/main/java/org/agorava/api/rest/HttpParameters.java +++ b/agorava-core-api/src/main/java/org/agorava/api/rest/HttpParameters.java @@ -67,7 +67,7 @@ public interface HttpParameters { /** * @return the parameter list converted in OAuth 1.0a base string (the string to sign) - * @see the oauth spec for more info on this. + * @see the Oauth spec for more info. */ String asOauthBaseString(); diff --git a/agorava-core-api/src/main/java/org/agorava/api/service/SignatureType.java b/agorava-core-api/src/main/java/org/agorava/api/service/SignatureType.java index a07ce34..4b46743 100644 --- a/agorava-core-api/src/main/java/org/agorava/api/service/SignatureType.java +++ b/agorava-core-api/src/main/java/org/agorava/api/service/SignatureType.java @@ -1,5 +1,5 @@ /* - * Copyright 2013 Agorava + * Copyright 2013-2020 Agorava * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -31,6 +31,7 @@ * Qualifier to distinguish different {@link org.agorava.api.service.SignatureService} implementations * * @author Antoine Sabot-Durand + * @author Werner Keil */ @Qualifier @Target({TYPE, METHOD, PARAMETER, FIELD}) @@ -63,7 +64,7 @@ enum Type { /** * For signature based on RSA-SHA1 * - * @see w3c documentation on RSA SHA1 + * @see w3c documentation on RSA SHA1 */ RSASHA1, diff --git a/agorava-core-api/src/main/java/org/agorava/api/service/TimestampService.java b/agorava-core-api/src/main/java/org/agorava/api/service/TimestampService.java index f1fa33e..d00533c 100644 --- a/agorava-core-api/src/main/java/org/agorava/api/service/TimestampService.java +++ b/agorava-core-api/src/main/java/org/agorava/api/service/TimestampService.java @@ -1,5 +1,5 @@ /* - * Copyright 2013 Agorava + * Copyright 2013-2020 Agorava * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,11 +18,12 @@ /** * Unix epoch timestamp generator. - *
+ ** This class is useful for stubbing in tests. * * @author Pablo Fernandez * @author Antoine Sabot-Durand + * @author Werner Keil */ public interface TimestampService { /** diff --git a/agorava-core-api/src/main/java/org/agorava/spi/ProviderApiService.java b/agorava-core-api/src/main/java/org/agorava/spi/ProviderApiService.java index 1401b8a..48517a0 100644 --- a/agorava-core-api/src/main/java/org/agorava/spi/ProviderApiService.java +++ b/agorava-core-api/src/main/java/org/agorava/spi/ProviderApiService.java @@ -28,7 +28,7 @@ /** * Abstract base class for all Provider high level REST API calls. - *
+ ** Concrete class must implement some or API of the remote service * * @author Antoine Sabot-Durand diff --git a/agorava-core-api/src/main/java/org/agorava/spi/ProviderConfigOauth10a.java b/agorava-core-api/src/main/java/org/agorava/spi/ProviderConfigOauth10a.java index b71ba4c..3f4034b 100644 --- a/agorava-core-api/src/main/java/org/agorava/spi/ProviderConfigOauth10a.java +++ b/agorava-core-api/src/main/java/org/agorava/spi/ProviderConfigOauth10a.java @@ -36,13 +36,13 @@ /** * Default Provider configuration implementing the OAuth protocol, version 1.0a - *
+ ** This class is meant to be extended by concrete implementations of the Provider configuration, * providing the endpoints and endpoint-http-verbs. - *
+ ** If your Api adheres to the 1.0a protocol correctly, you just need to extend * this class and define the getters for your endpoints. - *
+ ** If your Api does something a bit different, you can override the different * extractors or services, in order to fine-tune the process. * diff --git a/agorava-core-api/src/main/java/org/agorava/spi/ProviderConfigOauth20.java b/agorava-core-api/src/main/java/org/agorava/spi/ProviderConfigOauth20.java index 0b71686..f976b30 100644 --- a/agorava-core-api/src/main/java/org/agorava/spi/ProviderConfigOauth20.java +++ b/agorava-core-api/src/main/java/org/agorava/spi/ProviderConfigOauth20.java @@ -28,13 +28,13 @@ /** * Default Provider configuration implementing the OAuth protocol, version 2.0 (draft 11) - *
+ ** This class is meant to be extended by concrete implementations of the API, * providing the endpoints and endpoint-http-verbs. - *
+ ** If your Api adheres to the 2.0 (draft 11) protocol correctly, you just need to extend * this class and define the getters for your endpoints. - *
+ ** If your Api does something a bit different, you can override the different * extractors or services, in order to fine-tune the process. * diff --git a/agorava-core-api/src/main/java/org/agorava/spi/ProviderConfigOauth20Final.java b/agorava-core-api/src/main/java/org/agorava/spi/ProviderConfigOauth20Final.java index 09f4d76..5485176 100644 --- a/agorava-core-api/src/main/java/org/agorava/spi/ProviderConfigOauth20Final.java +++ b/agorava-core-api/src/main/java/org/agorava/spi/ProviderConfigOauth20Final.java @@ -27,13 +27,13 @@ /** * Default Provider configuration implementing the OAuth protocol, version 2.0 final - *
+ ** This class is meant to be extended by concrete implementations of the API, * providing the endpoints and endpoint-http-verbs. - *
+ ** If your Api adheres to the 2.0 final protocol correctly, you just need to extend * this class and define the getters for your endpoints. - *
+ *
* If your Api does something a bit different, you can override the different
* extractors or services, in order to fine-tune the process.
*
diff --git a/agorava-core-impl-cdi/pom.xml b/agorava-core-impl-cdi/pom.xml
index 0e274fb..40b7e4a 100644
--- a/agorava-core-impl-cdi/pom.xml
+++ b/agorava-core-impl-cdi/pom.xml
@@ -1,7 +1,7 @@
-