mark module as deprecated
see https://lists.apache.org/thread/l4wd9xbk7f88jc6gs1mr2vz1jc7d8yo1
diff --git a/.asf.yaml b/.asf.yaml
index b8d35f3..63439dd 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -1,4 +1,10 @@
github:
+ description: "Apache Sling Commons Cache API (deprecated)"
+ homepage: "https://sling.apache.org/"
+ labels:
+ - "sling"
+ - "java"
+ - "deprecated"
autolink_jira:
- "SLING"
- "OAK"
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/README.md b/README.md
index e969bc6..1e0257f 100644
--- a/README.md
+++ b/README.md
@@ -2,17 +2,8 @@
 [](https://ci-builds.apache.org/job/Sling/job/modules/job/sling-org-apache-sling-commons-cache-api/job/master/) [](https://ci-builds.apache.org/job/Sling/job/modules/job/sling-org-apache-sling-commons-cache-api/job/master/test/?width=800&height=600) [](https://sonarcloud.io/dashboard?id=apache_sling-org-apache-sling-commons-cache-api) [](https://sonarcloud.io/dashboard?id=apache_sling-org-apache-sling-commons-cache-api) [](https://www.javadoc.io/doc/org.apache.sling/org.apache.sling.api) [](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.sling%22%20a%3A%22org.apache.sling.api%22) [](https://www.apache.org/licenses/LICENSE-2.0)
-# Apache Sling Commons Cache API
+# Apache Sling Commons Cache API (deprecated)
-This module is part of the [Apache Sling](https://sling.apache.org) project.
+This module is **obsolete**.
-This is an Cache API, the implementation of which will allow applications written in Sling to cache data locally,
-cache locally with cluster wide invalidation, and cache and replicate data. The exact nature of the cache behaviour
-depends on the implementation of the API.
-
-
-Acknowledgments
-
-This code was based on a module from Sparse Content Map 29 September 2012 (git:sha1:a222df1937434ad3f07bf6c4f60b19524a158bcb), which itself was based on a snapshot of a
-module in Sakai Nakamura 27 Jan 2011 (git:sha1:b9d8e65b733ec7c35a3d194c9a5dc12acf13cb34). All know contributors to code in this module have been
-contacted for permission to grant license to the Apache Foundation.
+For reference or potential bugfix releases use branch [maintenance](https://github.com/apache/sling-org-apache-sling-nosql-generic/tree/maintenance).
\ No newline at end of file
diff --git a/pom.xml b/pom.xml
deleted file mode 100644
index 878f69d..0000000
--- a/pom.xml
+++ /dev/null
@@ -1,68 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<!--
- 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-bundle-parent</artifactId>
- <version>47</version>
- <relativePath />
- </parent>
-
- <artifactId>org.apache.sling.commons.cache.api</artifactId>
- <version>0.1-SNAPSHOT</version>
-
- <name>Apache Sling Commons Cache API</name>
- <description>
- This bundle provides a Cache API for Sling applications to use.
- </description>
-
- <properties>
- <sling.java.version>8</sling.java.version>
- <project.build.outputTimestamp>1</project.build.outputTimestamp>
- <bnd.baseline.fail.on.missing>false</bnd.baseline.fail.on.missing>
- </properties>
-
- <scm>
- <connection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-cache-api.git</connection>
- <developerConnection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-cache-api.git</developerConnection>
- <url>https://github.com/apache/sling-org-apache-sling-commons-cache-api.git</url>
- <tag>HEAD</tag>
- </scm>
-
- <build>
- <plugins>
- <plugin>
- <groupId>biz.aQute.bnd</groupId>
- <artifactId>bnd-maven-plugin</artifactId>
- </plugin>
- </plugins>
- </build>
-
- <dependencies>
- <!-- OSGi Dependencies -->
- <dependency>
- <groupId>org.osgi</groupId>
- <artifactId>org.osgi.annotation.versioning</artifactId>
- <scope>provided</scope>
- </dependency>
- </dependencies>
-</project>
diff --git a/src/main/java/org/apache/sling/commons/cache/api/Cache.java b/src/main/java/org/apache/sling/commons/cache/api/Cache.java
deleted file mode 100644
index 20f1488..0000000
--- a/src/main/java/org/apache/sling/commons/cache/api/Cache.java
+++ /dev/null
@@ -1,92 +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.
- */
-
-package org.apache.sling.commons.cache.api;
-
-import java.util.Collection;
-
-/**
- * A Cache managed by the cache manager.
- */
-public interface Cache<V> {
-
- /**
- * Cache an object
- *
- * @param key
- * The key with which to find the object.
- * @param payload
- * The object to cache.
- * @param duration
- * The time to cache the object (seconds).
- */
- V put(String key, V payload);
-
- /**
- * Test for a non expired entry in the cache.
- *
- * @param key
- * The cache key.
- * @return true if the key maps to a non-expired cache entry, false if not.
- */
- boolean containsKey(String key);
-
- /**
- * Get the non expired entry, or null if not there (or expired)
- *
- * @param key
- * The cache key.
- * @return The payload, or null if the payload is null, the key is not
- * found, or the entry has expired (Note: use containsKey() to
- * remove this ambiguity).
- */
- V get(String key);
-
- /**
- * Clear all entries.
- */
- void clear();
-
- /**
- * Remove this entry from the cache.
- *
- * @param key
- * The cache key.
- */
- boolean remove(String key);
-
- /**
- * Remove the key and any child keys from the cache, this is an expensive
- * operation.
- *
- * @param key
- */
- void removeChildren(String key);
-
- /**
- * @return
- */
- Collection<V> values();
-
- /**
- * @return
- */
- Collection<String> keys();
-
-}
diff --git a/src/main/java/org/apache/sling/commons/cache/api/CacheManagerService.java b/src/main/java/org/apache/sling/commons/cache/api/CacheManagerService.java
deleted file mode 100644
index b40a510..0000000
--- a/src/main/java/org/apache/sling/commons/cache/api/CacheManagerService.java
+++ /dev/null
@@ -1,51 +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.
- */
-
-package org.apache.sling.commons.cache.api;
-
-/**
- * The Cache manager provides access to all caches in the system. Caches are
- * scoped by CacheScope and those that are bound can be unbound.
- */
-public interface CacheManagerService {
-
- /**
- * Get a cache to contain a specified type, with a defined scope. Getting a
- * cache of the same name in the same scope will return the same cache for
- * that scope. The thread invoking the method forms part of the scope for
- * CacheScopes THREAD or REQUEST.
- *
- * @param <T>
- * The type of the elements, but be serializable for any non
- * thread bound cache.
- * @param name
- * the name of the cache.
- * @param scope
- * the scope of the cache.
- * @return the cache suitable for holding the type T
- */
- <T> Cache<T> getCache(String name, CacheScope scope);
-
- /**
- * Unbind the the context specified in scope.
- *
- * @param scope
- */
- void unbind(CacheScope scope);
-}
diff --git a/src/main/java/org/apache/sling/commons/cache/api/CacheScope.java b/src/main/java/org/apache/sling/commons/cache/api/CacheScope.java
deleted file mode 100644
index 7040431..0000000
--- a/src/main/java/org/apache/sling/commons/cache/api/CacheScope.java
+++ /dev/null
@@ -1,50 +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.
- */
-
-package org.apache.sling.commons.cache.api;
-
-/**
- * Defines the scope of the cache
- */
-public enum CacheScope {
- /**
- * Bind the Cache to the request scope.
- */
- REQUEST(),
- /**
- * Bind a cache to the Thread, forever. WARNING: use with extreme caution,
- * as any classes referenced in this type of cache will keep classloaders
- * open and result in memory leaks
- */
- THREAD(),
- /**
- * Bind the cache to the instance, one per instance.
- */
- INSTANCE(),
- /**
- * Make the cache bound to the instance, but accept cluster wide
- * invalidations.
- */
- CLUSTERINVALIDATED(),
- /**
- * Replicate the cache over the whole cluster.
- */
- CLUSTERREPLICATED();
-
-}
diff --git a/src/main/java/org/apache/sling/commons/cache/api/ThreadBound.java b/src/main/java/org/apache/sling/commons/cache/api/ThreadBound.java
deleted file mode 100644
index 13fe116..0000000
--- a/src/main/java/org/apache/sling/commons/cache/api/ThreadBound.java
+++ /dev/null
@@ -1,35 +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.
- */
-
-package org.apache.sling.commons.cache.api;
-
-/**
- * Objects that are added to a ThreadLocalManager, that implement this method
- * will have the unbind method called when the object is ejected from the thread
- * local.
- *
- */
-public interface ThreadBound {
-
- /**
- * Invoked when the item is unbound from the thread.
- */
- void unbind();
-
-}
diff --git a/src/main/java/org/apache/sling/commons/cache/api/package-info.java b/src/main/java/org/apache/sling/commons/cache/api/package-info.java
deleted file mode 100644
index 4678dc9..0000000
--- a/src/main/java/org/apache/sling/commons/cache/api/package-info.java
+++ /dev/null
@@ -1,23 +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.
- */
-
-@Version("1.0")
-package org.apache.sling.commons.cache.api;
-
-import org.osgi.annotation.versioning.Version;
\ No newline at end of file
