Internal business objects

This section provides reference information about internal business objects.

The connector's internal business objects are used as transitional data wrappers, as data is pulled off the network (in event mode) and as it is being fed to the network (in service call request mode).

Note: The definition files for all internal business objects and meta-objects are stored as XML schema files (.xsd) in the following directories: ProductDir\connectors\TCPIP\Samples for Windows and ProductDir/connectors/TCPIP/Samples for UNIX. They can be viewed using either the Business Object Designer or an XML-capable browser.

BIA_ContentBO

In event mode, the connector functions as a TCP server, listening on a socket for requests from remote applications to establish a channel to transmit data. The Connection Management subcomponent establishes the connection and manages the incoming data stream from the network, including load balancing and setting up parallel processes to handle multiple requests. As the data flows in, it is passed to the Message Processing component, where it is held in a BIA_ContentBO, the basic data wrapper.

Figure 16. BIA_ContentBO in the Business Object Designer
A screen shot of BIA_ContentBO.

The pertinent attribute of the BIA_ContentBO is as follows:

Business-object level attribute Description
Content Stores application or protocol data.

BIA_InputMessage

The content object is contained in a BIA_InputMessage business object. The input message object may initially include complete and incomplete messages from the remote application. The connector separates complete and incomplete messages, queuing the incomplete messages until they are complete, and sending completed messages, wrapped in their BIA_InputMessage objects, to the PIMO framework, where some forms of pre-processing may be done before they are passed on to the data handler for final processing.

Figure 17. BIA_InputMessage in the Business Object Designer
A screen shot of BIA_InputMessage.

The pertinent attributes of the BIA_InputMessage object are as follows:

Business object-level attributes Description
CharSet Encoding applied to the incoming bytes.
Content Stores content coming in the socket as BIA_ContentBOs. It is of N cardinality because attribute length is limited compared to the length of the incoming message.

BIA_ApplicationMessage

In service call request mode, the WebSphere business integration business objects that represent messages to be transmitted to the remote application are sent from the integration broker. These objects are translated into the appropriate message form by the data handler. The connector wraps this message data in a BIA_ContentBO, which is contained in a BIA_ApplicationMessage object. The message data may be subject to PIMO post-processing, after which the connector, acting as a TCP client, sends the message data back out over the TCP/IP network to a target specified in the connector configuration file.

Figure 18. BIA_ApplicationMessage in the Business Object Designer
A screen shot of BIA_ApplicationMessage.

The pertinent attributes of the BIA_ApplicationMessage object are as follows:

Business object-level attributes Description
Charset Encoding applied on incoming bytes.
Content Stores content coming in from the data handler as BIA_ContentBOs. It is of N cardinality because attribute length is limited compared to the length of the incoming message.

BIA_ResponseMessage

In asynchronous processing, the BIA_ResponseMessage object contains any acknowledgment message--wrapped in a content object--from the remote application as a result of a service call request.

In synchronous processing, the BIA_ResponseMessage object contains the response from the remote application.

Figure 19. BIA_ResponseMessage in the Business Object Designer
A screen shot of BIA_ResponseMessage.A

The pertinent attributes of the BIA_ResponseMessage object are as follows:

Business object-level attributes Description
Charset Encoding applied on incoming bytes.
Content Stores content coming in from the data handler as BIA_ContentBOs. It is of N cardinality because attribute length is limited compared to the length of the incoming message.

BIA_FinalMessage

The response received by the adapter in synchronous request processing is wrapped in BIA_ResponseMessage, and the BIA_ResponseMessage map is invoked. BIA_FinalMessage is the business object that is returned from this map to the adapter. BIA_FinalMessage encapsulates the final data that is to be returned to the broker.

Note: BIA_FinalMessage is useful only in synchronous request processing.

Figure 20. BIA_FinalMessage in the Business Object Designer
A screen shot of BIA_FinalMessage.

The pertinent attributes of the BIA_FinalMessage object are as follows:

Business object-level attributes Description
Charset Encoding applied on incoming bytes.
Status Indicates to the connector whether to return a SUCCESS, VALCHANGE, or FAILURE status to the broker.
ResponseAttributeName Conveys to the connector which attribute of the incoming request business object, from the broker, has to be populated with the de-serialized data.
ResponseDataMimeType Conveys the mime type used for serialization.
Content Stores content coming in from the data handler as BIA_ContentBOs. It is of N cardinality because attribute length is limited compared to the length of the incoming message.

Copyright IBM Corporation 1997, 2005. All Rights Reserved.