From 63b1f97ba3402810a351c6ffda859b1a1b40f47d Mon Sep 17 00:00:00 2001 From: Zvone Gazvoda Date: Mon, 11 Sep 2017 10:30:09 +0200 Subject: [PATCH] Added Javadoc. --- .../com/kumuluz/ee/cors/CorsExtension.java | 23 ++++++++++++++++ .../ee/cors/annotations/CrossOrigin.java | 25 +++++++++++++++++- .../kumuluz/ee/cors/config/CorsConfig.java | 25 +++++++++++++++++- .../ee/cors/config/CorsRegistration.java | 25 +++++++++++++++++- .../ee/cors/filters/DynamicCorsFilter.java | 25 +++++++++++++++++- .../JaxRsCrossOriginAnnotationProcessor.java | 26 +++++++++++++++++-- ...ServletCrossOriginAnnotationProcessor.java | 26 +++++++++++++++++-- .../cors/utils/AnnotationProcessorUtil.java | 25 +++++++++++++++++- .../kumuluz/ee/cors/utils/CorsConfigUtil.java | 25 +++++++++++++++++- .../CrossOriginAnnotationProcessorUtil.java | 25 +++++++++++++++++- ...xRsCrossOriginAnnotationProcessorUtil.java | 25 +++++++++++++++++- ...letCrossOriginAnnotationProcessorUtil.java | 25 +++++++++++++++++- 12 files changed, 287 insertions(+), 13 deletions(-) diff --git a/src/main/java/com/kumuluz/ee/cors/CorsExtension.java b/src/main/java/com/kumuluz/ee/cors/CorsExtension.java index 2ba387b..5fb3f11 100644 --- a/src/main/java/com/kumuluz/ee/cors/CorsExtension.java +++ b/src/main/java/com/kumuluz/ee/cors/CorsExtension.java @@ -1,3 +1,23 @@ +/* + * Copyright (c) 2014-2017 Kumuluz and/or its affiliates + * and other contributors as indicated by the @author tags and + * the contributor list. + * + * Licensed under the MIT License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/MIT + * + * The software is provided "AS IS", WITHOUT WARRANTY OF ANY KIND, express or + * implied, including but not limited to the warranties of merchantability, + * fitness for a particular purpose and noninfringement. in no event shall the + * authors or copyright holders be liable for any claim, damages or other + * liability, whether in an action of contract, tort or otherwise, arising from, + * out of or in connection with the software or the use or other dealings in the + * software. See the License for the specific language governing permissions and + * limitations under the License. + */ package com.kumuluz.ee.cors; import com.kumuluz.ee.common.Extension; @@ -21,7 +41,10 @@ import java.util.logging.Logger; /** + * CorsExtension class. + * * @author Zvone Gazvoda + * @since 1.0.0 */ @EeExtensionDef(name = "Cors", group = EeExtensionGroup.CORS) @EeComponentDependencies({@EeComponentDependency(EeComponentType.SERVLET)}) diff --git a/src/main/java/com/kumuluz/ee/cors/annotations/CrossOrigin.java b/src/main/java/com/kumuluz/ee/cors/annotations/CrossOrigin.java index 8a1b284..4f05edf 100644 --- a/src/main/java/com/kumuluz/ee/cors/annotations/CrossOrigin.java +++ b/src/main/java/com/kumuluz/ee/cors/annotations/CrossOrigin.java @@ -1,3 +1,23 @@ +/* + * Copyright (c) 2014-2017 Kumuluz and/or its affiliates + * and other contributors as indicated by the @author tags and + * the contributor list. + * + * Licensed under the MIT License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/MIT + * + * The software is provided "AS IS", WITHOUT WARRANTY OF ANY KIND, express or + * implied, including but not limited to the warranties of merchantability, + * fitness for a particular purpose and noninfringement. in no event shall the + * authors or copyright holders be liable for any claim, damages or other + * liability, whether in an action of contract, tort or otherwise, arising from, + * out of or in connection with the software or the use or other dealings in the + * software. See the License for the specific language governing permissions and + * limitations under the License. + */ package com.kumuluz.ee.cors.annotations; import java.lang.annotation.ElementType; @@ -6,7 +26,10 @@ import java.lang.annotation.Target; /** - * Created by zvoneg on 26/07/17. + * CrossOrigin annotation definition. + * + * @author Zvone Gazvoda + * @since 1.0.0 */ @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) diff --git a/src/main/java/com/kumuluz/ee/cors/config/CorsConfig.java b/src/main/java/com/kumuluz/ee/cors/config/CorsConfig.java index 73a69e9..b47fd9a 100644 --- a/src/main/java/com/kumuluz/ee/cors/config/CorsConfig.java +++ b/src/main/java/com/kumuluz/ee/cors/config/CorsConfig.java @@ -1,7 +1,30 @@ +/* + * Copyright (c) 2014-2017 Kumuluz and/or its affiliates + * and other contributors as indicated by the @author tags and + * the contributor list. + * + * Licensed under the MIT License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/MIT + * + * The software is provided "AS IS", WITHOUT WARRANTY OF ANY KIND, express or + * implied, including but not limited to the warranties of merchantability, + * fitness for a particular purpose and noninfringement. in no event shall the + * authors or copyright holders be liable for any claim, damages or other + * liability, whether in an action of contract, tort or otherwise, arising from, + * out of or in connection with the software or the use or other dealings in the + * software. See the License for the specific language governing permissions and + * limitations under the License. + */ package com.kumuluz.ee.cors.config; /** - * Created by zvoneg on 24/07/17. + * CorsConfig class. + * + * @author Zvone Gazvoda + * @since 1.0.0 */ public class CorsConfig { diff --git a/src/main/java/com/kumuluz/ee/cors/config/CorsRegistration.java b/src/main/java/com/kumuluz/ee/cors/config/CorsRegistration.java index 2f4b03e..3fb05f5 100644 --- a/src/main/java/com/kumuluz/ee/cors/config/CorsRegistration.java +++ b/src/main/java/com/kumuluz/ee/cors/config/CorsRegistration.java @@ -1,7 +1,30 @@ +/* + * Copyright (c) 2014-2017 Kumuluz and/or its affiliates + * and other contributors as indicated by the @author tags and + * the contributor list. + * + * Licensed under the MIT License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/MIT + * + * The software is provided "AS IS", WITHOUT WARRANTY OF ANY KIND, express or + * implied, including but not limited to the warranties of merchantability, + * fitness for a particular purpose and noninfringement. in no event shall the + * authors or copyright holders be liable for any claim, damages or other + * liability, whether in an action of contract, tort or otherwise, arising from, + * out of or in connection with the software or the use or other dealings in the + * software. See the License for the specific language governing permissions and + * limitations under the License. + */ package com.kumuluz.ee.cors.config; /** - * Created by zvoneg on 27/07/17. + * CorsRegistration class. + * + * @author Zvone Gazvoda + * @since 1.0.0 */ public class CorsRegistration { diff --git a/src/main/java/com/kumuluz/ee/cors/filters/DynamicCorsFilter.java b/src/main/java/com/kumuluz/ee/cors/filters/DynamicCorsFilter.java index 783a0b1..c3930af 100644 --- a/src/main/java/com/kumuluz/ee/cors/filters/DynamicCorsFilter.java +++ b/src/main/java/com/kumuluz/ee/cors/filters/DynamicCorsFilter.java @@ -1,3 +1,23 @@ +/* + * Copyright (c) 2014-2017 Kumuluz and/or its affiliates + * and other contributors as indicated by the @author tags and + * the contributor list. + * + * Licensed under the MIT License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/MIT + * + * The software is provided "AS IS", WITHOUT WARRANTY OF ANY KIND, express or + * implied, including but not limited to the warranties of merchantability, + * fitness for a particular purpose and noninfringement. in no event shall the + * authors or copyright holders be liable for any claim, damages or other + * liability, whether in an action of contract, tort or otherwise, arising from, + * out of or in connection with the software or the use or other dealings in the + * software. See the License for the specific language governing permissions and + * limitations under the License. + */ package com.kumuluz.ee.cors.filters; import com.kumuluz.ee.cors.config.CorsConfig; @@ -17,7 +37,10 @@ import java.util.logging.Logger; /** - * Created by zvoneg on 27/07/17. + * DynamicCorsFilter class. + * + * @author Zvone Gazvoda + * @since 1.0.0 */ public class DynamicCorsFilter implements Filter { diff --git a/src/main/java/com/kumuluz/ee/cors/processor/JaxRsCrossOriginAnnotationProcessor.java b/src/main/java/com/kumuluz/ee/cors/processor/JaxRsCrossOriginAnnotationProcessor.java index 07f00b7..a4a702e 100644 --- a/src/main/java/com/kumuluz/ee/cors/processor/JaxRsCrossOriginAnnotationProcessor.java +++ b/src/main/java/com/kumuluz/ee/cors/processor/JaxRsCrossOriginAnnotationProcessor.java @@ -1,3 +1,23 @@ +/* + * Copyright (c) 2014-2017 Kumuluz and/or its affiliates + * and other contributors as indicated by the @author tags and + * the contributor list. + * + * Licensed under the MIT License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/MIT + * + * The software is provided "AS IS", WITHOUT WARRANTY OF ANY KIND, express or + * implied, including but not limited to the warranties of merchantability, + * fitness for a particular purpose and noninfringement. in no event shall the + * authors or copyright holders be liable for any claim, damages or other + * liability, whether in an action of contract, tort or otherwise, arising from, + * out of or in connection with the software or the use or other dealings in the + * software. See the License for the specific language governing permissions and + * limitations under the License. + */ package com.kumuluz.ee.cors.processor; import com.kumuluz.ee.cors.annotations.CrossOrigin; @@ -21,9 +41,11 @@ import java.util.logging.Logger; /** - * Created by zvoneg on 27/07/17. + * JaxRsCrossOriginAnnotationProcessor class. + * + * @author Zvone Gazvoda + * @since 1.0.0 */ - public class JaxRsCrossOriginAnnotationProcessor extends AbstractProcessor { private static final Logger LOG = Logger.getLogger(JaxRsCrossOriginAnnotationProcessor.class.getName()); diff --git a/src/main/java/com/kumuluz/ee/cors/processor/ServletCrossOriginAnnotationProcessor.java b/src/main/java/com/kumuluz/ee/cors/processor/ServletCrossOriginAnnotationProcessor.java index 4ccca95..6e1edd8 100644 --- a/src/main/java/com/kumuluz/ee/cors/processor/ServletCrossOriginAnnotationProcessor.java +++ b/src/main/java/com/kumuluz/ee/cors/processor/ServletCrossOriginAnnotationProcessor.java @@ -1,3 +1,23 @@ +/* + * Copyright (c) 2014-2017 Kumuluz and/or its affiliates + * and other contributors as indicated by the @author tags and + * the contributor list. + * + * Licensed under the MIT License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/MIT + * + * The software is provided "AS IS", WITHOUT WARRANTY OF ANY KIND, express or + * implied, including but not limited to the warranties of merchantability, + * fitness for a particular purpose and noninfringement. in no event shall the + * authors or copyright holders be liable for any claim, damages or other + * liability, whether in an action of contract, tort or otherwise, arising from, + * out of or in connection with the software or the use or other dealings in the + * software. See the License for the specific language governing permissions and + * limitations under the License. + */ package com.kumuluz.ee.cors.processor; import com.kumuluz.ee.cors.annotations.CrossOrigin; @@ -19,9 +39,11 @@ import java.util.logging.Logger; /** - * Created by zvoneg on 27/07/17. + * ServletCrossOriginAnnotationProcessor class. + * + * @author Zvone Gazvoda + * @since 1.0.0 */ - public class ServletCrossOriginAnnotationProcessor extends AbstractProcessor { private static final Logger LOG = Logger.getLogger(ServletCrossOriginAnnotationProcessor.class.getName()); diff --git a/src/main/java/com/kumuluz/ee/cors/utils/AnnotationProcessorUtil.java b/src/main/java/com/kumuluz/ee/cors/utils/AnnotationProcessorUtil.java index fe45cc6..a720c4c 100644 --- a/src/main/java/com/kumuluz/ee/cors/utils/AnnotationProcessorUtil.java +++ b/src/main/java/com/kumuluz/ee/cors/utils/AnnotationProcessorUtil.java @@ -1,3 +1,23 @@ +/* + * Copyright (c) 2014-2017 Kumuluz and/or its affiliates + * and other contributors as indicated by the @author tags and + * the contributor list. + * + * Licensed under the MIT License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/MIT + * + * The software is provided "AS IS", WITHOUT WARRANTY OF ANY KIND, express or + * implied, including but not limited to the warranties of merchantability, + * fitness for a particular purpose and noninfringement. in no event shall the + * authors or copyright holders be liable for any claim, damages or other + * liability, whether in an action of contract, tort or otherwise, arising from, + * out of or in connection with the software or the use or other dealings in the + * software. See the License for the specific language governing permissions and + * limitations under the License. + */ package com.kumuluz.ee.cors.utils; import javax.annotation.processing.Filer; @@ -7,7 +27,10 @@ import java.util.Set; /** - * Created by zvoneg on 31/07/17. + * AnnotationProcessorUtil class. + * + * @author Zvone Gazvoda + * @since 1.0.0 */ public class AnnotationProcessorUtil { diff --git a/src/main/java/com/kumuluz/ee/cors/utils/CorsConfigUtil.java b/src/main/java/com/kumuluz/ee/cors/utils/CorsConfigUtil.java index c0f162a..fb61040 100644 --- a/src/main/java/com/kumuluz/ee/cors/utils/CorsConfigUtil.java +++ b/src/main/java/com/kumuluz/ee/cors/utils/CorsConfigUtil.java @@ -1,3 +1,23 @@ +/* + * Copyright (c) 2014-2017 Kumuluz and/or its affiliates + * and other contributors as indicated by the @author tags and + * the contributor list. + * + * Licensed under the MIT License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/MIT + * + * The software is provided "AS IS", WITHOUT WARRANTY OF ANY KIND, express or + * implied, including but not limited to the warranties of merchantability, + * fitness for a particular purpose and noninfringement. in no event shall the + * authors or copyright holders be liable for any claim, damages or other + * liability, whether in an action of contract, tort or otherwise, arising from, + * out of or in connection with the software or the use or other dealings in the + * software. See the License for the specific language governing permissions and + * limitations under the License. + */ package com.kumuluz.ee.cors.utils; import com.kumuluz.ee.configuration.utils.ConfigurationUtil; @@ -8,7 +28,10 @@ import java.util.Optional; /** - * Created by zvoneg on 31/07/17. + * CorsConfigUtil class. + * + * @author Zvone Gazvoda + * @since 1.0.0 */ public class CorsConfigUtil { diff --git a/src/main/java/com/kumuluz/ee/cors/utils/CrossOriginAnnotationProcessorUtil.java b/src/main/java/com/kumuluz/ee/cors/utils/CrossOriginAnnotationProcessorUtil.java index 7621d87..cfb1835 100644 --- a/src/main/java/com/kumuluz/ee/cors/utils/CrossOriginAnnotationProcessorUtil.java +++ b/src/main/java/com/kumuluz/ee/cors/utils/CrossOriginAnnotationProcessorUtil.java @@ -1,3 +1,23 @@ +/* + * Copyright (c) 2014-2017 Kumuluz and/or its affiliates + * and other contributors as indicated by the @author tags and + * the contributor list. + * + * Licensed under the MIT License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/MIT + * + * The software is provided "AS IS", WITHOUT WARRANTY OF ANY KIND, express or + * implied, including but not limited to the warranties of merchantability, + * fitness for a particular purpose and noninfringement. in no event shall the + * authors or copyright holders be liable for any claim, damages or other + * liability, whether in an action of contract, tort or otherwise, arising from, + * out of or in connection with the software or the use or other dealings in the + * software. See the License for the specific language governing permissions and + * limitations under the License. + */ package com.kumuluz.ee.cors.utils; import com.kumuluz.ee.cors.config.CorsRegistration; @@ -5,7 +25,10 @@ import java.util.List; /** - * Created by zvoneg on 31/07/17. + * CrossOriginAnnotationProcessorUtil interface. + * + * @author Zvone Gazvoda + * @since 1.0.0 */ public interface CrossOriginAnnotationProcessorUtil { diff --git a/src/main/java/com/kumuluz/ee/cors/utils/JaxRsCrossOriginAnnotationProcessorUtil.java b/src/main/java/com/kumuluz/ee/cors/utils/JaxRsCrossOriginAnnotationProcessorUtil.java index 4c88138..2aba415 100644 --- a/src/main/java/com/kumuluz/ee/cors/utils/JaxRsCrossOriginAnnotationProcessorUtil.java +++ b/src/main/java/com/kumuluz/ee/cors/utils/JaxRsCrossOriginAnnotationProcessorUtil.java @@ -1,3 +1,23 @@ +/* + * Copyright (c) 2014-2017 Kumuluz and/or its affiliates + * and other contributors as indicated by the @author tags and + * the contributor list. + * + * Licensed under the MIT License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/MIT + * + * The software is provided "AS IS", WITHOUT WARRANTY OF ANY KIND, express or + * implied, including but not limited to the warranties of merchantability, + * fitness for a particular purpose and noninfringement. in no event shall the + * authors or copyright holders be liable for any claim, damages or other + * liability, whether in an action of contract, tort or otherwise, arising from, + * out of or in connection with the software or the use or other dealings in the + * software. See the License for the specific language governing permissions and + * limitations under the License. + */ package com.kumuluz.ee.cors.utils; import com.kumuluz.ee.cors.annotations.CrossOrigin; @@ -18,7 +38,10 @@ import java.util.logging.Logger; /** - * Created by zvoneg on 27/07/17. + * JaxRsCrossOriginAnnotationProcessorUtil class. + * + * @author Zvone Gazvoda + * @since 1.0.0 */ public class JaxRsCrossOriginAnnotationProcessorUtil implements CrossOriginAnnotationProcessorUtil { diff --git a/src/main/java/com/kumuluz/ee/cors/utils/ServletCrossOriginAnnotationProcessorUtil.java b/src/main/java/com/kumuluz/ee/cors/utils/ServletCrossOriginAnnotationProcessorUtil.java index 2c062ad..dc1fd4e 100644 --- a/src/main/java/com/kumuluz/ee/cors/utils/ServletCrossOriginAnnotationProcessorUtil.java +++ b/src/main/java/com/kumuluz/ee/cors/utils/ServletCrossOriginAnnotationProcessorUtil.java @@ -1,3 +1,23 @@ +/* + * Copyright (c) 2014-2017 Kumuluz and/or its affiliates + * and other contributors as indicated by the @author tags and + * the contributor list. + * + * Licensed under the MIT License (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://opensource.org/licenses/MIT + * + * The software is provided "AS IS", WITHOUT WARRANTY OF ANY KIND, express or + * implied, including but not limited to the warranties of merchantability, + * fitness for a particular purpose and noninfringement. in no event shall the + * authors or copyright holders be liable for any claim, damages or other + * liability, whether in an action of contract, tort or otherwise, arising from, + * out of or in connection with the software or the use or other dealings in the + * software. See the License for the specific language governing permissions and + * limitations under the License. + */ package com.kumuluz.ee.cors.utils; import com.kumuluz.ee.cors.annotations.CrossOrigin; @@ -15,7 +35,10 @@ import java.util.logging.Logger; /** - * Created by zvoneg on 27/07/17. + * ServletCrossOriginAnnotationProcessorUtil class. + * + * @author Zvone Gazvoda + * @since 1.0.0 */ public class ServletCrossOriginAnnotationProcessorUtil implements CrossOriginAnnotationProcessorUtil {