/*
* Copyright (c) 2008-2017, Hazelcast, Inc. All Rights Reserved.
*
* 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 com.hazelcast.cache;
import java.net.URI;
/**
* Utility class for various cache related operations to be used by our internal structure and end user.
*
* @since 3.7
*/
public final class CacheUtil {
private CacheUtil() {
}
/**
* Gets the prefix of cache name without Hazelcast's {@link javax.cache.CacheManager}
* specific prefix {@link com.hazelcast.cache.HazelcastCacheManager#CACHE_MANAGER_PREFIX}.
*
* @param uri an implementation specific URI for the
* Hazelcast's {@link javax.cache.CacheManager} (null means use
* Hazelcast's {@link javax.cache.spi.CachingProvider#getDefaultURI()})
* @param classLoader the {@link ClassLoader} to use for the
* Hazelcast's {@link javax.cache.CacheManager} (null means use
* Hazelcast's {@link javax.cache.spi.CachingProvider#getDefaultClassLoader()})
* @return the prefix of cache name without Hazelcast's {@link javax.cache.CacheManager}
* specific prefix {@link com.hazelcast.cache.HazelcastCacheManager#CACHE_MANAGER_PREFIX}
*/
public static String getPrefix(URI uri, ClassLoader classLoader) {
if (uri == null && classLoader == null) {
return null;
} else {
StringBuilder sb = new StringBuilder();
if (uri != null) {
sb.append(uri.toASCIIString()).append('/');
}
if (classLoader != null) {
sb.append(classLoader.toString()).append('/');
}
return sb.toString();
}
}
/**
* Gets the cache name with prefix but without Hazelcast's {@link javax.cache.CacheManager}
* specific prefix {@link com.hazelcast.cache.HazelcastCacheManager#CACHE_MANAGER_PREFIX}.
*
* @param name the simple name of the cache without any prefix
* @param uri an implementation specific URI for the
* Hazelcast's {@link javax.cache.CacheManager} (null means use
* Hazelcast's {@link javax.cache.spi.CachingProvider#getDefaultURI()})
* @param classLoader the {@link ClassLoader} to use for the
* Hazelcast's {@link javax.cache.CacheManager} (null means use
* Hazelcast's {@link javax.cache.spi.CachingProvider#getDefaultClassLoader()})
* @return the cache name with prefix but without Hazelcast's {@link javax.cache.CacheManager}
* specific prefix {@link com.hazelcast.cache.HazelcastCacheManager#CACHE_MANAGER_PREFIX}.
*/
public static String getPrefixedCacheName(String name, URI uri, ClassLoader classLoader) {
String cacheNamePrefix = getPrefix(uri, classLoader);
if (cacheNamePrefix != null) {
return cacheNamePrefix + name;
} else {
return name;
}
}
/**
* Convenience method to obtain the name of Hazelcast distributed object corresponding to the cache identified
* by the given {@code cacheName}, assuming {@code null URI} and {@code ClassLoader} prefixes. This is equivalent to
* invoking {@link #getDistributedObjectName(String, URI, ClassLoader)} with {@code null} passed as {@code URI} and
* {@code ClassLoader} arguments.
*
* @param cacheName the simple name of the cache without any prefix
* @return the name of the {@link ICache} distributed object corresponding to given cacheName, assuming
* null URI & class loader prefixes.
* @see #getDistributedObjectName(String, URI, ClassLoader)
*/
public static String getDistributedObjectName(String cacheName) {
return getDistributedObjectName(cacheName, null, null);
}
/**
* Convenience method to obtain the name of Hazelcast distributed object corresponding to the cache identified
* by the given arguments. The distributed object name returned by this method can be used to obtain the cache as
* a Hazelcast {@link ICache} as shown in this example:
* <pre>
* HazelcastInstance hz = Hazelcast.newHazelcastInstance();
*
* // Obtain Cache via JSR-107 API
* CachingProvider hazelcastCachingProvider = Caching.getCachingProvider(
* "com.hazelcast.cache.HazelcastCachingProvider",
* HazelcastCachingProvider.class.getClassLoader());
* CacheManager cacheManager = hazelcastCachingProvider.getCacheManager();
* Cache testCache = cacheManager.createCache("test", new MutableConfiguration<String, String>());
*
* // URI and ClassLoader are null, since we created this cache with the default CacheManager,
* // otherwise we should pass the owning CacheManager's URI & ClassLoader as arguments.
* String distributedObjectName = CacheUtil.asDistributedObjectName("test", null, null);
*
* // Obtain a reference to the backing ICache via HazelcastInstance.getDistributedObject.
* // You may invoke this on any member of the cluster.
* ICache<String, String> distributedObjectCache = (ICache) hz.getDistributedObject(
* ICacheService.SERVICE_NAME,
* distributedObjectName);
* </pre>
*
* @param cacheName the simple name of the cache without any prefix
* @param uri an implementation specific URI for the
* Hazelcast's {@link javax.cache.CacheManager} (null means use
* Hazelcast's {@link javax.cache.spi.CachingProvider#getDefaultURI()})
* @param classLoader the {@link ClassLoader} to use for the
* Hazelcast's {@link javax.cache.CacheManager} (null means use
* Hazelcast's {@link javax.cache.spi.CachingProvider#getDefaultClassLoader()})
* @return the name of the {@link ICache} distributed object corresponding to given arguments.
*/
public static String getDistributedObjectName(String cacheName, URI uri, ClassLoader classLoader) {
return HazelcastCacheManager.CACHE_MANAGER_PREFIX + getPrefixedCacheName(cacheName, uri, classLoader);
}
}