Package com.intellij.openapi.externalSystem.service

Interface RemoteExternalSystemFacade<S extends ExternalSystemExecutionSettings>

All Superinterfaces:

ExternalSystemTaskAware, java.rmi.Remote

All Known Implementing Classes:

AbstractExternalSystemFacadeImpl, ExternalSystemFacadeWrapper, InProcessExternalSystemFacadeImpl, RemoteExternalSystemFacadeImpl

public interface RemoteExternalSystemFacade<S extends ExternalSystemExecutionSettings>
extends java.rmi.Remote, ExternalSystemTaskAware

Serves as a facade for working with external system which might be located at an external (non-ide) process.

The main idea is that we don't want to use it directly from an ide process (to avoid unnecessary heap/perm gen pollution, memory leaks etc). So, we use it at external process and current class works as a facade to it from ide process.

Field Summary

Fields

Modifier and Type	Field and Description
static RemoteExternalSystemFacade<?>	NULL_OBJECT Null object for RemoteExternalSystemFacade.

Method Summary

Modifier and Type	Method and Description
void	applyProgressManager(RemoteExternalSystemProgressNotificationManager progressManager) Asks remote external system process to use given progress manager.
void	applySettings(S settings) Asks remote external system process to apply given settings.
<any>	getRawProjectResolver() Same as getResolver(), but operating on raw result
RemoteExternalSystemProjectResolver<S>	getResolver() Exposes 'resolve external system project' service that works at another process.
RemoteExternalSystemTaskManager<S>	getTaskManager() Exposes 'run external system task' service which works at another process.

Methods inherited from interface com.intellij.openapi.externalSystem.service.internal.ExternalSystemTaskAware

cancelTask, getTasksInProgress, isTaskInProgress

Field Detail

NULL_OBJECT

static final RemoteExternalSystemFacade<?> NULL_OBJECT

Null object for RemoteExternalSystemFacade.

Method Detail

getResolver

RemoteExternalSystemProjectResolver<S> getResolver()
                                            throws java.rmi.RemoteException,
                                                   java.lang.IllegalStateException

Exposes 'resolve external system project' service that works at another process.

Returns:

'resolve external system project' service

Throws:

java.rmi.RemoteException - in case of unexpected I/O exception during processing

java.lang.IllegalStateException - in case of inability to create the service

getTaskManager

RemoteExternalSystemTaskManager<S> getTaskManager()
                                           throws java.rmi.RemoteException

Exposes 'run external system task' service which works at another process.

Returns:

external system build manager

Throws:

java.rmi.RemoteException - in case of inability to create the service

applySettings

void applySettings(S settings)
            throws java.rmi.RemoteException

Asks remote external system process to apply given settings.

Parameters:

settings - settings to apply

Throws:

java.rmi.RemoteException - in case of unexpected I/O exception during processing

applyProgressManager

void applyProgressManager(RemoteExternalSystemProgressNotificationManager progressManager)
                   throws java.rmi.RemoteException

Asks remote external system process to use given progress manager.

Parameters:

progressManager - progress manager to use

Throws:

java.rmi.RemoteException - in case of unexpected I/O exception during processing

getRawProjectResolver

<any> getRawProjectResolver()
                     throws java.rmi.RemoteException

Same as getResolver(), but operating on raw result

Returns:

Throws:

java.rmi.RemoteException