Contents

  • About this document
  • Audience
  • Related documents
  • Typographic conventions
  • Markup conventions
  • New in this release
  • New in WebSphere InterChange Server v4.2.2 and WebSphere Business Integration Adapters v2.4.0
  • New in WebSphere InterChange Server v4.2.1 and WebSphere Business Integration Adapters v2.3.0
  • New in WebSphere Business Integration Adapters 2.2.0
  • New in WebSphere Business Integration Adapters 2.1
  • New in WebSphere Business Integration Adapters 2.0.1
  • New in WebSphere Business Integration Adapters 2.0
  • Getting started

  • Introduction to connector development
  • Adapters in the WebSphere business integration system
  • Connector components
  • Event-triggered flow
  • Tools for adapter development
  • Overview of the connector development process
  • Building a connector

  • Designing a connector
  • Scope of a connector development project
  • Designing the connector architecture
  • Designing application-specific business objects
  • Event notification
  • Communication across operating systems
  • Summary set of planning questions
  • An internationalized connector
  • Providing general connector functionality
  • Running a connector
  • Extending the connector base class
  • Handling errors
  • Using connector configuration property values
  • Calling a data handler
  • Handling loss of connection to an application
  • Request processing
  • Designing business object handlers
  • Extending the business-object-handler base class
  • Handling the request
  • Performing the verb action
  • Handling the Create verb
  • Handling the Retrieve verb
  • Handling the RetrieveByContent verb
  • Handling the Update verb
  • Handling the Delete verb
  • Handling the Exists verb
  • Processing business objects
  • Indicating the connector response
  • Handling loss of connection to the application
  • Event notification
  • Overview of an event-notification mechanism
  • Implementing an event store for the application
  • Implementing event detection
  • Implementing event retrieval
  • Implementing the poll method
  • Special considerations for event processing
  • Message logging
  • Error and informational messages
  • Trace messages
  • Message file
  • Implementing a Java connector
  • Extending the Java connector base class
  • Beginning execution of the connector
  • Creating a business object handler
  • Implementing an event-notification mechanism
  • Shutting down the connector
  • Handling errors and status
  • Adding a connector to the business integration system
  • Naming the connector
  • Compiling the connector
  • Creating the connector definition
  • Creating the initial configuration file
  • Starting up a new connector
  • Java connector library API reference

  • Overview of the Java connector library
  • Classes and interfaces
  • CWConnectorAgent class
  • CWConnectorAgent()
  • agentInit()
  • executeCollaboration()
  • getCollabNames()
  • getConnectorBOHandlerForBO()
  • getEventStore()
  • getVersion()
  • gotApplEvent()
  • isAgentCapableOfPolling()
  • isSubscribed()
  • pollForEvents()
  • terminate()
  • CWConnectorAttrType class
  • Attribute-type constants
  • CWConnectorBOHandler class
  • CWConnectorBOHandler()
  • doVerbFor()
  • getName()
  • setName()
  • CWConnectorBusObj class
  • areAllPrimaryKeysTheSame()
  • compare()
  • doVerbFor()
  • dump()
  • getAppText()
  • getAttrASIHashtable()
  • getAttrCount()
  • getAttrIndex()
  • getAttrName()
  • getbooleanValue()
  • getBusinessObjectVersion()
  • getBusObjASIHashtable()
  • getBusObjValue()
  • getCardinality()
  • getDefault()
  • getDefaultboolean()
  • getDefaultdouble()
  • getDefaultfloat()
  • getDefaultint()
  • getDefaultlong()
  • getDefaultString()
  • getdoubleValue()
  • getfloatValue()
  • getintValue()
  • getLocale()
  • getLongTextValue()
  • getlongValue()
  • getMaxLength()
  • getName()
  • getObjectCount()
  • getParentBusinessObject()
  • getStringValue()
  • getSupportedVerbs()
  • getTypeName()
  • getTypeNum()
  • getVerb()
  • getVerbAppText()
  • hasAllKeys()
  • hasAllPrimaryKeys()
  • hasAnyActivePrimaryKey()
  • hasCardinality()
  • hasName()
  • hasType()
  • isBlank()
  • isForeignKeyAttr()
  • isIgnore()
  • isKeyAttr()
  • isMultipleCard()
  • isObjectType()
  • isRequiredAttr()
  • isType()
  • isVerbSupported()
  • objectClone()
  • prune()
  • removeAllObjects()
  • removeBusinessObjectAt()
  • setAttrValues()
  • setbooleanValue()
  • setBusObjValue()
  • setDEEId()
  • setDefaultAttrValues()
  • setdoubleValue()
  • setfloatValue()
  • setintValue()
  • setLocale()
  • setLongTextValue()
  • setStringValue()
  • setVerb()
  • CWConnectorConstant class
  • Outcome-status constants
  • Verb constants
  • Connector-property constants
  • CWConnectorEvent class
  • CWConnectorEvent()
  • getBusObjName()
  • getConnectorID()
  • getEffectiveDate()
  • getEventID()
  • getEventSource()
  • getEventTimeStamp()
  • getIDValues()
  • getKeyDelimiter()
  • getPriority()
  • getStatus()
  • getTriggeringUser()
  • getVerb()
  • setEventSource()
  • CWConnectorEventStatusConstants class
  • Event-status constants
  • CWConnectorEventStore class
  • CWConnectorEventStore()
  • archiveEvent()
  • cleanupResources()
  • deleteEvent()
  • fetchEvents()
  • getBO()
  • getNextEvent()
  • getTerminate()
  • recoverInProgressEvents()
  • resubmitArchivedEvents()
  • setEventStatus()
  • setEventsToProcess()
  • setTerminate()
  • updateEventStatus()
  • Deprecated Methods
  • CWConnectorEventStoreFactory interface
  • getEventStore()
  • CWConnectorExceptionObject class
  • CWConnectorExceptionObject()
  • getExpl()
  • getMsg()
  • getMsgNumber()
  • getMsgType()
  • getStatus()
  • setExpl()
  • setMsg()
  • setMsgNumber()
  • setMsgType()
  • setStatus()
  • CWConnectorLogAndTrace class
  • Message-type constants
  • Trace-level constants
  • CWConnectorReturnStatusDescriptor class
  • CWConnectorReturnStatusDescriptor()
  • getErrorString()
  • getStatus()
  • setErrorString()
  • setStatus()
  • CWConnectorUtil class
  • Message-file constants
  • Methods
  • Deprecated Methods
  • CWCustomBOHandlerInterface interface
  • doVerbForCustom()
  • CWException class
  • Methods
  • CWException()
  • getExceptionObject()
  • getMessage()
  • getStatus()
  • setStatus()
  • Exception subclasses
  • CWProperty class
  • CWProperty()
  • getCardinality()
  • getChildPropValue()
  • getChildPropsWithPrefix()
  • getEncryptionFlag()
  • getHierChildProp()
  • getHierChildProps()
  • getHierProp()
  • getName()
  • getPropType()
  • getStringValues()
  • hasChildren()
  • hasValue()
  • setEncryptionFlag()
  • setValues()
  • Java low-level connector library API reference

  • Overview of the low-level Java connector library
  • Classes and interfaces
  • BOHandlerBase class
  • doVerbFor()
  • getName()
  • setName()
  • BusinessObjectInterface interface
  • clone()
  • doVerbFor()
  • dump()
  • getAppText()
  • getAttrCount()
  • getAttrDesc()
  • getAttribute()
  • getAttributeIndex()
  • getAttributeType()
  • getAttrName()
  • getAttrValue()
  • getBusinessObjectVersion()
  • getDefaultAttrValue()
  • getLocale()
  • getName()
  • getParentBusinessObject()
  • getVerb()
  • getVerbAppText()
  • isBlank()
  • isIgnore()
  • isVerbSupported()
  • makeNewAttrObject()
  • setAttributeWithCreate()
  • setAttrValue()
  • setDefaultAttrValues()
  • setLocale()
  • setVerb()
  • ConnectorBase class
  • executeCollaboration()
  • getBOHandlerForBO()
  • getCollabNames()
  • getSupportedBusObjNames()
  • getVersion()
  • gotApplEvent()
  • init()
  • isAgentCapableOfPolling()
  • isSubscribed()
  • pollForEvents()
  • terminate()
  • Deprecated methods
  • CxObjectAttr class
  • Attribute-type constants
  • Methods
  • equals()
  • getAppText()
  • getCardinality()
  • getDefault()
  • getMaxLength()
  • getName()
  • getRelationType()
  • getTypeName()
  • getTypeNum()
  • hasCardinality()
  • hasName()
  • hasType()
  • isForeignKeyAttr()
  • isKeyAttr()
  • isMultipleCard()
  • isObjectType()
  • isRequiredAttr()
  • isType()
  • CxObjectContainerInterface interface
  • getBusinessObject()
  • getObjectCount()
  • insertBusinessObject()
  • removeAllObjects()
  • removeBusinessObjectAt()
  • setBusinessObject()
  • CxProperty class
  • CxProperty()
  • getAllChildProps()
  • getChildProp()
  • getEncryptionFlag()
  • getName()
  • getStringValues()
  • hasChildren()
  • setEncryptionFlag()
  • setValues()
  • CxStatusConstants class
  • Outcome-status constants
  • JavaConnectorUtil class
  • Static constants
  • Methods
  • createBusinessObject()
  • createContainer()
  • generateMsg()
  • getAllConfigProp()
  • getAllConnectorAgentProperties()
  • getAllStandardProperties()
  • getAllUserProperties()
  • getBlankValue()
  • getConfigProp()
  • getEncoding()
  • getIgnoreValue()
  • getLocale()
  • getOneConfigProp()
  • getSupportedBusObjNames()
  • initAndValidateAttributes()
  • isBlankValue()
  • isIgnoreValue()
  • isTraceEnabled()
  • logMsg()
  • traceWrite()
  • ReturnStatusDescriptor class
  • getErrorString()
  • getStatus()
  • setErrorString()
  • setStatus()
  • Low-level Java exceptions
  • Exception subclasses
  • Methods
  • getFormattedMessage()
  • Appendixes

  • Appendix A. Standard configuration properties for connectors
  • New and deleted properties
  • Configuring standard connector properties
  • Summary of standard properties
  • Standard configuration properties
  • Appendix B. Connector Configurator
  • Overview of Connector Configurator
  • Starting Connector Configurator
  • Running Configurator from System Manager
  • Creating a connector-specific property template
  • Creating a new configuration file
  • Using an existing file
  • Completing a configuration file
  • Setting the configuration file properties
  • Saving your configuration file
  • Changing a configuration file
  • Completing the configuration
  • Using Connector Configurator in a globalized environment
  • Appendix C. Connector Script Generator

  • Appendix D. Connector feature checklist
  • Guidelines for using the connector feature checklist
  • Standard behavior for request processing
  • Standard behavior for the event notification
  • General standards
  • Index
  • Copyright IBM Corp. 1997, 2003