Common methods

These methods are common to all Integration Objects.

void doHPTransaction(HttpServletRequest req, HttpServletResponse resp) throws BeanException

This execution method runs a &sprod; Integration Object or EJB Access Bean from a servlet or JSP. If you use this method, &sprod; manages Integration Object chaining. However, you must ensure that the Integration Objects in your Web project are chained together in the correct order.

void processRequest() throws BeanException

This execution method runs an Integration Object or EJB Access Bean in environments where there is no HttpServletRequest or HttpServletResponse (environments other than a Web module). To run chained Integration Objects using this method, additional programming is required; refer to Integration Object chaining.

java.lang.String getHPubBeanName()

Returns the name of the current Integration Object or EJB Access Bean.

java.lang.String getHPubBeanType()

Returns a string representing the type of &sprod Integration Object or EJB Access Bean. The returned string can be one of the following:

HOD

The bean was created using Host Access.

DB

This bean was created using Database Access.

void setHPubErrorPage(java.lang.String value)

For Integration Objects that were created with Host Publisher Version 2.2.1 or Version 3.5, this method sets the name of the error page to be used. Use this method only if you are running the &sprod; Integration Object or EJB Access Bean from a servlet or JSP. Specify the name of your error page relative to the location of your servlet or JSP.

java.lang.String getHPubStartPoolName()

Returns the name of the connection pool from which the Integration Object acquired the connection.

void setHPubStartPoolName(java.lang.String value)

Sets the name of the connection pool from which the Integration Object will acquire the connection. If the processRequest() business method of the Integration Object is being used (for example, when the Integration Object is deployed in an EJB container or as a Web service), the pool name must be qualified with the ZIETrans application name. For example, the pool name should be my_ZIETrans_project/main.

java.lang.String getHPubXMLProperties()

Returns an XML formatted string that specifies the property names and values for this Integration Object.

java.lang.String getHPubXMLProperties(HPubConvertToTableFormat.xsl)

Returns an XML formatted string that specifies the property names and values for this Integration Object, and applies XML style sheet processing to the returned string. See Applying XML style sheet processing to Integration Object output for more information.

void setHPubSaveConnOnError(java.lang.Boolean flag)

Sets an indicator in the Integration Object that specifies that the connection should not be destroyed if an error is detected while executing the Integration Object. Instead, the connection should be saved so that it can be passed to the ZIETrans entry servlet and a default transformation can be applied. The method should be used in combination with the predefined AdvancedIOErrorPage.jsp. The connection can be transformed only if it was obtained from the default connection pool. This method cannot be used with EJB Access Beans or ZIETrans Web services support.

int getHPubErrorOccurred()

Returns a nonzero value when an error has occurred.

java.lang.Exception getHPubErrorException()

Returns an exception object that describes the error that occurred; valid only if HPubErrorOccurred is nonzero. This property is not contained in the io_name_Output_Properties class that is generated by ZIETrans Web services support because parameters of type java.lang.Exception cannot be serialized over Simple Object Access Protocol (SOAP.)

java.lang.String getHPubErrorMessage()

Returns a string containing the &sprod; code and message of the error that occurred; valid only if HPubErrorOccurred is nonzero.