Host Access Integration Object methods

These methods can be used in Host Integration Objects created with Host Publisher and imported into ZIETrans, and with Integration Objects created in &studio. They cannot be used with Database Access Integration Objects created with Host Publisher.

java.lang.String getHPubLinkKey()

This method returns the name of the key that represents the connection for the Integration Object chain. This value should be obtained from the first Integration Object in a chain after the Integration Object has run in a non-Web container.

void setHPubLinkKey(java.lang.String value)

This method sets the name of the key that represents the connection for the Integration Object chain. This value should be set for any chained Integration Objects, other than the first Integration Object in the chain, before they run in a non-Web container.

java.lang.String getHPubStartChainName()

This method returns the name of the start state label as defined when a middle or last in chain Integration Object is created. This value is Null for the first Integration Object in a chain or an Integration Object that is not chained.

java.lang.String getHPubEndChainName()

Returns the stop state label as defined when a first in chain Integration Object is created. This value is Null for the last Integration Object in a chain or an Integration Object that is not chained.

java.lang.String getHPubScreenState()

This method returns the name of the last &HOD macro screen that was executed when the macro was stopped.

java.lang.String getHPubMacroMessage()

This method returns the value of the message tag of the last screen that was executed in the current &HOD; macro screen.

public java.lang.String getHPubConnectionOverrides()

This method returns the connection overrides used by IO in the format "key1=value1, key2=value2" or an empty string.

See Specifying Connection Overrides for further information.

public void setHPUBConnectionOverrides (String overrides)

This method specifies the connection overrides to apply when establishing the host connection for the Integration Object. The connection overrides have to be set before calling the processRequest() or doHPTransaction() methods of the Integration Object. The connection overrides must be in the format "key1=value1, key2=value2". This format is more convenient when building Web services.

This method should be used with client programs based on ZIETrans EJB access beans or Web Services clients generated to be used with ZIETrans web services.

If connection overrides have been specified, then when the Integration Object's doHPTransaction() or processRequest() method is called a new connection pool for the Integration Object is created. The new pool is based on the Integration Object's original connection pool and the supplied connection overrides. The Integration Object is automatically switched to use the new connection pool. new pool name can be retrieved using the Integration Object instance method getHPubStartPoolName().

See Specifying Connection Overrides for further information.

public void setHPubConnectionOverrides(Properties overrides)

This method sets the connection overrides to apply when establishing the host connection for the Integration Object. The connection overrides have to be set before calling the processRequest() or doHPTransaction() business methods of the Integration Object establishing the host connection.

When the Integration Object doHPTransaction() or processRequest() methods are called, if there are connection overrides associated with the Integration Object, a new connection pool for the Integration Object is created based on the Integration Object's connection pool and the connection overrides. The new pool name can be retrieved using the Integration Object instance method getHPubStartPoolName().

See Specifying Connection Overrides for further information.