javapns.communication.ProxyManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javapns-jdk16 Show documentation
Library to send notifications using APNS
There is a newer version: 2.4.0
package javapns.communication;

/**
 * Main class for dealing with proxies.
 * 
 * @author Sylvain Pedneault
 */
public class ProxyManager {

	private static final String LOCAL_PROXY_HOST_PROPERTY = "javapns.communication.proxyHost";
	private static final String LOCAL_PROXY_PORT_PROPERTY = "javapns.communication.proxyPort";

	private static final String JVM_PROXY_HOST_PROPERTY = "https.proxyHost";
	private static final String JVM_PROXY_PORT_PROPERTY = "https.proxyPort";


	private ProxyManager() {
	}


	/**
	 * Configure a proxy to use for HTTPS connections created by JavaPNS.
	 * 
	 * @param host the proxyHost
	 * @param port the proxyPort
	 */
	public static void setProxy(String host, String port) {
		System.setProperty(LOCAL_PROXY_HOST_PROPERTY, host);
		System.setProperty(LOCAL_PROXY_PORT_PROPERTY, port);
	}


	/**
	 * Configure a proxy to use for HTTPS connections created anywhere in the JVM (not recommended).
	 * 
	 * @param host the proxyHost
	 * @param port the proxyPort
	 */
	public static void setJVMProxy(String host, String port) {
		System.setProperty(JVM_PROXY_HOST_PROPERTY, host);
		System.setProperty(JVM_PROXY_PORT_PROPERTY, port);
	}


	/**
	 * Get the proxy host address currently configured.
	 * This method checks if a server-specific proxy has been configured,
	 * then checks if a proxy has been configured for the entire library,
	 * and finally checks if a JVM-wide proxy setting is available for HTTPS.
	 * @param server a specific server to check for proxy settings (may be null)
	 * @return a proxy host, or null if none is configured
	 */
	public static String getProxyHost(AppleServer server) {
		String host = server != null ? server.getProxyHost() : null;
		if (host != null && host.length() > 0) {
			return host;
		} else {
			host = System.getProperty(LOCAL_PROXY_HOST_PROPERTY);
			if (host != null && host.length() > 0) {
				return host;
			} else {
				host = System.getProperty(JVM_PROXY_HOST_PROPERTY);
				if (host != null && host.length() > 0) {
					return host;
				} else {
					return null;
				}
			}
		}
	}


	/**
	 * Get the proxy port currently configured.
	 * This method first locates a proxy host setting, then returns the proxy port from the same location.
	 * @param server a specific server to check for proxy settings (may be null)
	 * @return a network port, or 0 if no proxy is configured
	 */
	public static int getProxyPort(AppleServer server) {
		String host = server != null ? server.getProxyHost() : null;
		if (host != null && host.length() > 0) {
			return server.getProxyPort();
		} else {
			host = System.getProperty(LOCAL_PROXY_HOST_PROPERTY);
			if (host != null && host.length() > 0) {
				return Integer.parseInt(System.getProperty(LOCAL_PROXY_PORT_PROPERTY));
			} else {
				host = System.getProperty(JVM_PROXY_HOST_PROPERTY);
				if (host != null && host.length() > 0) {
					return Integer.parseInt(System.getProperty(JVM_PROXY_PORT_PROPERTY));
				} else {
					return 0;
				}
			}
		}
	}


	/**
	 * Determine if a proxy is currently configured.
	 * @param server a specific server to check for proxy settings (may be null)
	 * @return true if a proxy is set, false otherwise
	 */
	public static boolean isUsingProxy(AppleServer server) {
		String proxyHost = getProxyHost(server);
		boolean proxyConfigured = proxyHost != null && proxyHost.length() > 0;
		return proxyConfigured;
	}

}