Package com.intellij.openapi.externalSystem.service

Class AbstractExternalSystemFacadeImpl<S extends ExternalSystemExecutionSettings>

java.lang.Object

com.intellij.execution.rmi.RemoteServer

com.intellij.openapi.externalSystem.service.AbstractExternalSystemFacadeImpl<S>

All Implemented Interfaces:

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

Direct Known Subclasses:

InProcessExternalSystemFacadeImpl, RemoteExternalSystemFacadeImpl

public abstract class AbstractExternalSystemFacadeImpl<S extends ExternalSystemExecutionSettings>
extends RemoteServer
implements RemoteExternalSystemFacade<S>

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.execution.rmi.RemoteServer

RemoteServer.Jndi

Field Summary

Fields inherited from class com.intellij.execution.rmi.RemoteServer

SERVER_HOSTNAME

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

NULL_OBJECT

Constructor Summary

Constructors

Constructor and Description
AbstractExternalSystemFacadeImpl(java.lang.Class<ExternalSystemProjectResolver<S>> projectResolverClass, java.lang.Class<ExternalSystemTaskManager<S>> buildManagerClass)

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.
protected abstract <I extends RemoteExternalSystemService<S>,C extends I> I	createService(java.lang.Class<I> interfaceClass, C impl) Generic method to retrieve exposed implementations of the target interface.
protected ExternalSystemTaskNotificationListener	getNotificationListener()
<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.
protected S	getSettings()
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.
protected void	init()
boolean	isTaskInProgress(ExternalSystemTaskId id) Allows to check if current service executes the target task.

Methods inherited from class com.intellij.execution.rmi.RemoteServer

setupRMI, start

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExternalSystemFacadeImpl

public AbstractExternalSystemFacadeImpl(java.lang.Class<ExternalSystemProjectResolver<S>> projectResolverClass,
                                        java.lang.Class<ExternalSystemTaskManager<S>> buildManagerClass)
                                 throws java.lang.IllegalAccessException,
                                        java.lang.InstantiationException

Throws:

java.lang.IllegalAccessException

java.lang.InstantiationException

Method Detail

init

protected void init()
             throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getSettings

protected S getSettings()

getNotificationListener

protected ExternalSystemTaskNotificationListener getNotificationListener()

getResolver

public RemoteExternalSystemProjectResolver<S> getResolver()
                                                   throws 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.lang.IllegalStateException - in case of inability to create the service

getRawProjectResolver

public <any> getRawProjectResolver()
                            throws java.lang.IllegalStateException

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.lang.IllegalStateException

getTaskManager

public RemoteExternalSystemTaskManager<S> getTaskManager()

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

createService

protected abstract <I extends RemoteExternalSystemService<S>,C extends I> I createService(java.lang.Class<I> interfaceClass,
                                                                                          C impl)
                                                                                   throws java.lang.ClassNotFoundException,
                                                                                          java.lang.IllegalAccessException,
                                                                                          java.lang.InstantiationException,
                                                                                          java.rmi.RemoteException

Generic method to retrieve exposed implementations of the target interface.

Uses cached value if it's found; creates new and caches it otherwise.

Type Parameters:

I - service interface class

C - service implementation

Parameters:

interfaceClass - target service interface class

impl - service implementation

Returns:

implementation of the target service

Throws:

java.lang.IllegalAccessException - in case of incorrect assumptions about server class interface

java.lang.InstantiationException - in case of incorrect assumptions about server class interface

java.lang.ClassNotFoundException - in case of incorrect assumptions about server class interface

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

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

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