|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.HostPublisher.IntegrationObject.HPubCommon
public abstract class HPubCommon
This is the base class of all Integration Objects.
| Field Summary | |
|---|---|
static int |
BEAN_END_TO_CONNECTION
This is a first or middle in chain Integration Object |
static int |
BEAN_END_TO_POOL
This is a last or only in chain Integration Object |
static int |
BEAN_START_FROM_CONNECTION
This is a middle or last in chain Integration Object |
static int |
BEAN_START_FROM_POOL
This is a first or only in chain Integration Object |
protected static int |
ERT_EVENT
|
protected static int |
ERT_NOTHING
|
protected static int |
ERT_REDIRECT
|
protected static int |
ERT_THROW
|
String |
hPubAccessHandle
|
String |
hPubBeanName
The name of the current Integration Object or EJB Access Bean |
String |
hPubBeanType
Represents the type of Integration Object or EJB Access Bean. |
String |
hPubCompleteErrorPagePath
Deprecated. |
Properties |
hPubConnectionOverrides
The connection overrides to apply when establishing the connection |
String |
hPubEndChainName
The stop state label for the Integration Object |
int |
hPubEndType
Indicates whether the Integration Object will be returned to the pool or saved for the next Integration Object in the chain |
Exception |
hPubErrorException
If HPubErrorOccurred, returns the exception object that describes the error that occurred |
String |
hPubErrorMessage
Returns a string containing the HATS code and message of the error that occurred; valid only if HPubErrorOccurred is non-zero |
int |
hPubErrorOccurred
Returns a non-zero value when an error has occurred |
String |
hPubErrorPage
Deprecated. |
String |
hPubLinkKey
The name of the key that represents the connection for the Integration Object chain |
boolean |
hPubSaveConnOnError
An indicator in the Integration Object that specifies whether the connection should be destroyed if an error is detected while executing the Integration Object |
String |
hPubStartChainName
The start state label for the Integration Object |
String |
hPubStartPoolName
The connection pool from which the Integration Object obtained the connection from |
int |
hPubStartType
Indicates whether the connection for the Integration Object was obtained from a pool or a chain |
String |
styleSheet
|
String |
xmlData
|
| Constructor Summary | |
|---|---|
HPubCommon()
|
|
| Method Summary | |
|---|---|
void |
doHPTransaction(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp)
This execution method runs a HATS Integration Object or EJB Access Bean from a servlet or JSP. |
protected abstract void |
DoTheWork()
|
String |
getHPubAccessHandle()
|
String |
getHPubBeanName()
Returns the name of the current Integration Object or EJB Access Bean |
String |
getHPubBeanType()
Returns the string representing the type of HATS Integration Object or EJB Access Bean. |
String |
getHPubConnectionOverrides()
This method returns the connection overrides used by the IO. |
String |
getHPubEndChainName()
Returns the stop state label as defined in when creating the Integration Object. |
int |
getHPubEndType()
Indicates whether the Integration Object will be returned to the pool or saved for the next Integration Object in the chain |
Exception |
getHPubErrorException()
Returns an exception object that describes the error that occurred; valid only if HPubErrorOccurred is non-zero. |
String |
getHPubErrorMessage()
Returns a string containing the HATS code and message of the error that occurred; valid only if HPubErrorOccurred is non-zero. |
int |
getHPubErrorOccurred()
Returns a non-zero value when an error has occurred |
String |
getHPubErrorPage()
Deprecated. HATS uses JSP 1.1 standard error pages. See Programmer's Guide and Reference. |
String |
getHPubLinkKey()
Returns the name of the key that represents the connection for the Integration Object chain. |
boolean |
getHPubSaveConnOnError()
Gets whether the connection for this Integration Object should will be destroyed if an error is detected while executing the Integration Object. |
String |
getHPubStartChainName()
Returns the name of the start state label as defined in when creating the Integration Object. |
String |
getHPubStartPoolName()
Returns name of the connection pool from which the Integration Object acquired the connection |
int |
getHPubStartType()
Indicates whether the connection for the Integration Object was obtained from a pool or a chain |
String |
getHPubStyleSheet()
|
String |
getHPubXMLData()
|
String |
getHPubXMLProperties()
Returns an XML formatted string specifying the property names and values for this Integration Object |
String |
getHPubXMLProperties(String serverStyleSheet)
Returns the output string after the specified XML stylesheet has been applied.See "Applying XML stylesheet processing to Integration Object output" in the Programmer's Guide for more information. |
boolean |
isTransformConn()
This routine determines whether or not the Integration Object is using the default transformation connections defined for the HATS application. |
void |
processRequest()
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). |
void |
setHPubAccessHandle(String value)
|
void |
setHPubConnectionOverrides(Properties overrides)
This method sets the connection overrides to apply when establishing the host connection for the Integration Object. |
void |
setHPubConnectionOverrides(String overrides)
This method sets the connection overrides to apply when establishing the host connection for the Integration Object. |
void |
setHPubEndChainName(String stringToBe)
Sets the name of the end state label. |
void |
setHPubErrorPage(String stringToBe)
Deprecated. HATS uses JSP 1.1 standard error pages. See Programmer's Guide and Reference. |
void |
setHPubLinkKey(String stringToBe)
Sets the name of the key that represents the connection for the Integration Object chain. |
void |
setHPubSaveConnOnError(boolean flag)
Sets whether the connection for this Integration Object should not be destroyed if an error is detected while executing the Integration Object. |
void |
setHPubStartChainName(String stringToBe)
Sets the name of the start state label. |
void |
setHPubStartPoolName(String stringToBe)
Sets the name of the connection pool from which the Integration Object will acquire the connection. |
void |
setHPubStyleSheet(String value)
|
void |
setHPubXMLData(String value)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.ibm.HostPublisher.IntegrationObject.HPubStartListener |
|---|
hPubStartPerformed |
| Methods inherited from interface com.ibm.eNetwork.ECL.screenreco.event.ECLCustomRecoListener |
|---|
DoReco |
| Methods inherited from interface java.lang.Runnable |
|---|
run |
| Field Detail |
|---|
public static final int BEAN_START_FROM_POOL
public static final int BEAN_START_FROM_CONNECTION
public static final int BEAN_END_TO_POOL
public static final int BEAN_END_TO_CONNECTION
public int hPubStartType
public int hPubEndType
public String hPubStartPoolName
public Properties hPubConnectionOverrides
public String hPubStartChainName
public String hPubEndChainName
public boolean hPubSaveConnOnError
public String hPubErrorPage
public String hPubCompleteErrorPagePath
public Exception hPubErrorException
public int hPubErrorOccurred
public String hPubErrorMessage
public String hPubLinkKey
public String hPubBeanName
public String hPubBeanType
HOD The bean was created using Host Publisher Host Access or HATS Studio
DB This bean was created using Host Publisher Database Access
public String hPubAccessHandle
public String styleSheet
public String xmlData
protected static final int ERT_REDIRECT
protected static final int ERT_EVENT
protected static final int ERT_THROW
protected static final int ERT_NOTHING
| Constructor Detail |
|---|
public HPubCommon()
| Method Detail |
|---|
public String getHPubStartPoolName()
public void setHPubStartPoolName(String stringToBe)
stringToBe - The name of the connection pool.public void setHPubConnectionOverrides(String overrides)
This method should be used with clients programs based on HATS EJB access beans or Web Services clients generated to be used with HATS web services.
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().
Sample code:
String overrides = "LUName=LU000001,host=ralvms";
ExampleIO.setHPubStartPoolName("my_project/connection");
ExampleIO.setHPubConnectionOverrides(overrides);
ExampleIO.processRequest();
overrides - The connection overrides to be used by the IO in the format "key1=value1,key2=value2".HPubCommon.setHPubConnectionOverrides(Properties overrides),
HPubCommon.getHPubStartPoolName()public void setHPubConnectionOverrides(Properties overrides)
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().
Sample code:
java.util.Properties overrides = new java.util.Properties();
overrides.setProperty("LUName", "LU000001");
ExampleIO.setHPubConnectionOverrides(overrides);
ExampleIO.doHPTransaction(request,response);
overrides - The connection overrides to be used by the IO.HPubCommon.setHPubConnectionOverrides(String overrides),
HPubCommon.getHPubStartPoolName()public String getHPubConnectionOverrides()
HPubCommon.setHPubConnectionOverrides(String overrides)public String getHPubStartChainName()
public void setHPubStartChainName(String stringToBe)
stringToBe - The name of the start state label.public String getHPubEndChainName()
public void setHPubEndChainName(String stringToBe)
stringToBe - the name of the end state labelpublic String getHPubLinkKey()
public void setHPubLinkKey(String stringToBe)
stringToBe - Sets the name of the key that represents the connectionpublic String getHPubBeanName()
public String getHPubErrorPage()
public void setHPubErrorPage(String stringToBe)
public boolean getHPubSaveConnOnError()
public void setHPubSaveConnOnError(boolean flag)
flag - public int getHPubStartType()
public int getHPubEndType()
public int getHPubErrorOccurred()
public String getHPubErrorMessage()
public Exception getHPubErrorException()
public String getHPubBeanType()
HOD This bean was created using the HATS Host Terminal.
DB This bean was created using Host Publisher Database Access.
protected abstract void DoTheWork()
public void doHPTransaction(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse resp)
throws BeanException
req - HttpServletRequest objectresp - HttpServletResponase object
BeanException
public void processRequest()
throws BeanException
BeanExceptionpublic String getHPubXMLProperties(String serverStyleSheet)
serverStyleSheet - XML stylesheet to be applied to the XML formatted Integration Object output.
public String getHPubXMLProperties()
public boolean isTransformConn()
public String getHPubAccessHandle()
public void setHPubAccessHandle(String value)
public String getHPubStyleSheet()
public void setHPubStyleSheet(String value)
public String getHPubXMLData()
public void setHPubXMLData(String value)
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||