Package com.intellij.openapi.externalSystem.service.remote.wrapper

Class ExternalSystemFacadeWrapper<S extends ExternalSystemExecutionSettings>

java.lang.Object

com.intellij.openapi.externalSystem.service.remote.wrapper.ExternalSystemFacadeWrapper<S>

All Implemented Interfaces:

ExternalSystemTaskAware, RemoteExternalSystemFacade<S>, java.rmi.Remote

public class ExternalSystemFacadeWrapper<S extends ExternalSystemExecutionSettings>
extends java.lang.Object
implements RemoteExternalSystemFacade<S>

This class acts as a point where target remote external system services are proxied.

Check service wrapper contracts for more details.

Thread-safe.

Field Summary

Fields inherited from interface com.intellij.openapi.externalSystem.service.RemoteExternalSystemFacade

NULL_OBJECT

Constructor Summary

Constructors

Constructor and Description
ExternalSystemFacadeWrapper(RemoteExternalSystemFacade<S> delegate, RemoteExternalSystemProgressNotificationManager progressManager)

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.
boolean	cancelTask(ExternalSystemTaskId id) Allows to cancel the target task by the current service.
RemoteExternalSystemFacade<S>	getDelegate()
<any>	getRawProjectResolver() Same as RemoteExternalSystemFacade.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.
java.util.Map<ExternalSystemTaskType,java.util.Set<ExternalSystemTaskId>>	getTasksInProgress() Allows to ask current service for all tasks being executed at the moment.
boolean	isTaskInProgress(ExternalSystemTaskId id) Allows to check if current service executes the target task.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExternalSystemFacadeWrapper

public ExternalSystemFacadeWrapper(RemoteExternalSystemFacade<S> delegate,
                                   RemoteExternalSystemProgressNotificationManager progressManager)

Method Detail

getDelegate

public RemoteExternalSystemFacade<S> getDelegate()

getResolver

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

Description copied from interface: RemoteExternalSystemFacade

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

Specified by:

getResolver in interface RemoteExternalSystemFacade<S extends ExternalSystemExecutionSettings>

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

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

Description copied from interface: RemoteExternalSystemFacade

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

Specified by:

getTaskManager in interface RemoteExternalSystemFacade<S extends ExternalSystemExecutionSettings>

Returns:

external system build manager

Throws:

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

applySettings

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

Description copied from interface: RemoteExternalSystemFacade

Asks remote external system process to apply given settings.

Specified by:

applySettings in interface RemoteExternalSystemFacade<S extends ExternalSystemExecutionSettings>

Parameters:

settings - settings to apply

Throws:

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

applyProgressManager

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

Description copied from interface: RemoteExternalSystemFacade

Asks remote external system process to use given progress manager.

Specified by:

applyProgressManager in interface RemoteExternalSystemFacade<S extends ExternalSystemExecutionSettings>

Parameters:

progressManager - progress manager to use

Throws:

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

getRawProjectResolver

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

Description copied from interface: RemoteExternalSystemFacade

Same as RemoteExternalSystemFacade.getResolver(), but operating on raw result

Specified by:

getRawProjectResolver in interface RemoteExternalSystemFacade<S extends ExternalSystemExecutionSettings>

Returns:

Throws:

java.rmi.RemoteException

isTaskInProgress

public boolean isTaskInProgress(ExternalSystemTaskId id)
                         throws java.rmi.RemoteException

Description copied from interface: ExternalSystemTaskAware

Allows to check if current service executes the target task.

Specified by:

isTaskInProgress in interface ExternalSystemTaskAware

Parameters:

id - target task's id

Returns:

true if a task with the given id is executed at the moment by the current service; false otherwise

Throws:

java.rmi.RemoteException - as required by RMI

getTasksInProgress

public java.util.Map<ExternalSystemTaskType,java.util.Set<ExternalSystemTaskId>> getTasksInProgress()
                                                                                             throws java.rmi.RemoteException

Description copied from interface: ExternalSystemTaskAware

Allows to ask current service for all tasks being executed at the moment.

Specified by:

getTasksInProgress in interface ExternalSystemTaskAware

Returns:

ids of all tasks being executed at the moment grouped by type

Throws:

java.rmi.RemoteException - as required by RMI

cancelTask

public boolean cancelTask(ExternalSystemTaskId id)
                   throws java.rmi.RemoteException

Description copied from interface: ExternalSystemTaskAware

Allows to cancel the target task by the current service.

Specified by:

cancelTask in interface ExternalSystemTaskAware

Parameters:

id - target task's id

Returns:

true if a task was successfully canceled; false otherwise

Throws:

java.rmi.RemoteException - as required by RMI