You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by gh...@apache.org on 2019/04/03 19:02:30 UTC
[sling-org-apache-sling-hc-annotations] branch master updated:
SLING-7980
This is an automated email from the ASF dual-hosted git repository.
ghenzler pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-hc-annotations.git
The following commit(s) were added to refs/heads/master by this push:
new 6a49147 SLING-7980
6a49147 is described below
commit 6a49147cce0682fa5ef426be0abcd89d9150fc05
Author: georg.henzler <ge...@netcentric.biz>
AuthorDate: Wed Apr 3 21:02:15 2019 +0200
SLING-7980
---
CODE_OF_CONDUCT.md | 22 ---
CONTRIBUTING.md | 24 ---
Jenkinsfile | 20 --
LICENSE | 202 ---------------------
README.md | 6 +-
pom.xml | 72 --------
.../sling/hc/annotations/SlingHealthCheck.java | 101 -----------
.../hc/annotations/SlingHealthCheckProcessor.java | 162 -----------------
...felix.scrplugin.annotations.AnnotationProcessor | 19 --
9 files changed, 1 insertion(+), 627 deletions(-)
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
deleted file mode 100644
index 0fa18e5..0000000
--- a/CODE_OF_CONDUCT.md
+++ /dev/null
@@ -1,22 +0,0 @@
-<!--/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- ~ Licensed to the Apache Software Foundation (ASF) under one
- ~ or more contributor license agreements. See the NOTICE file
- ~ distributed with this work for additional information
- ~ regarding copyright ownership. The ASF licenses this file
- ~ to you under the Apache License, Version 2.0 (the
- ~ "License"); you may not use this file except in compliance
- ~ with the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing,
- ~ software distributed under the License is distributed on an
- ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~ KIND, either express or implied. See the License for the
- ~ specific language governing permissions and limitations
- ~ under the License.
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/-->
-Apache Software Foundation Code of Conduct
-====
-
-Being an Apache project, Apache Sling adheres to the Apache Software Foundation's [Code of Conduct](https://www.apache.org/foundation/policies/conduct.html).
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
deleted file mode 100644
index ac82a1a..0000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1,24 +0,0 @@
-<!--/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- ~ Licensed to the Apache Software Foundation (ASF) under one
- ~ or more contributor license agreements. See the NOTICE file
- ~ distributed with this work for additional information
- ~ regarding copyright ownership. The ASF licenses this file
- ~ to you under the Apache License, Version 2.0 (the
- ~ "License"); you may not use this file except in compliance
- ~ with the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing,
- ~ software distributed under the License is distributed on an
- ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~ KIND, either express or implied. See the License for the
- ~ specific language governing permissions and limitations
- ~ under the License.
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/-->
-Contributing
-====
-
-Thanks for choosing to contribute!
-
-You will find all the necessary details about how you can do this at https://sling.apache.org/contributing.html.
diff --git a/Jenkinsfile b/Jenkinsfile
deleted file mode 100644
index f582519..0000000
--- a/Jenkinsfile
+++ /dev/null
@@ -1,20 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-
-slingOsgiBundleBuild()
diff --git a/LICENSE b/LICENSE
deleted file mode 100644
index d645695..0000000
--- a/LICENSE
+++ /dev/null
@@ -1,202 +0,0 @@
-
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright [yyyy] [name of copyright owner]
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
diff --git a/README.md b/README.md
index a1a5e7f..2e26e87 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,5 @@
[<img src="https://sling.apache.org/res/logos/sling.png"/>](https://sling.apache.org)
- [](https://builds.apache.org/job/Sling/job/sling-org-apache-sling-hc-annotations/job/master) [](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.sling%22%20a%3A%22org.apache.sling.hc.annotations%22) [ project.
-
-Sling Health Check Annotations
+This module is **obsolete** after the migration to Apache Felix - see [migration guide](https://sling.apache.org/documentation/bundles/sling-health-check-tool.html) on how to use [Apache Felix Health Checks](https://felix.apache.org/documentation/subprojects/apache-felix-healthchecks.html)
diff --git a/pom.xml b/pom.xml
deleted file mode 100644
index e1d7459..0000000
--- a/pom.xml
+++ /dev/null
@@ -1,72 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
-
- <modelVersion>4.0.0</modelVersion>
-
- <parent>
- <groupId>org.apache.sling</groupId>
- <artifactId>sling</artifactId>
- <version>26</version>
- <relativePath />
- </parent>
-
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.hc.annotations</artifactId>
- <packaging>jar</packaging>
- <version>1.0.7-SNAPSHOT</version>
-
- <name>Apache Sling Health Check Annotations</name>
- <inceptionYear>2013</inceptionYear>
-
- <description>
- Sling Health Check Annotations
- </description>
-
- <scm>
- <connection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-hc-annotations.git</connection>
- <developerConnection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-hc-annotations.git</developerConnection>
- <url>https://gitbox.apache.org/repos/asf?p=sling-org-apache-sling-hc-annotations.git</url>
- <tag>HEAD</tag>
- </scm>
-
- <dependencies>
- <dependency>
- <groupId>org.osgi</groupId>
- <artifactId>org.osgi.core</artifactId>
- </dependency>
- <dependency>
- <groupId>org.osgi</groupId>
- <artifactId>org.osgi.compendium</artifactId>
- </dependency>
- <dependency>
- <groupId>org.apache.felix</groupId>
- <artifactId>org.apache.felix.scr.generator</artifactId>
- <version>1.10.0</version>
- <scope>compile</scope>
- </dependency>
- <dependency>
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.hc.api</artifactId>
- <version>1.0.0</version>
- <scope>provided</scope>
- </dependency>
- </dependencies>
-</project>
diff --git a/src/main/java/org/apache/sling/hc/annotations/SlingHealthCheck.java b/src/main/java/org/apache/sling/hc/annotations/SlingHealthCheck.java
deleted file mode 100644
index dba4e66..0000000
--- a/src/main/java/org/apache/sling/hc/annotations/SlingHealthCheck.java
+++ /dev/null
@@ -1,101 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The SF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations under the License.
- */
-package org.apache.sling.hc.annotations;
-
-import java.lang.annotation.ElementType;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
-import java.lang.annotation.Target;
-
-import org.apache.felix.scr.annotations.ConfigurationPolicy;
-
-@Target(ElementType.TYPE)
-@Retention(RetentionPolicy.CLASS)
-public @interface SlingHealthCheck {
-
- /** Defines the name of the health check. <p>
- * This attribute is converted to values for the <code>hc.name</code> property. */
- String name() default "";
-
- /** One ore more tags.
- * <p>
- * This attribute is converted to values for the <code>hc.tags</code> property. */
- String[] tags() default {};
-
- /** The JMX mbean name (optional, the mbean is only registered if attribute present).
- * <p>
- * This attribute is converted to values for the <code>hc.mbean.name</code> property. */
- String mbeanName() default "";
-
- /** Cron expression for asynchronous execution (optional, default is synchronous execution).
- * <p>
- * This attribute is converted to values for the <code>hc.async.cronExpression</code> property. */
- String asyncCronExpression() default "";
-
- /**
- * Overrides the global result TTL as configured in
- * {@link org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl} for this individual check.
- * <p>
- * The value of this property must be of type {@link Long} and is configured in ms.
- */
- long resultCacheTtlInMs() default -1;
-
- /**
- * If given, warning results (that is WARN, CRITICAL or HEALTH_CHECK_ERROR) from the past executions
- * will be taken into account as well for the given minutes (use Integer.MAX_VALUE for indefinitely).
- * Useful for unhealthy system states that disappear but might leave the system at an inconsistent
- * state (e.g. an event queue overflow).
- */
- long warningsStickForMinutes() default -1;
-
- // handling of service and component properties (optional)
-
- /** Whether to generate a default SCR component tag. If set to false, a {@link org.apache.felix.scr.annotations.Component} annotation can be added manually
- * with defined whatever configuration needed. */
- boolean generateComponent() default true;
-
- /** Whether to generate a default SCR service tag with "interface=org.apache.sling.hc.api.HealthCheck". If set to false, a
- * {@link org.apache.felix.scr.annotations.Service} annotation can be added manually with defined whatever configuration needed. */
- boolean generateService() default true;
-
- /** Defines the Component name also used as the PID for the Configuration Admin Service. Default value: Fully qualified name of the Java class. */
- String componentName() default "";
-
- /** Whether Metatype Service data is generated or not. If this parameter is set to true Metatype Service data is generated in the <code>metatype.xml</code>
- * file for this component. Otherwise no Metatype Service data is generated for this component. */
- boolean metatype() default true;
-
- /** Whether immediate is set on the SCR component. */
- boolean immediate() default false;
-
- /** Set the metatype factory pid property (only for non factory components). */
- boolean configurationFactory() default false;
-
- /** The component configuration policy */
- ConfigurationPolicy configurationPolicy() default ConfigurationPolicy.OPTIONAL;
-
- /** This is generally used as a title for the object described by the meta type. This name may be localized by prepending a % sign to the name. Default
- * value: %<name>.name */
- String label() default "";
-
- /** This is generally used as a description for the object described by the meta type. This name may be localized by prepending a % sign to the name. Default
- * value: %<name>.description */
- String description() default "";
-
-
-}
diff --git a/src/main/java/org/apache/sling/hc/annotations/SlingHealthCheckProcessor.java b/src/main/java/org/apache/sling/hc/annotations/SlingHealthCheckProcessor.java
deleted file mode 100644
index 51eed20..0000000
--- a/src/main/java/org/apache/sling/hc/annotations/SlingHealthCheckProcessor.java
+++ /dev/null
@@ -1,162 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The SF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations under the License.
- */
-package org.apache.sling.hc.annotations;
-
-import java.util.List;
-
-import org.apache.felix.scrplugin.SCRDescriptorException;
-import org.apache.felix.scrplugin.SCRDescriptorFailureException;
-import org.apache.felix.scrplugin.annotations.AnnotationProcessor;
-import org.apache.felix.scrplugin.annotations.ClassAnnotation;
-import org.apache.felix.scrplugin.annotations.ScannedClass;
-import org.apache.felix.scrplugin.description.ClassDescription;
-import org.apache.felix.scrplugin.description.ComponentConfigurationPolicy;
-import org.apache.felix.scrplugin.description.ComponentDescription;
-import org.apache.felix.scrplugin.description.PropertyDescription;
-import org.apache.felix.scrplugin.description.PropertyType;
-import org.apache.felix.scrplugin.description.PropertyUnbounded;
-import org.apache.felix.scrplugin.description.ServiceDescription;
-import org.apache.sling.hc.api.HealthCheck;
-
-/** Annotation processor for the SlingHealthCheck annotation. */
-public class SlingHealthCheckProcessor implements AnnotationProcessor {
-
- @Override
- public void process(final ScannedClass scannedClass, final ClassDescription classDescription) throws SCRDescriptorException, SCRDescriptorFailureException {
- final List<ClassAnnotation> healthChecks = scannedClass.getClassAnnotations(SlingHealthCheck.class.getName());
- scannedClass.processed(healthChecks);
-
- for (final ClassAnnotation cad : healthChecks) {
- processHealthCheck(cad, classDescription);
- }
- }
-
- /** Processes the given healthcheck annotation.
- *
- * @param cad the annotation
- * @param classDescription the class description */
- private void processHealthCheck(final ClassAnnotation cad, final ClassDescription classDescription) {
-
- final boolean generateComponent = cad.getBooleanValue("generateComponent", true);
- final boolean metatype = cad.getBooleanValue("metatype", true);
- final boolean immediate = cad.getBooleanValue("immediate", false);
-
- // generate ComponentDescription if required
- if (generateComponent) {
- String nameOfAnnotatedClass = classDescription.getDescribedClass().getName();
-
- final ComponentDescription cd = new ComponentDescription(cad);
- cd.setName(cad.getStringValue("componentName", nameOfAnnotatedClass));
- cd.setConfigurationPolicy(ComponentConfigurationPolicy.valueOf(cad.getEnumValue("configurationPolicy",
- ComponentConfigurationPolicy.OPTIONAL.name())));
- cd.setSetMetatypeFactoryPid(cad.getBooleanValue("configurationFactory", false));
-
- String nameFromAnnotation = (String) cad.getValue("name");
- String defaultLabel = "Sling Health Check: " + (nameFromAnnotation!=null ? nameFromAnnotation : nameOfAnnotatedClass);
- cd.setLabel(cad.getStringValue("label", defaultLabel));
- cd.setDescription(cad.getStringValue("description", "Health Check Configuration"));
-
- cd.setCreateMetatype(metatype);
- cd.setImmediate(immediate);
-
- classDescription.add(cd);
- }
-
- // generate ServiceDescription if required
- final boolean generateService = cad.getBooleanValue("generateService", true);
- if (generateService) {
- final ServiceDescription sd = new ServiceDescription(cad);
- sd.addInterface(HealthCheck.class.getName());
- classDescription.add(sd);
- }
-
- // generate HC PropertyDescriptions
- generatePropertyDescriptor(cad, classDescription, metatype, "name", HealthCheck.NAME, PropertyType.String,
- "Name", "Name of the Health Check", false);
- generatePropertyDescriptor(cad, classDescription, metatype, "tags", HealthCheck.TAGS, PropertyType.String,
- "Tags", "List of tags", true);
- generatePropertyDescriptor(cad, classDescription, metatype, "mbeanName", HealthCheck.MBEAN_NAME, PropertyType.String,
- "MBean", "MBean name (leave empty for not using JMX)", false);
- generatePropertyDescriptor(cad, classDescription, metatype, "asyncCronExpression", HealthCheck.ASYNC_CRON_EXPRESSION, PropertyType.String,
- "Cron expression", "Cron expression for asynchronous execution (leave empty for synchronous execution)", false);
-
- String resultCacheTtlInMsPropName = "resultCacheTtlInMs";
- if (cad.getValue(resultCacheTtlInMsPropName) != null) {
- generatePropertyDescriptor(cad, classDescription, metatype, resultCacheTtlInMsPropName, HealthCheck.RESULT_CACHE_TTL_IN_MS, PropertyType.Long,
- "Result Cache TTL",
- "TTL for results. The value -1 (default) uses the global configuration in health check executor. "
- + "Redeployment of a HC always invalidates its cached result.",
- false);
- }
-
- String warningsStickForMinutesPropName = "warningsStickForMinutes";
- if (cad.getValue(warningsStickForMinutesPropName) != null) {
- generatePropertyDescriptor(cad, classDescription, metatype, warningsStickForMinutesPropName,
- "hc.warningsStickForMinutes" /* use constant once API is released */,
- PropertyType.Long, "Sticky Warnings",
- "If given, warning results (that is WARN, CRITICAL or HEALTH_CHECK_ERROR) from the past executions will be "
- + "taken into account as well for the given minutes (use Integer.MAX_VALUE for indefinitely). "
- + "By default this is disabled (value -1).",
- false);
- }
- }
-
- private boolean isLongDefaultValue(final ClassAnnotation cad, String propName) {
- Object value = cad.getValue(propName);
- return value == null || ((Long) value) == -1;
- }
-
- /** Generates a property descriptor of type {@link PropertyType} */
- private void generatePropertyDescriptor(final ClassAnnotation cad, final ClassDescription classDescription,
- final boolean metatype, final String propertyName, final String propertyDescriptorName, PropertyType propertyType, String label, String description, boolean isArray) {
-
- final PropertyDescription pd = new PropertyDescription(cad);
- pd.setName(propertyDescriptorName);
- pd.setLabel(label);
- pd.setDescription(description);
- pd.setType(propertyType);
-
- if(isArray) {
- final String[] values = (String[]) cad.getValue(propertyName);
- pd.setMultiValue(values);
- pd.setUnbounded(PropertyUnbounded.ARRAY);
- pd.setCardinality(Integer.MAX_VALUE);
- } else {
- final Object propertyVal = cad.getValue(propertyName);
- String pdValue = (propertyVal instanceof String) ? (String) propertyVal :
- propertyVal!=null ? propertyVal.toString() : null;
- pd.setValue(pdValue);
- pd.setUnbounded(PropertyUnbounded.DEFAULT);
- }
-
- if (!metatype) {
- pd.setPrivate(true);
- }
- classDescription.add(pd);
- }
-
- @Override
- public int getRanking() {
- return 500;
- }
-
- @Override
- public String getName() {
- return SlingHealthCheck.class.getName() + " annotation processor.";
- }
-}
diff --git a/src/main/resources/META-INF/services/org.apache.felix.scrplugin.annotations.AnnotationProcessor b/src/main/resources/META-INF/services/org.apache.felix.scrplugin.annotations.AnnotationProcessor
deleted file mode 100644
index 5445dd4..0000000
--- a/src/main/resources/META-INF/services/org.apache.felix.scrplugin.annotations.AnnotationProcessor
+++ /dev/null
@@ -1,19 +0,0 @@
-#
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements. See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership. The ASF licenses this file
-# to you under the Apache License, Version 2.0 (the
-# "License"); you may not use this file except in compliance
-# with the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing,
-# software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied. See the License for the
-# specific language governing permissions and limitations
-# under the License.
-#
-org.apache.sling.hc.annotations.SlingHealthCheckProcessor
\ No newline at end of file