|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Field Summary | |
---|---|
static String |
copyright
|
static boolean |
FORCE_INTO_MEMORY
|
static boolean |
LAZILY
|
Method Summary | |
---|---|
void |
addCommonRemoteActions(SystemMenuManager menu,
IStructuredSelection selection,
Shell shell,
String menuGroup,
SubSystem subsystem)
Returns any framework-supplied actions remote objects that should be contributed to the popup menu for the given selection list. |
void |
changingSystemProfileActiveStatus(SystemProfile profile,
boolean newStatus)
Called by SystemRegistry when we have toggled the active-status of a profile |
SubSystem |
cloneSubSystem(SubSystem oldSubsystem,
SystemConnection newConnection,
boolean copyProfileOperation)
Clone a given subsystem into the given connection. |
SystemFilterPoolManager |
copyFilterPoolManager(SystemProfile oldProfile,
SystemProfile newProfile)
Copy the filter pool manager and return a new one. |
SystemFilter |
createFilterByPrompting(SystemFilterReference referenceToPromptableFilter,
Shell shell)
Prompt the user to create a new filter as a result of the user expanding a promptable filter. |
SubSystem |
createSubSystem(SystemConnection conn,
boolean creatingConnection,
ISystemNewConnectionWizardPage[] yourNewConnectionWizardPages)
Creates a new subsystem instance that is associated with the given connection object. |
void |
customizeChangeFilterPropertyPage(SystemChangeFilterPropertyPage page,
SystemFilter selectedFilter,
Shell shell)
In addition to a change filter action, we now also support the same functionality via a Properties page for filters. |
void |
customizeFilterStringPropertyPage(SystemFilterStringPropertyPage page,
SystemFilterString selectedFilterString,
Shell shell)
In addition to a change filter action, we now also support the same functionality via a Properties page for filter strings, in the Team View. |
boolean |
deleteSubSystem(SubSystem subsystem)
Deletes a given subsystem instance from the list maintained by this factory. |
void |
deleteSubSystemsByConnection(SystemConnection conn)
Called by SystemRegistry's deleteConnection method to ensure we delete all our subsystems for a given connection. |
void |
deletingSystemProfile(SystemProfile profile)
Called by SystemRegistry when we are about to delete a profile. |
void |
disconnectAllSubSystems()
Disconnect all subsystems currently connected. |
SystemUDActionSubsystem |
getActionSubSystem(SubSystem subsystem)
Get the action subsystem object for this subsystemfactory, and set its current subsystem to the given subsystem instance. |
String |
getCategory()
Return the category this subsystem factory subscribes to. |
SystemCompileManager |
getCompileManager()
Get the singleton compile manager responsible for enabling the compile support for remote source objects. |
SystemFilterPool |
getDefaultSystemFilterPool(SubSystem subsys)
Given a subsystem, return the first (hopefully only) default pool for this subsystem's profile. |
IAction[] |
getFilterActions(SystemFilter selectedFilter,
Shell shell)
Returns a list of actions for the popup menu when user right clicks on a filter object. |
IAction[] |
getFilterPoolActions(SystemFilterPool selectedPool,
Shell shell)
Returns a list of actions for the popup menu when user right clicks on a filter pool object within a subsystem of this factory. |
SystemFilterPoolManager |
getFilterPoolManager(SystemProfile profile)
Get the filter pool manager for the given profile |
EList |
getFilterPoolManagerList()
Private. |
IAction[] |
getFilterPoolReferenceActions(SystemFilterPoolReference selectedPoolReference,
Shell shell)
Returns a list of actions for the popup menu when user right clicks on a filter pool reference object within a subsystem of this factory. |
IAction[] |
getFilterReferenceActions(SystemFilterReference selectedFilterRef,
Shell shell)
Returns a list of actions for the popup menu when user right clicks on a filter reference object within a subsystem of this factory. |
Image |
getGraphicsImage()
Return actual graphics Image of this factory. |
Image |
getGraphicsLiveImage()
Return actual graphics LiveImage of this factory. |
String |
getId()
Return unique id of this factory. |
ImageDescriptor |
getImage()
Return image descriptor for subsystems created by this factory. |
ImageDescriptor |
getLiveImage()
Return image to use when this susystem is connection. |
String |
getName()
Return name of this factory. |
ISystemNewConnectionWizardPage[] |
getNewConnectionWizardPages(IWizard wizard)
Optionally return one or more wizard pages to append to the New Connection Wizard if the user selects a system type that this subsystem factory supports. |
ISystemValidator |
getPasswordValidator()
Return the validator for the password which is prompted for at runtime. |
ISystemValidator |
getPortValidator()
Return the validator for the port. |
IServerLauncherForm |
getServerLauncherForm(Shell shell,
ISystemMessageLine msgLine)
Return the form used in the property page, etc for this server launcher. |
IAction[] |
getSubSystemActions(SubSystem selectedSubSystem,
Shell shell)
Returns a list of actions for the popup menu when user right clicks on a subsystem object from this factory. |
ISubSystemFactoryProxy |
getSubSystemFactoryProxy()
Private method |
EList |
getSubSystemList()
Private. |
ISystemSubSystemPropertyPageCoreForm |
getSubSystemPropertyPageCoreFrom(ISystemMessageLine msgLine,
Object caller)
|
SubSystem[] |
getSubSystems(boolean force)
Returns a list of all subsystem objects for all connections. |
SubSystem[] |
getSubSystems(SystemConnection conn,
boolean force)
Returns a list of subsystem objects existing for the given connection. |
SystemProfile |
getSystemProfile(SystemFilterPool pool)
Get owning profile object given a filter pool object |
String[] |
getSystemTypes()
Return the system types this subsystem factory supports. |
String |
getTranslatedFilterTypeProperty(SystemFilter selectedFilter)
Return the translated string to show in the property sheet for the type property when a filter is selected. |
ISystemValidator |
getUserIdValidator()
Return the validator for the userId. |
String |
getVendor()
Return vendor of this factory. |
boolean |
isCaseSensitive()
Tell us if filter strings are case sensitive. |
boolean |
isPortEditable()
Return true (default) or false to indicate if subsystems of this factory support user-editable port numbers. |
boolean |
isSubSystemsDeletable()
Returns true if this factory allows users to delete instances of subsystem objects. |
void |
preTestRenameSubSystemProfile(String oldProfileName)
Called by SystemRegistry's renameSystemProfile method to pre-test if we are going to run into errors on a profile rename, due to file or folder in use. |
boolean |
providesCustomDropInFilters()
Return true if filters of this subsystem factory provide a custom implementation of drop support. |
void |
renameSubSystem(SubSystem subsystem,
String newName)
Renames a subsystem. |
void |
renameSubSystemProfile(String oldProfileName,
String newProfileName)
Called by SystemRegistry's renameSystemProfile method to ensure we update our filter pool manager names (and their folders) This is called AFTER changing the profile's name!! |
void |
renameSubSystemProfile(SubSystem ss,
String oldProfileName,
String newProfileName)
Called by SystemRegistry's renameSystemProfile method to ensure we update our subsystem names within each subsystem. |
void |
renameSubSystemsByConnection(SystemConnection conn,
String newConnectionName)
Called by SystemRegistry's renameConnection method to ensure we update our connection names within each subsystem. |
void |
reset()
Reset for a full refresh from disk, such as after a team synch. |
boolean |
save()
Saves absolutely everything to disk. |
void |
saveSubSystem(SubSystem subsys)
Save one subsystem to disk. |
void |
setConnection(SystemConnection connection)
Called by adapters prior to asking for actions, in case the connection of the currently selected object is required by the action. |
void |
setCurrentSelection(Object[] selection)
Called by adapters prior to asking for actions. |
void |
setShowFilterPools(boolean show)
If we support filters, should we show filter pools in the remote system explorer? |
void |
setSubSystemFactoryProxy(ISubSystemFactoryProxy proxy)
Private method called by SystemPlugin |
void |
setSubSystemPort(Shell shell,
SubSystem subsystem,
int port)
Update the port for the given subsystem instance. |
void |
setSubSystemUserId(Shell shell,
SubSystem subsystem,
String userId)
Update the user ID for the given subsystem instance. |
boolean |
showChangeFilterStringsPropertyPage(SystemFilter filter)
Given a filter, decide whether to show the Filter Strings property page for this filter. |
boolean |
showFilterPools()
If we support filters, should we show filter pools in the remote system explorer? |
boolean |
showGenericShowInTableOnFilter()
Return true if we should show the show in table action in the popup for the given element. |
boolean |
showRefreshOnFilter()
Return true if we should show the refresh action in the popup for the given element. |
boolean |
supportsCommands()
Return true if subsystem instances from this factory support remote command execution Returns false in default implementation, and is usually only true for command subsystems. |
boolean |
supportsCompileActions()
Return true if you support compile actions for the remote system objects returned from expansion of subsystems created by this subsystem factory. |
boolean |
supportsDropInFilters()
Return true if filters of this subsystem factory support dropping into. |
boolean |
supportsFileTypes()
Return true if you support user-defined/managed named file types Returns false in default implementation. |
boolean |
supportsFilterCaching()
Required method for subsystem factory child classes. |
boolean |
supportsFilters()
Required method for subsystem factory child classes. |
boolean |
supportsFilterStringExport()
Return true if the subsystem supports the exporting of filter strings from it's filters RETURNS true BY DEFAULT |
boolean |
supportsMultipleFilterStrings()
Required method for subsystem factory child classes. |
boolean |
supportsMultiStringFilters()
Return true if the subsystem supports more than one filter string RETURNS true BY DEFAULT |
boolean |
supportsNestedFilters()
Required method for subsystem factory child classes if returning true from supportsFilters. |
boolean |
supportsProperties()
Return true if subsystem instances from this factory support getting and setting properties Returns false in default implementation, and not actually used yet. |
boolean |
supportsQuickFilters()
Return true if you support quick filters. |
boolean |
supportsServerLaunchProperties()
Tell us if this subsystem factory supports server launch properties, which allow the user to configure how the server-side code for these subsystems are started. |
boolean |
supportsServerLaunchType(ServerLaunchType serverLaunchType)
If supportsServerLaunchProperties() returns true, this method may be called by
the server launcher to decide if a given remote server launch type is supported or not.
|
boolean |
supportsSubSystemConnect()
Return true if subsystem instances from this factory support connect and disconnect actions Returns true in default implementation. |
boolean |
supportsTargets()
Tell us if this subsystem factory supports targets, which are destinations for pushes and builds. |
boolean |
supportsUserDefinedActions()
Return true if you support user-defined actions for the remote system objects returned from expansion of subsystems created by this subsystem factory |
boolean |
supportsUserDefinedActions(ISelection selection)
Return true if you support user-defined actions for the remote system objects explicitly given. |
boolean |
supportsUserId()
Return true (default) or false to indicate if subsystems of this factory require a userId to do connection or not. |
SubSystem[] |
testForActiveReferences(SystemProfile profile)
Test if any filter pools in the given profile are referenced by other profiles, which are active. |
void |
updateSubSystem(Shell shell,
SubSystem subsystem,
boolean updateUserId,
String userId,
boolean updatePort,
Integer port)
Updates user-editable attributes of an existing subsystem instance. |
Field Detail |
public static final String copyright
public static final boolean FORCE_INTO_MEMORY
public static final boolean LAZILY
Method Detail |
public void reset()
public boolean supportsUserId()
Returns true in default implementation.
public boolean supportsMultiStringFilters()
RETURNS true BY DEFAULT
public boolean supportsFilterStringExport()
RETURNS true BY DEFAULT
public boolean supportsSubSystemConnect()
Returns true in default implementation.
public boolean isPortEditable()
Returns true in default implementation.
public boolean supportsCommands()
Returns false in default implementation, and is usually only true for command subsystems.
public boolean supportsProperties()
Returns false in default implementation, and not actually used yet.
public boolean supportsFilters()
Returns true in default implementation.
public boolean supportsFilterCaching()
Returns true in default implementation.
public boolean supportsMultipleFilterStrings()
Returns true in default implementation.
public boolean supportsNestedFilters()
Returns false in default implementation.
public boolean supportsQuickFilters()
Not supported yet
public boolean supportsDropInFilters()
public boolean providesCustomDropInFilters()
public boolean supportsUserDefinedActions()
getActionSubSystem(SubSystem)
,
Returns false in default implementation.
public boolean supportsUserDefinedActions(ISelection selection)
getActionSubSystem(SubSystem)
,
#createActionSubSystem()
,
addCommonRemoteActions(SystemMenuManager, IStructuredSelection, Shell, String, SubSystem)
public boolean supportsCompileActions()
Returns false in default implementation.
public boolean supportsFileTypes()
Returns false in default implementation.
public boolean supportsTargets()
public boolean supportsServerLaunchProperties()
public boolean supportsServerLaunchType(ServerLaunchType serverLaunchType)
supportsServerLaunchProperties()
returns true, this method may be called by
the server launcher to decide if a given remote server launch type is supported or not.
ServerLaunchType
,
getServerLauncherForm(Shell, ISystemMessageLine)
public boolean isCaseSensitive()
Returns false in default implementation.
public void addCommonRemoteActions(SystemMenuManager menu, IStructuredSelection selection, Shell shell, String menuGroup, SubSystem subsystem)
menu
- The menu to contribute actions toselection
- The window's current selection.shell
- of viewer calling this. Most dialogs require a shell.menuGroup
- recommended menu group to add actions to. If added to another group, you must be sure to create that group first.subsystem
- the subsystem of the selectionpublic SystemUDActionSubsystem getActionSubSystem(SubSystem subsystem)
Called in the Work With User Actions and the User Actions cascading menu of the popup menu for remote objects.
public SystemCompileManager getCompileManager()
supportsCompileActions()
public ISystemNewConnectionWizardPage[] getNewConnectionWizardPages(IWizard wizard)
Some details:
createSubSystem(SystemConnection,boolean, ISystemNewConnectionWizardPage[])
method to create the
your subsystem for the connection. The same pages you return here are passed back to you so you can
interrogate them for the user-entered data and use it when creating the default subsystem instance.
AbstractSystemNewConnectionWizardPage
for your wizard page class.
public boolean showFilterPools()
public void setShowFilterPools(boolean show)
public void setSubSystemFactoryProxy(ISubSystemFactoryProxy proxy)
public ISubSystemFactoryProxy getSubSystemFactoryProxy()
public String getVendor()
public String getName()
public String getId()
public ImageDescriptor getImage()
public Image getGraphicsImage()
public ImageDescriptor getLiveImage()
public Image getGraphicsLiveImage()
public String getCategory()
ISubSystemFactoryCategories
public String[] getSystemTypes()
public void deletingSystemProfile(SystemProfile profile)
Our only mission is to delete the filter pool associated with it, because the registry has already called deleteSubSystemsByConnection for every subsystem of every connection owned by this profile.
public void changingSystemProfileActiveStatus(SystemProfile profile, boolean newStatus)
public SystemProfile getSystemProfile(SystemFilterPool pool)
public ISystemValidator getUserIdValidator()
This must be castable to ICellEditorValidator for the property sheet support.
public ISystemValidator getPasswordValidator()
public ISystemValidator getPortValidator()
public void renameSubSystemProfile(SubSystem ss, String oldProfileName, String newProfileName)
This is called AFTER changing the profile's name!!
public void preTestRenameSubSystemProfile(String oldProfileName) throws Exception
Exception
public void renameSubSystemProfile(String oldProfileName, String newProfileName)
This is called AFTER changing the profile's name!!
public void renameSubSystemsByConnection(SystemConnection conn, String newConnectionName)
Must be called prior to changing the connection's name!!
public void deleteSubSystemsByConnection(SystemConnection conn)
public SubSystem createSubSystem(SystemConnection conn, boolean creatingConnection, ISystemNewConnectionWizardPage[] yourNewConnectionWizardPages)
conn
- The connection to create a subsystem forcreatingConnection
- true if we are creating a connection, false if just creating
another subsystem for an existing connection.yourNewConnectionWizardPages
- The wizard pages you supplied to the New Connection wizard, via the
getNewConnectionWizardPages(IWizard)
method or null if you didn't override this method.public void updateSubSystem(Shell shell, SubSystem subsystem, boolean updateUserId, String userId, boolean updatePort, Integer port)
The subsystem will be saved to disk.
shell
- parent shell needed in case an error message is displayedsubsystem
- target of the update actionupdateUserId
- true if we are updating the userId, else false to ignore userIduserId
- new local user Id. Ignored if updateUserId is falseupdatePort
- true if we are updating the port, else false to ignore portport
- new local port value. Ignored if updatePort is falsepublic void setSubSystemPort(Shell shell, SubSystem subsystem, int port)
updateSubSystem(Shell,SubSystem,boolean,String,boolean,Integer)
public void setSubSystemUserId(Shell shell, SubSystem subsystem, String userId)
updateSubSystem(Shell,SubSystem,boolean,String,boolean,Integer)
public boolean isSubSystemsDeletable()
public boolean deleteSubSystem(SubSystem subsystem)
public SubSystem cloneSubSystem(SubSystem oldSubsystem, SystemConnection newConnection, boolean copyProfileOperation) throws Exception
oldSubsystem
- The subsystem to be clonednewConnection
- The connection into which to create and clone the old subsystemcopyProfileOperation
- Pass true if this is an profile-copy operation versus a connection-copy operation
Exception
public SubSystem[] getSubSystems(SystemConnection conn, boolean force)
conn
- System connection to retrieve subsystems forforce
- true if we should force all the subsystems to be restored from disk if not alreadypublic SubSystem[] getSubSystems(boolean force)
public void renameSubSystem(SubSystem subsystem, String newName)
public IAction[] getSubSystemActions(SubSystem selectedSubSystem, Shell shell)
public void disconnectAllSubSystems() throws Exception
Exception
public SystemFilterPoolManager getFilterPoolManager(SystemProfile profile)
public SystemFilterPoolManager copyFilterPoolManager(SystemProfile oldProfile, SystemProfile newProfile) throws Exception
Exception
public IAction[] getFilterPoolActions(SystemFilterPool selectedPool, Shell shell)
public SystemFilterPool getDefaultSystemFilterPool(SubSystem subsys)
public IAction[] getFilterPoolReferenceActions(SystemFilterPoolReference selectedPoolReference, Shell shell)
Only supported by subsystems that support filters.
public SubSystem[] testForActiveReferences(SystemProfile profile)
Called when user tries to make a profile inactive. We prevent this if there exists active references.
profile
- The profile being tested
public String getTranslatedFilterTypeProperty(SystemFilter selectedFilter)
public IAction[] getFilterActions(SystemFilter selectedFilter, Shell shell)
Only supported and used by subsystems that support filters.
Most actions are handled in this base, except if you have your own action for creating a new nested filter. In this case, override getNewFilterAction()
public void customizeChangeFilterPropertyPage(SystemChangeFilterPropertyPage page, SystemFilter selectedFilter, Shell shell)
public void customizeFilterStringPropertyPage(SystemFilterStringPropertyPage page, SystemFilterString selectedFilterString, Shell shell)
public boolean showRefreshOnFilter()
public boolean showGenericShowInTableOnFilter()
public SystemFilter createFilterByPrompting(SystemFilterReference referenceToPromptableFilter, Shell shell) throws Exception
Exception
public boolean showChangeFilterStringsPropertyPage(SystemFilter filter)
public IAction[] getFilterReferenceActions(SystemFilterReference selectedFilterRef, Shell shell)
Most actions are handled in this base, except if you have your own action for
creating a new filter. In this case, override getNewFilterAction()
To add additional actions, override getFilterReferenceActions(SystemFilterReference, Shell)
.
selectedFilterRef
- the currently selected filter referenceshell
- parent shell of viewer where the popup menu is being constructedpublic IServerLauncherForm getServerLauncherForm(Shell shell, ISystemMessageLine msgLine)
supportsServerLaunchProperties()
returns true.
public ISystemSubSystemPropertyPageCoreForm getSubSystemPropertyPageCoreFrom(ISystemMessageLine msgLine, Object caller)
public void setConnection(SystemConnection connection)
public void setCurrentSelection(Object[] selection)
public boolean save()
Totally handled for you!
Calls saveSubSystems() and saveFilterPools()
Exceptions are swallowed since we cannot deal with them on shutdown anyway!
public void saveSubSystem(SubSystem subsys) throws Exception
Exception
public EList getSubSystemList()
public EList getFilterPoolManagerList()
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |