Package com.intellij.openapi.externalSystem.service

Interface ExternalSystemCommunicationManager

All Known Implementing Classes:

InProcessExternalSystemCommunicationManager, RemoteExternalSystemCommunicationManager

public interface ExternalSystemCommunicationManager

External system integration consists of common 'external system' functionality and external system-specific code. There are at least two approaches how to work with that external system-specific code:

 

   
use it from the ide process;
   
create a slave process and perform external system-specific actions there;
 
 

E.g. when we work with particular external system api it might worth to do that at a separate process in order to avoid bad stuff like memory leaks to happen at the ide process. However, when external system-specific communication just starts new external system-process, there is no point in creating intermediate mediator process just to launch new process.

That's why that stuff is covered by the current interface, i.e. different implementations are supposed to provide different 'in process' modes.

Method Summary

Modifier and Type	Method and Description
RemoteExternalSystemFacade	acquire(java.lang.String id, ProjectSystemId externalSystemId) Creates new external system facade for the given arguments.
void	clear() Disposes all resources acquired by the current manager.
boolean	isAlive(RemoteExternalSystemFacade facade)
void	release(java.lang.String id, ProjectSystemId externalSystemId) Release resource acquired by the current manager

Method Detail

acquire

RemoteExternalSystemFacade acquire(java.lang.String id,
                                   ProjectSystemId externalSystemId)
                            throws java.lang.Exception

Creates new external system facade for the given arguments.

Parameters:

id - if for which new facade is to be created

externalSystemId - target external system id

Returns:

newly created facade for the given arguments (if it was possible to create one)

Throws:

java.lang.Exception - in case something goes wrong

release

void release(java.lang.String id,
             ProjectSystemId externalSystemId)
      throws java.lang.Exception

Release resource acquired by the current manager

Parameters:

id - resource id

externalSystemId - target external system id

Throws:

java.lang.Exception - in case something goes wrong

isAlive

boolean isAlive(RemoteExternalSystemFacade facade)

clear

void clear()

Disposes all resources acquired by the current manager.