org.eclipse.urischeme.IOperatingSystemRegistration Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2018 SAP SE 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:
* SAP SE - initial version
*******************************************************************************/
package org.eclipse.urischeme;
import java.util.Collection;
import java.util.List;
import org.eclipse.core.runtime.Platform;
import org.eclipse.urischeme.internal.registration.RegistrationLinux;
import org.eclipse.urischeme.internal.registration.RegistrationMacOsX;
import org.eclipse.urischeme.internal.registration.RegistrationWindows;
/**
* Interface for registration or uri schemes in the different operating systems
* (macOS, Linux and Windows)
* Call getInstance() to get an OS specific instance.
*/
public interface IOperatingSystemRegistration {
/**
* Returns the operating system specific implementation of
* IOperatingSystemRegistration
*
* @return an instance of IOperatingSystemRegistration
*/
static IOperatingSystemRegistration getInstance() {
if (Platform.OS_MACOSX.equals(Platform.getOS())) {
return new RegistrationMacOsX();
} else if (Platform.OS_LINUX.equals(Platform.getOS())) {
return new RegistrationLinux();
} else if (Platform.OS_WIN32.equals(Platform.getOS())) {
return new RegistrationWindows();
}
return null;
}
/**
* Registers/Unregisters uri schemes for this Eclipse installation
*
* @param toAdd the uri schemes which this Eclipse should handle additionally
* @param toRemove the uri schemes which this Eclipse should not handle anymore
* @throws Exception something went wrong
*/
void handleSchemes(Collection toAdd, Collection toRemove) throws Exception;
/**
* Takes the given schemes and fills information like whether they are
* registered for this instance and the handler location.
*
* Note: On macOS this is a long running operation any may need
* multiple seconds to finish. So this should not be called in the UI
* thread.
*
* @param schemes The schemes that should be checked for registrations.
* @return schemes with information
* @throws Exception something went wrong
*/
List getSchemesInformation(Collection schemes) throws Exception;
/**
* @return the Eclipse executable
*/
String getEclipseLauncher();
/**
*
* This method returns if the current operating system allows to register an uri
* scheme that this already handled by another application.
*
* If the operating system does store this information in de-central way the
* implementation should return false.
*
* @return true if registering of other application's uri scheme is
* supported - false otherwise.
*/
boolean canOverwriteOtherApplicationsRegistration();
/**
* This method returns if the current operating system allows to register uri
* schemes at all.
*
* @return true if the registration of uri schemes is supported -
* false otherwise.
*/
boolean supportsRegistration();
}