org.pentaho.caching.api.Constants.java Source code

Introduction

Here is the source code for org.pentaho.caching.api.Constants.java

Source

/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2015 by Pentaho : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * 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.
 *
 ******************************************************************************/

package org.pentaho.caching.api;

import com.google.common.base.Preconditions;
import com.google.common.collect.Maps;

import javax.cache.configuration.Factory;
import javax.cache.expiry.AccessedExpiryPolicy;
import javax.cache.expiry.CreatedExpiryPolicy;
import javax.cache.expiry.Duration;
import javax.cache.expiry.EternalExpiryPolicy;
import javax.cache.expiry.ExpiryPolicy;
import javax.cache.expiry.ModifiedExpiryPolicy;
import javax.cache.expiry.TouchedExpiryPolicy;
import java.util.Dictionary;
import java.util.Enumeration;
import java.util.Map;
import java.util.concurrent.TimeUnit;

/**
 * @author nhudak
 */
public class Constants {
    public static final String PENTAHO_CACHE_PROVIDER = "pentaho.cache.provider";

    public static final String DEFAULT_TEMPLATE = "default";
    public static final String DEFAULT_TEMPLATE_DESCRIPTION = "Default Cache Template";

    public static final String CONFIG_TTL = "ttl";
    public static final String CONFIG_TTL_RESET = "ttl.resetOn";
    public static final ExpiryFunction CONFIG_TTL_RESET_DEFAULT = ExpiryFunction.TOUCH;

    public static final String CONFIG_STORE_BY_VALUE = "storeByValue";

    public enum ExpiryFunction {
        CREATE {
            @Override
            public Factory<? extends ExpiryPolicy> createFactory(Long seconds) {
                return CreatedExpiryPolicy.factoryOf(getDuration(seconds));
            }
        },
        MODIFY {
            @Override
            public Factory<? extends ExpiryPolicy> createFactory(Long seconds) {
                return ModifiedExpiryPolicy.factoryOf(getDuration(seconds));
            }
        },
        ACCESS {
            @Override
            public Factory<? extends ExpiryPolicy> createFactory(Long seconds) {
                return AccessedExpiryPolicy.factoryOf(getDuration(seconds));
            }
        },
        TOUCH {
            @Override
            public Factory<? extends ExpiryPolicy> createFactory(Long seconds) {
                return TouchedExpiryPolicy.factoryOf(getDuration(seconds));
            }
        };

        private static Duration getDuration(Long seconds) {
            return new Duration(TimeUnit.SECONDS, seconds);
        }

        public Factory<? extends ExpiryPolicy> createFactory(Long seconds) {
            return EternalExpiryPolicy.factoryOf();
        }
    }

    public static Map<String, String> convertDictionary(Dictionary<String, ?> dictionary) {
        Map<String, String> properties = Maps.newHashMapWithExpectedSize(dictionary.size());
        for (Enumeration<String> keys = dictionary.keys(); keys.hasMoreElements();) {
            String key = keys.nextElement();
            properties.put(key, String.valueOf(dictionary.get(key)));
        }
        return properties;
    }

    public static <T> T unwrap(Object object, Class<T> clazz) {
        Preconditions.checkArgument(clazz.isInstance(object), "%s cannot be cast to %s", object, clazz);
        return clazz.cast(object);
    }
}