Java tutorial
/** * DSS - Digital Signature Services * Copyright (C) 2015 European Commission, provided under the CEF programme * * This file is part of the "DSS - Digital Signature Services" project. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ package eu.europa.esig.dss.client.http.proxy; import java.util.Collection; import java.util.HashSet; import java.util.Set; import org.apache.commons.lang.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import eu.europa.esig.dss.client.http.commons.DSSNotifier; /** * A proxy preference manager. * */ public class ProxyPreferenceManager { private static final Logger LOG = LoggerFactory.getLogger(ProxyPreferenceManager.class); private ProxyDao proxyDao; Set<DSSNotifier> notifiers = new HashSet<DSSNotifier>(); /** * Get list of excluded hosts of the HTTP proxy * * @return comma separated list of hosts */ public String getHttpExcludedHosts() { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTP_EXCLUDE); return preference != null ? preference.getValue() : StringUtils.EMPTY; } /** * Get list of excluded hosts of the HTTPS proxy * * @return comma separated list of hosts */ public String getHttpsExcludedHosts() { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTPS_EXCLUDE); return preference != null ? preference.getValue() : StringUtils.EMPTY; } /** * Get a {@link ProxyPreference} by its enum values. * * @param proxyKey * @return a preference */ public ProxyPreference get(ProxyKey proxyKey) { return getProxyDao().get(proxyKey); } /** * Get the host of the HTTP proxy * * @return the host */ public String getHttpHost() { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTP_HOST); return preference != null ? preference.getValue() : StringUtils.EMPTY; } /** * Get the password of HTTPS proxy * * @return the password */ public String getHttpPassword() { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTP_PASSWORD); return preference != null ? preference.getValue() : StringUtils.EMPTY; } /** * Get the port of the HTTP proxy * * @return the port */ public Long getHttpPort() { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTP_PORT); return preference != null ? Long.valueOf(preference.getValue()) : null; } /** * Get the host of the HTTPS proxy * * @return the host */ public String getHttpsHost() { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTPS_HOST); return preference != null ? preference.getValue() : StringUtils.EMPTY; } /** * Get the password of the HTTPS proxy * * @return the password */ public String getHttpsPassword() { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTPS_PASSWORD); return preference != null ? preference.getValue() : StringUtils.EMPTY; } /** * Get the port of the HTTPS proxy * * @return the port */ public Long getHttpsPort() { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTPS_PORT); return preference != null ? Long.valueOf(preference.getValue()) : null; } /** * Get the user of the HTTPS proxy * * @return the user */ public String getHttpsUser() { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTPS_USER); return preference != null ? preference.getValue() : StringUtils.EMPTY; } /** * Get the user for HTTP proxy * * @return the user */ public String getHttpUser() { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTP_USER); return preference != null ? preference.getValue() : StringUtils.EMPTY; } /** * Returns true if the HTTP proxy must be enabled. * * @return a boolean value */ public boolean isHttpEnabled() { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTP_ENABLED); if ((preference == null) || StringUtils.isEmpty(preference.getValue())) { return false; } else { return Boolean.valueOf(preference.getValue()).booleanValue(); } } /** * Returns true if the HTTPS proxy must be enabled. * * @return a boolean value */ public boolean isHttpsEnabled() { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTPS_ENABLED); if ((preference == null) || StringUtils.isEmpty(preference.getValue())) { return false; } else { return Boolean.valueOf(preference.getValue()).booleanValue(); } } /** * @return a list of {@link ProxyPreference} */ public Collection<ProxyPreference> list() { return getProxyDao().getAll(); } /** * @param enabled */ public void setHttpEnabled(boolean enabled) { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTP_ENABLED); preference.setValue(String.valueOf(enabled)); getProxyDao().update(preference); dssNotify(); } /** * @param host */ public void setHttpHost(String host) { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTP_HOST); preference.setValue(host); getProxyDao().update(preference); dssNotify(); } /** * @param password */ public void setHttpPassword(String password) { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTP_PASSWORD); preference.setValue(password); getProxyDao().update(preference); dssNotify(); } /** * @param port */ public void setHttpPort(Long port) { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTP_PORT); preference.setValue(port != null ? String.valueOf(port) : StringUtils.EMPTY); getProxyDao().update(preference); dssNotify(); } /** * @param enabled */ public void setHttpsEnabled(boolean enabled) { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTPS_ENABLED); preference.setValue(String.valueOf(enabled)); getProxyDao().update(preference); dssNotify(); } /** * @param host */ public void setHttpsHost(String host) { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTPS_HOST); preference.setValue(host); getProxyDao().update(preference); dssNotify(); } /** * @param password */ public void setHttpsPassword(String password) { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTPS_PASSWORD); preference.setValue(password); getProxyDao().update(preference); dssNotify(); } /** * @param port */ public void setHttpsPort(Long port) { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTPS_PORT); preference.setValue(port != null ? String.valueOf(port) : StringUtils.EMPTY); getProxyDao().update(preference); dssNotify(); } /** * @param user */ public void setHttpsUser(String user) { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTPS_USER); preference.setValue(user); getProxyDao().update(preference); dssNotify(); } /** * @param httpUser */ public void setHttpUser(String httpUser) { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTP_USER); preference.setValue(httpUser); getProxyDao().update(preference); dssNotify(); } /** * Set list of excluded hosts of the HTTP proxy * * @param list comma separated list of hosts */ public void setHttpExcludedHosts(String list) { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTP_EXCLUDE); preference.setValue(list); getProxyDao().update(preference); } /** * Set list of excluded hosts of the HTTPS proxy * * @param list comma separated list of hosts */ public void setHttpsExcludedHosts(String list) { ProxyPreference preference = getProxyDao().get(ProxyKey.HTTPS_EXCLUDE); preference.setValue(list); getProxyDao().update(preference); } /** * @param proxyDao */ public void setProxyDao(ProxyDao proxyDao) { this.proxyDao = proxyDao; dssNotify(); } /** * Gets the proxyDao * * @return the proxyDao */ private ProxyDao getProxyDao() { if (proxyDao == null) { throw new IllegalStateException("The proxyDao property must be set to use this class!"); } return proxyDao; } /** * @param proxyKey * @param value */ public void update(ProxyKey proxyKey, String value) { switch (proxyKey) { case HTTP_ENABLED: setHttpEnabled(Boolean.valueOf(value)); break; case HTTP_HOST: setHttpHost(value); break; case HTTP_PASSWORD: setHttpPassword(value); break; case HTTP_PORT: // TODO use regex to check if number setHttpPort(Long.valueOf(value)); break; case HTTP_USER: setHttpUser(value); break; case HTTP_EXCLUDE: setHttpExcludedHosts(value); break; case HTTPS_ENABLED: setHttpsEnabled(Boolean.valueOf(value)); break; case HTTPS_HOST: setHttpsHost(value); break; case HTTPS_PASSWORD: setHttpsPassword(value); break; case HTTPS_PORT: // FIXME use regex to check if number setHttpsPort(Long.valueOf(value)); break; case HTTPS_USER: setHttpsUser(value); break; case HTTPS_EXCLUDE: setHttpsExcludedHosts(value); break; } } private void dssNotify() { for (final DSSNotifier dssNotifier : notifiers) { LOG.trace(">>> NOTIFY: " + dssNotifier); dssNotifier.update(); } } /** * @param key * @param value */ public void update(String key, String value) { update(ProxyKey.fromKey(key), value); } /** * This method allows to declare a new object to be notified if any properties have changed. * * @param dssNotifier the object to be notified */ public void addNotifier(final DSSNotifier dssNotifier) { if (!notifiers.contains(dssNotifier)) { LOG.trace(">>> NOTIFIER ADDED: " + dssNotifier); notifiers.add(dssNotifier); } } @Override public String toString() { return "ProxyPreferenceManager{" + "proxyDao=" + proxyDao + '}'; } }