docs/_docs/code-snippets/java/src/main/java/org/apache/ignite/snippets/ExpiryPolicies.java

/*
 * 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.ignite.snippets;

import java.util.concurrent.TimeUnit;
import javax.cache.expiry.CreatedExpiryPolicy;
import javax.cache.expiry.Duration;
import org.apache.ignite.Ignite;
import org.apache.ignite.IgniteCache;
import org.apache.ignite.Ignition;
import org.apache.ignite.configuration.CacheConfiguration;
import org.apache.ignite.configuration.IgniteConfiguration;
import org.junit.jupiter.api.Test;

public class ExpiryPolicies {

    @Test
   void expiryPoliciesExample() {
        //tag::cfg[]
        //tag::eagerTtl[]
        CacheConfiguration<Integer, String> cfg = new CacheConfiguration<Integer, String>();
        cfg.setName("myCache");
        //end::cfg[]

        cfg.setEagerTtl(true);
        //end::eagerTtl[]
        //tag::cfg[]
        cfg.setExpiryPolicyFactory(CreatedExpiryPolicy.factoryOf(Duration.FIVE_MINUTES));
        //end::cfg[]

    }

    @Test
    void expiryPolicyForIndividualEntry() {

        IgniteConfiguration igniteCfg = new IgniteConfiguration();
        try (Ignite ignite = Ignition.start(igniteCfg)) {

            //tag::expiry2[]

            CacheConfiguration<Integer, String> cacheCfg = new CacheConfiguration<Integer, String>("myCache");

            ignite.createCache(cacheCfg);

            IgniteCache cache = ignite.cache("myCache")
                    .withExpiryPolicy(new CreatedExpiryPolicy(new Duration(TimeUnit.MINUTES, 5)));

            // if the cache does not contain key 1, the entry will expire after 5 minutes
            cache.put(1, "first value");

            //end::expiry2[]
        }
    }
}