Classes | Functions

Data Source Configurator Plugins

Classes

class  VCDataCenterManager
 Management object for direct control of Sessions and Data Center connections. More...
protocol  <VCDataSourceConfiguration>
 Implemented by user plugins to provide configuration for a data source. More...

Functions

(NSString *) + VCDataSourceConfiguration-p::typeConfigured
 Provides a reverse-DNS string giving the type of session that this configurator handles.
(NSString *) + VCDataSourceConfiguration-p::name
 Provides a human-readable name for this configurator.
(void) - VCDataSourceConfiguration-p::configureSession:asSheetForWindow:
 Implemented by subclasses to begin configuring a session.
(void) - VCDataSourceConfiguration-p::willClose
 Implemented by subclasses so configurators can cleanup.
(void) - VCDataSourceConfiguration-p::receiveConfigurationInfo:
 Implemented by subclasses to receive data from a session.
(void) - VCDataSourceConfiguration-p::setConfigurationDictionary:
 Implemented by subclasses to receive previously stored configuration data.

Detailed Description

Data source configuration plugins (also known as Configurators) are the simplest of client-side plugins in VisualCommander. They provide a GUI to allow the user to configure a single session type, and then package that configuration diction in an NSDictionary and send it to the session.

Configurators should be Cocoa loadable bundles, and must be stored in /Library/Application Support/VisualCommander/Data Source Configuration Plugins/. They should have a principal class which implements the VCDataSourceConfiguration protocol.


Function Documentation

- (void) configureSession: (id)  session
asSheetForWindow: (NSWindow *)  window 

When a configurator needs to actively configure a session, the data center manager will create an instance of the configurator (if it does not already exist for this session) and then call this method on it. The configurator should present its configuration window as a sheet attached to the provided window.

Parameters:
sessionThe session object that will be configured.
windowThe window that the should be the parent for the configuration sheet.
+ (NSString *) name

Provides a human-readable name for this configurator, to be displayed in user interface elements.

Returns:
The human-readable name.
- (void) receiveConfigurationInfo: (NSDictionary *)  info [optional, inherited]

If the session to be configured provides any configuration information to its configurator, that information will be passed in via calls to this function by the data center manager. Subclasses should override this function if they need to handle such information.

Parameters:
infoA dictionary of the data provided to the configurator by the session.
- (void) setConfigurationDictionary: (NSDictionary *)  info [optional, inherited]

When a session is re-configured from stored configuration data, this method will be called to provide the stored data.

Parameters:
infoA dictionary of the data provided to the configurator by the session.
+ (NSString *) typeConfigured

Provides a reverse-DNS string giving the type of session that this configurator handles. The string should match the type provided by the data source plugin that the configurator wishes to configure.

Returns:
The type string.
- (void) willClose

If the configurator uses bindings, then the object controller retains it, and must thus be released before the configurator can become deallocated. This message is only sent by VisualCommander internally.