InputConnector (Common Connector Framework API)

Skip navigation links

IBM ^TM
Common^TM Connector API

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

Connector

All Known Subinterfaces:

PollingInputConnector

All Known Implementing Classes:

AbstractInputConnector, AbstractInputConnectorFilter, AbstractPollingInputConnector
```
public interface InputConnector
extends Connector
```
The interface for connectors intended to listen for incoming events or data. Input connectors have additional steps in their lifecycle to start and stop listening. Pause can be considered the same as stop, and resume start.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`isStarted()`
`void`	`start()` Lifecycle method to put the input connector into a listening state
`void`	`stop()` Lifecycle method to put the input connector into a not-listening state

Methods inherited from interface com.ibm.connectors.Connector
getCallback, getConnectorServices, getLogger, getName, getProperties, initialise, terminate

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    See Also:
    
    Constant Field Values
- Method Detail
  - start
```
void start()
    throws ConnectorException
```
    Lifecycle method to put the input connector into a listening state
    
    Throws:
    
    ConnectorException
  - isStarted
```
boolean isStarted()
```
    Returns:
    
    is the connector listening?
  - stop
```
void stop()
   throws ConnectorException
```
    Lifecycle method to put the input connector into a not-listening state
    
    Throws:
    
    ConnectorException