public interface IConnector
Modifier and Type | Method and Description |
---|---|
String |
check()
Test the connection.
|
void |
clearThreadContext()
Clear out any state information specific to a given thread.
|
void |
connect(ConfigParams configParams)
Connect.
|
void |
deinstall(IThreadContext threadContext)
Uninstall the connector.
|
void |
disconnect()
Close the connection.
|
ConfigParams |
getConfiguration()
Get configuration information.
|
void |
install(IThreadContext threadContext)
Install the connector.
|
boolean |
isConnected()
This method is called to assess whether to count this connector instance should
actually be counted as being connected.
|
void |
outputConfigurationBody(IThreadContext threadContext,
IHTTPOutput out,
Locale locale,
ConfigParams parameters,
String tabName)
Output the configuration body section.
|
void |
outputConfigurationHeader(IThreadContext threadContext,
IHTTPOutput out,
Locale locale,
ConfigParams parameters,
List<String> tabsArray)
Output the configuration header section.
|
void |
poll()
This method is periodically called for all connectors that are connected but not
in active use.
|
String |
processConfigurationPost(IThreadContext threadContext,
IPostParameters variableContext,
Locale locale,
ConfigParams parameters)
Process a configuration post.
|
void |
setThreadContext(IThreadContext threadContext)
Attach to a new thread.
|
void |
viewConfiguration(IThreadContext threadContext,
IHTTPOutput out,
Locale locale,
ConfigParams parameters)
View configuration.
|
void install(IThreadContext threadContext) throws ManifoldCFException
threadContext
- is the current thread context.ManifoldCFException
void deinstall(IThreadContext threadContext) throws ManifoldCFException
threadContext
- is the current thread context.ManifoldCFException
void connect(ConfigParams configParams)
configParams
- are the configuration parameters for this connection.String check() throws ManifoldCFException
ManifoldCFException
void poll() throws ManifoldCFException
ManifoldCFException
boolean isConnected()
void disconnect() throws ManifoldCFException
ManifoldCFException
ConfigParams getConfiguration()
void clearThreadContext()
void setThreadContext(IThreadContext threadContext) throws ManifoldCFException
threadContext
- is the new thread context.ManifoldCFException
void outputConfigurationHeader(IThreadContext threadContext, IHTTPOutput out, Locale locale, ConfigParams parameters, List<String> tabsArray) throws ManifoldCFException, IOException
threadContext
- is the local thread context.out
- is the output to which any HTML should be sent.locale
- is the locale that the output should use.parameters
- are the configuration parameters, as they currently exist, for this connection being configured.tabsArray
- is an array of tab names. Add to this array any tab names that are specific to the connector.ManifoldCFException
IOException
void outputConfigurationBody(IThreadContext threadContext, IHTTPOutput out, Locale locale, ConfigParams parameters, String tabName) throws ManifoldCFException, IOException
threadContext
- is the local thread context.out
- is the output to which any HTML should be sent.locale
- is the locale that the output should use.parameters
- are the configuration parameters, as they currently exist, for this connection being configured.tabName
- is the current tab name.ManifoldCFException
IOException
String processConfigurationPost(IThreadContext threadContext, IPostParameters variableContext, Locale locale, ConfigParams parameters) throws ManifoldCFException
threadContext
- is the local thread context.variableContext
- is the set of variables available from the post, including binary file post information.locale
- is the locale that the output should use.parameters
- are the configuration parameters, as they currently exist, for this connection being configured.ManifoldCFException
void viewConfiguration(IThreadContext threadContext, IHTTPOutput out, Locale locale, ConfigParams parameters) throws ManifoldCFException, IOException
threadContext
- is the local thread context.out
- is the output to which any HTML should be sent.locale
- is the locale that the output should use.parameters
- are the configuration parameters, as they currently exist, for this connection being configured.ManifoldCFException
IOException