com.alibaba.dcm.DnsCacheManipulator Maven / Gradle / Ivy
package com.alibaba.dcm;
import com.alibaba.dcm.internal.InetAddressCacheUtilCommons;
import com.alibaba.dcm.internal.InetAddressCacheUtilForJava8Minus;
import com.alibaba.dcm.internal.InetAddressCacheUtilForJava9Plus;
import edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault;
import sun.net.InetAddressCachePolicy;
import javax.annotation.Nullable;
import javax.annotation.ParametersAreNonnullByDefault;
import java.io.InputStream;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.regex.Pattern;
import static com.alibaba.dcm.internal.InetAddressCacheUtilCommons.NEVER_EXPIRATION;
import static com.alibaba.dcm.internal.JavaVersionUtil.isJavaVersionAtMost8;
/**
* DNS cache manipulator for querying/setting dns(in fact dns cache).
*
* Throw {@link DnsCacheManipulatorException} if operation fail for all methods.
*
* @author Jerry Lee (oldratlee at gmail dot com)
* @see DnsCache
* @see DnsCacheEntry
* @see DnsCacheManipulatorException
*/
@ParametersAreNonnullByDefault
@ReturnValuesAreNonnullByDefault
public final class DnsCacheManipulator {
/**
* Set a never expired dns cache entry.
*
* @param host host
* @param ips ips
* @throws DnsCacheManipulatorException Operation fail
* @see DnsCacheManipulator#setDnsCache(long, java.lang.String, java.lang.String...)
*/
public static void setDnsCache(String host, String... ips) {
try {
if (isJavaVersionAtMost8()) {
InetAddressCacheUtilForJava8Minus.setInetAddressCache(host, ips, NEVER_EXPIRATION);
} else {
InetAddressCacheUtilForJava9Plus.setInetAddressCache(host, ips, NEVER_EXPIRATION);
}
} catch (Exception e) {
final String message = String.format("Fail to setDnsCache for host %s ip %s, cause: %s",
host, Arrays.toString(ips), e);
throw new DnsCacheManipulatorException(message, e);
}
}
/**
* Set a dns cache entry.
*
* @param expireMillis expire time in milliseconds.
* @param host host
* @param ips ips
* @throws DnsCacheManipulatorException Operation fail
*/
public static void setDnsCache(long expireMillis, String host, String... ips) {
try {
if (isJavaVersionAtMost8()) {
InetAddressCacheUtilForJava8Minus.setInetAddressCache(host, ips, expireMillis);
} else {
InetAddressCacheUtilForJava9Plus.setInetAddressCache(host, ips, expireMillis);
}
} catch (Exception e) {
final String message = String.format("Fail to setDnsCache for host %s ip %s expireMillis %s, cause: %s",
host, Arrays.toString(ips), expireMillis, e);
throw new DnsCacheManipulatorException(message, e);
}
}
private static final Pattern COMMA_SEPARATOR = Pattern.compile("\\s*,\\s*");
/**
* Set dns cache entries by properties.
*
* @param properties input properties.
* e.g. {@code www.example.com=42.42.42.42},
* or value is multiply ips seperated by {@code comma}
* {@code www.example.com=42.42.42.42,43.43.43.43}
* @throws DnsCacheManipulatorException Operation fail
*/
public static void setDnsCache(Properties properties) {
for (Map.Entry entry : properties.entrySet()) {
final String host = (String) entry.getKey();
String ipList = (String) entry.getValue();
ipList = ipList.trim();
if (ipList.isEmpty()) continue;
final String[] ips = COMMA_SEPARATOR.split(ipList);
setDnsCache(host, ips);
}
}
/**
* Load dns config from properties file {@code dns-cache.properties} on classpath, then set to dns cache.
*
* {@code dns-cache.properties} can be reset/customized by {@code JVM -D option} {@code dcm.config.filename}
*
* @throws DnsCacheManipulatorException Operation fail
* @see DnsCacheManipulator#setDnsCache(java.util.Properties)
* @see DnsCacheManipulator#loadDnsCacheConfig(java.lang.String)
*/
public static void loadDnsCacheConfig() {
final String DCM_CONFIG_FILE_NAME_KEY = "dcm.config.filename";
final String dcmConfigFileName = System.getProperty(DCM_CONFIG_FILE_NAME_KEY, "dns-cache.properties");
loadDnsCacheConfig(dcmConfigFileName);
}
/**
* Load dns config from the specified properties file on classpath, then set dns cache.
*
* @param propertiesFileName specified properties file name on classpath.
* @throws DnsCacheManipulatorException Operation fail
* @see DnsCacheManipulator#setDnsCache(java.util.Properties)
*/
public static void loadDnsCacheConfig(String propertiesFileName) {
InputStream inputStream = Thread.currentThread().getContextClassLoader().getResourceAsStream(propertiesFileName);
if (inputStream == null) {
inputStream = DnsCacheManipulator.class.getClassLoader().getResourceAsStream(propertiesFileName);
}
if (inputStream == null) {
throw new DnsCacheManipulatorException("Fail to find " + propertiesFileName + " on classpath!");
}
try {
Properties properties = new Properties();
properties.load(inputStream);
inputStream.close();
setDnsCache(properties);
} catch (Exception e) {
final String message = String.format("Fail to loadDnsCacheConfig from %s, cause: %s",
propertiesFileName, e);
throw new DnsCacheManipulatorException(message, e);
}
}
/**
* Get a dns cache entry by {@code host}.
*
* @return dns cache. return {@code null} if no entry for host or dns cache is expired.
* @throws DnsCacheManipulatorException Operation fail
*/
@Nullable
public static DnsCacheEntry getDnsCache(String host) {
try {
if (isJavaVersionAtMost8()) {
return InetAddressCacheUtilForJava8Minus.getInetAddressCache(host);
} else {
return InetAddressCacheUtilForJava9Plus.getInetAddressCache(host);
}
} catch (Exception e) {
throw new DnsCacheManipulatorException("Fail to getDnsCache, cause: " + e, e);
}
}
/**
* Get whole dns cache info {@link DnsCache} including cache and negative cache.
*
* If you only need cache without negative cache use convenient method {@link #listDnsCache()}.
*
* @return dns cache entries
* @throws DnsCacheManipulatorException Operation fail
* @see #listDnsCache()
* @since 1.2.0
*/
public static DnsCache getWholeDnsCache() {
try {
if (isJavaVersionAtMost8()) {
return InetAddressCacheUtilForJava8Minus.listInetAddressCache();
} else {
return InetAddressCacheUtilForJava9Plus.listInetAddressCache();
}
} catch (Exception e) {
throw new DnsCacheManipulatorException("Fail to getWholeDnsCache, cause: " + e, e);
}
}
/**
* Get dns cache entries, without negative cache.
*
* Same as {@code getWholeDnsCache().getCache()}
*
* @return dns cache entries
* @throws DnsCacheManipulatorException Operation fail
* @see #getWholeDnsCache()
* @since 1.2.0
*/
public static List listDnsCache() {
return getWholeDnsCache().getCache();
}
/**
* Get dns cache entries, without negative cache.
*
* @return dns cache entries
* @throws DnsCacheManipulatorException Operation fail
* @deprecated this method name is confused: method name is "all" but without negative cache.
* use {@link #listDnsCache} instead.
*/
@Deprecated
@SuppressWarnings("DeprecatedIsStillUsed")
public static List getAllDnsCache() {
return listDnsCache();
}
/**
* Get dns negative cache entries.
*
* Same as {@code getWholeDnsCache().getNegativeCache()}
*
* @return dns negative cache entries
* @throws DnsCacheManipulatorException Operation fail
* @see #getWholeDnsCache()
* @since 1.6.0
*/
public static List listDnsNegativeCache() {
return getWholeDnsCache().getNegativeCache();
}
/**
* Remove dns cache entry(including cache and negative cache), cause lookup dns server for host after.
*
* @param host host
* @throws DnsCacheManipulatorException Operation fail
* @see DnsCacheManipulator#clearDnsCache
*/
public static void removeDnsCache(String host) {
try {
if (isJavaVersionAtMost8()) {
InetAddressCacheUtilForJava8Minus.removeInetAddressCache(host);
} else {
InetAddressCacheUtilForJava9Plus.removeInetAddressCache(host);
}
} catch (Exception e) {
final String message = String.format("Fail to removeDnsCache for host %s, cause: %s", host, e);
throw new DnsCacheManipulatorException(message, e);
}
}
/**
* Clear whole dns cache entries(including cache and negative cache), cause lookup dns server for all host after.
*
* @throws DnsCacheManipulatorException Operation fail
*/
public static void clearDnsCache() {
try {
if (isJavaVersionAtMost8()) {
InetAddressCacheUtilForJava8Minus.clearInetAddressCache();
} else {
InetAddressCacheUtilForJava9Plus.clearInetAddressCache();
}
} catch (Exception e) {
throw new DnsCacheManipulatorException("Fail to clearDnsCache, cause: " + e, e);
}
}
/**
* Get JVM DNS cache policy.
*
* @return cache seconds.
*
* - {@link InetAddressCachePolicy#FOREVER}({@code -1}) means never expired.(In effect, all negative value)
* - {@link InetAddressCachePolicy#NEVER}({@code 0}) never cached.
*
* @throws DnsCacheManipulatorException Operation fail
* @see InetAddressCachePolicy#get()
* @see InetAddressCachePolicy#FOREVER
* @see InetAddressCachePolicy#NEVER
* @see InetAddressCachePolicy#DEFAULT_POSITIVE
* @since 1.3.0
*/
public static int getDnsCachePolicy() {
try {
return InetAddressCacheUtilCommons.getDnsCachePolicy();
} catch (Exception e) {
throw new DnsCacheManipulatorException("Fail to getDnsCachePolicy, cause: " + e, e);
}
}
/**
* Set JVM DNS cache policy.
*
* NOTE: if Security Manage is turn on, JVM DNS cache policy set will not take effective. You can check by method {@link #getDnsCachePolicy()}.
*
* @param cacheSeconds set default dns cache time. Special input case:
*
* - {@link InetAddressCachePolicy#FOREVER}({@code -1}) means never expired.(In effect, all negative value)
* - {@link InetAddressCachePolicy#NEVER}({@code 0}) never cached.
*
* @throws DnsCacheManipulatorException Operation fail
* @see InetAddressCachePolicy
* @see InetAddressCachePolicy#cachePolicy
* @see InetAddressCachePolicy#get()
* @see InetAddressCachePolicy#FOREVER
* @see InetAddressCachePolicy#NEVER
* @see InetAddressCachePolicy#DEFAULT_POSITIVE
* @since 1.3.0
*/
public static void setDnsCachePolicy(int cacheSeconds) {
try {
InetAddressCacheUtilCommons.setDnsCachePolicy(cacheSeconds);
} catch (Exception e) {
throw new DnsCacheManipulatorException("Fail to setDnsCachePolicy, cause: " + e, e);
}
}
/**
* JVM DNS negative cache policy.
*
* @return negative cache seconds.
*
* - {@link InetAddressCachePolicy#FOREVER}({@code -1}) means never expired.(In effect, all negative value)
* - {@link InetAddressCachePolicy#NEVER}({@code 0}) never cached.
*
* @throws DnsCacheManipulatorException Operation fail
* @see InetAddressCachePolicy#getNegative()
* @see InetAddressCachePolicy#FOREVER
* @see InetAddressCachePolicy#NEVER
* @since 1.3.0
*/
public static int getDnsNegativeCachePolicy() {
try {
return InetAddressCacheUtilCommons.getDnsNegativeCachePolicy();
} catch (Exception e) {
throw new DnsCacheManipulatorException("Fail to getDnsNegativeCachePolicy, cause: " + e, e);
}
}
/**
* Set JVM DNS negative cache policy.
*
* @param negativeCacheSeconds set default dns cache time. Special input case:
*
* - {@link InetAddressCachePolicy#FOREVER}({@code -1}) means never expired.(In effect, all negative value)
* - {@link InetAddressCachePolicy#NEVER}({@code 0}) never cached.
*
* @throws DnsCacheManipulatorException Operation fail
* @see InetAddressCachePolicy
* @see InetAddressCachePolicy#FOREVER
* @see InetAddressCachePolicy#NEVER
* @since 1.3.0
*/
public static void setDnsNegativeCachePolicy(int negativeCacheSeconds) {
try {
InetAddressCacheUtilCommons.setDnsNegativeCachePolicy(negativeCacheSeconds);
} catch (Exception e) {
throw new DnsCacheManipulatorException("Fail to setDnsNegativeCachePolicy, cause: " + e, e);
}
}
private DnsCacheManipulator() {
}
}