diff options
Diffstat (limited to 'plugins/org.eclipse.wst.internet.cache/src/org/eclipse/wst/internet/cache/internal/LicenseRegistry.java')
| -rw-r--r-- | plugins/org.eclipse.wst.internet.cache/src/org/eclipse/wst/internet/cache/internal/LicenseRegistry.java | 249 |
1 files changed, 0 insertions, 249 deletions
diff --git a/plugins/org.eclipse.wst.internet.cache/src/org/eclipse/wst/internet/cache/internal/LicenseRegistry.java b/plugins/org.eclipse.wst.internet.cache/src/org/eclipse/wst/internet/cache/internal/LicenseRegistry.java deleted file mode 100644 index 2ffb248b1..000000000 --- a/plugins/org.eclipse.wst.internet.cache/src/org/eclipse/wst/internet/cache/internal/LicenseRegistry.java +++ /dev/null @@ -1,249 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2001, 2006 IBM Corporation and others. - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v1.0 - * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * IBM Corporation - initial API and implementation - *******************************************************************************/ -package org.eclipse.wst.internet.cache.internal; - -import java.text.MessageFormat; -import java.util.Hashtable; - -import org.eclipse.core.runtime.IStatus; -import org.eclipse.core.runtime.Status; -import org.eclipse.swt.widgets.Display; - -/** - * The license registry holds all of the registered licenses and whether or not they - * have been accepted. - */ -public class LicenseRegistry -{ - protected static Integer LICENSE_UNSPECIFIED = new Integer(0); // This needs to be 0 for the plugin prefs. - protected static Integer LICENSE_AGREE = new Integer(1); - protected static Integer LICENSE_DISAGREE = new Integer(2); - // Signifies a license that has been disagreed to this session. - protected static Integer LICENSE_DISAGREE_THIS_SESSION = new Integer(3); - - /** - * There is only one instance of the license registry. - */ - protected static LicenseRegistry instance = null; - - /** - * If set to true, the do not prompt flag will prevent user prompting. Used for automated testing. - */ - private boolean DO_NOT_PROMPT = false; - - /** - * The licenses hashtable contains licenses and whether or not they've been accepted. - */ - protected Hashtable licenses; - - protected LicenseRegistry() - { - licenses = new Hashtable(); - - // If the wtp quiet system property is set the DO_NOT_PROMPT flag is set to true. - // This is used for automated testing. - if(System.getProperty(CacheMessages.WTP_NO_USER_INTERACTION_SYSTEM_PROP, "false").equals("true")) - { - CachePlugin.getDefault().getLog().log(new Status(IStatus.INFO, CachePlugin.PLUGIN_ID, IStatus.OK, MessageFormat.format(CacheMessages._LOG_INFO_WTP_NO_USER_INTERACTION, new Object[]{CacheMessages.WTP_NO_USER_INTERACTION_SYSTEM_PROP}), null)); - DO_NOT_PROMPT = true; - } - } - - /** - * Get the one and only instance of the license registry. - * - * @return The one and only instance of the license registry. - */ - public static LicenseRegistry getInstance() - { - if(instance == null) - { - instance = new LicenseRegistry(); - } - return instance; - } - - /** - * Add the specified license to the license registry. A license can only be added to the - * registry once. - * - * @param url The URL of the license to add to the registry. - */ - public void addLicense(String url) - { - if(url != null && !licenses.containsKey(url)) - { - licenses.put(url, LICENSE_UNSPECIFIED); - } - } - - /** - * Agree to the specified license. The license is agreed to only if it has already - * been registered with the registry. - * - * @param url The URL of the license to accept. - */ - protected void agreeLicense(String url) - { - if(licenses.containsKey(url)) - { - licenses.put(url, LICENSE_AGREE); - } - } - - /** - * Disagree to the specified license. The license is disagreed to only if it has already - * been registered with the registry. - * - * @param url The URL of the license to accept. - */ - protected void disagreeLicense(String url) - { - if(licenses.containsKey(url)) - { - licenses.put(url, LICENSE_DISAGREE); - } - } - - /** - * Disagree to the specified license for this session. The license is disagreed to only if it has already - * been registered with the registry. - * - * @param url The URL of the license to accept. - */ - private void disagreeLicenseThisSession(String url) - { - if(licenses.containsKey(url)) - { - licenses.put(url, LICENSE_DISAGREE_THIS_SESSION); - } - } - - /** - * Determine if the license has been accepted. This method will return true if the license - * has been accepted or is not registered with the registry and false if it has not been accepted. - * - * @param url The URL of the resource for which we are checking the license. - * @param licenseURL The URL of the license that should be checked to see if it has been accepted. - * @return True if the license has been accepted or is not registered with the registry, false otherwise. - */ - public boolean hasLicenseBeenAccepted(String url, String licenseURL) - { - if(DO_NOT_PROMPT) - { - return true; - } - - if(licenses.containsKey(licenseURL)) - { - Integer agreed = (Integer)licenses.get(licenseURL); - if(agreed == LICENSE_AGREE) - { - return true; - } - else if(agreed == LICENSE_DISAGREE) - { - if(!CachePlugin.getDefault().shouldPrompt()) - return false; - licenses.put(licenseURL, LICENSE_DISAGREE_THIS_SESSION); - } - // The license has already been disagreed to this session. Do not prompt. - else if(agreed == LICENSE_DISAGREE_THIS_SESSION) - { - return false; - } - - - // Prompt the user to accept the license. - int licenseAcceptance = promptToAcceptLicense(url, licenseURL); - if(licenseAcceptance == Accepted.ACCEPTED) - { - agreeLicense(licenseURL); - return true; - } - else if(licenseAcceptance == Accepted.NOT_ACCEPTED) - { - disagreeLicenseThisSession(licenseURL); - return false; - } - return false; - } - - // The license is not registred with the registry. - return true; - } - - /** - * Prompt the user to accept the license. This method creates a LicenseAcceptanceDialog. - * - * @param url The URL of the resource for which the license needs to be accepted. - * @param licenseURL The URL of the license to be accepted. - * @return 0 if accepted, 1 if not accepted, 2 if not able to accept. - */ - protected int promptToAcceptLicense(final String url, final String licenseURL) - { - final Accepted accepted = new Accepted(); - Display.getDefault().syncExec(new Runnable() { - public void run() { - try - { - if(LicenseAcceptanceDialog.promptForLicense(null, url, licenseURL)) - { - accepted.accepted = Accepted.ACCEPTED; - } - else - { - accepted.accepted = Accepted.NOT_ACCEPTED; - } - } - catch(Exception e) - { - accepted.accepted = Accepted.NOT_DETERMINED; - } - } - }); - return accepted.accepted; - } - - /** - * Get an array containing all the licenses in the registry. - * - * @return As array containing all the licenses in the registry. - */ - protected String[] getLicenses() - { - return (String[])licenses.keySet().toArray(new String[licenses.keySet().size()]); - } - - /** - * Get the state of the license. - * - * @param url The URL of the license. - * @return The state of the license. - */ - protected Integer getLicenseState(String url) - { - return (Integer)licenses.get(url); - } - - - /** - * A class to hold acceptance information for the prompt method. - */ - private class Accepted - { - public static final int ACCEPTED = 0; - public static final int NOT_ACCEPTED = 1; - public static final int NOT_DETERMINED = 2; - public int accepted = NOT_ACCEPTED; - } - -} |