com.baan.ow.xmlconnector
Interface IRequestProcessor

public interface IRequestProcessor

This Interface provides methods for data updates and retrievals to Baan.

Since:

classVersion 2.3

Field Summary

static java.lang.String

COPYRIGHT

Method Summary

boolean	close() This method should be called to release the License.
boolean	execute(com.baan.b3.boi1.IUserSession p_userSession, org.w3c.dom.Document p_request, org.w3c.dom.Document p_responseDocument, org.w3c.dom.Document p_requestStatus) This method should be called to do data retrieval and updates.
boolean	execute(com.baan.b3.boi1.IUserSession p_userSession, java.lang.String p_request, java.lang.StringBuffer p_responseDocument, java.lang.StringBuffer p_requestStatus) This method should be called to do data retrieval and updates.
com.baan.ow.xmlconnector.IXMLCIterator	executeSync(com.baan.b3.boi1.IUserSession p_userSession, org.w3c.dom.Document p_request, org.w3c.dom.Document p_responseDocument) This method should be called only for data synchronization purpose, where the return type of the method call is a com.baan.b3.boi1.Iterator.
com.baan.ow.xmlconnector.IXMLCIterator	executeSync(com.baan.b3.boi1.IUserSession p_userSession, java.lang.String p_request, java.lang.StringBuffer p_responseDocument) This method should be called only for data synchronization purpose, where the return type of the method call is a com.baan.b3.boi1.Iterator.
void	setAdapterFetchSize(int p_fetchSize) Sets the fetch size for this iterator.
void	setAdapterTimeOut(int p_timeout) Changes the time this manager waits for the result.

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

Method Detail

execute

public boolean execute(com.baan.b3.boi1.IUserSession p_userSession,
                       java.lang.String p_request,
                       java.lang.StringBuffer p_responseDocument,
                       java.lang.StringBuffer p_requestStatus)

This method should be called to do data retrieval and updates.

It checks the validity of the User License and the Input Request Document. Incase there is a validation failure, an appropriate error message is returned. For a valid request, the requested method is executed and the corressponding output is returned.

Parameters:

p_userSession - @see com.baan.b3.boi1.IUserSession

p_request - The input document, which contains the "ObjectName", "MethodName", "ComponentName" and the input parameters.

p_responseDocument - The output Response Document.

p_requestStatus - The output Error Document.

Returns:

boolean

Since:

classVersion 2.3

execute

public boolean execute(com.baan.b3.boi1.IUserSession p_userSession,
                       org.w3c.dom.Document p_request,
                       org.w3c.dom.Document p_responseDocument,
                       org.w3c.dom.Document p_requestStatus)

This method should be called to do data retrieval and updates.

It checks the validity of the User License and the Input Request Document. Incase there is a validation failure, an appropriate error message is returned. For a valid request, the requested method is executed and the corressponding output is returned.

Parameters:

p_userSession - @see com.baan.b3.boi1.IUserSession

p_request - The input document, which contains the "ObjectName", "MethodName", "ComponentName" and the input parameters.

p_responseDocument - The output Response Document.

p_requestStatus - The output Error Document.

Returns:

boolean

Since:

classVersion 2.5

close

public boolean close()

This method should be called to release the License. It also used when ASM functionality is being used.

The client must explicitly call this method to release the License. This is also used when the managers are initialized using bus components which have Application Service Manager (ASM) configured as active and use connection pooling. If this method is not called, the bshell instances activated by the ASM do not get terminated and are kept hanging or killed based on the timeout specified at the bus component level.

Returns:

boolean

Since:

classVersion 2.3

executeSync

public com.baan.ow.xmlconnector.IXMLCIterator executeSync(com.baan.b3.boi1.IUserSession p_userSession,
                                                          java.lang.String p_request,
                                                          java.lang.StringBuffer p_responseDocument)

This method should be called only for data synchronization purpose, where the return type of the method call is a com.baan.b3.boi1.Iterator.

It checks the validity of the User License and the Input Request Document. Incase there is a validation failure, an appropriate error message is returned. For a valid request, the requested method is executed and the corressponding output is returned.

Parameters:

p_userSession - @see com.baan.b3.boi1.IUserSession

p_request - The input document, which contains the "ObjectName", "MethodName", "ComponentName" and the input parameters.

p_responseDocument - The output Error Document.

Returns:

IXMLCIterator @see com.baan.ow.xmlconnector.IXMLCIterator

Since:

classVersion 2.5

executeSync

public com.baan.ow.xmlconnector.IXMLCIterator executeSync(com.baan.b3.boi1.IUserSession p_userSession,
                                                          org.w3c.dom.Document p_request,
                                                          org.w3c.dom.Document p_responseDocument)

This method should be called only for data synchronization purpose, where the return type of the method call is a com.baan.b3.boi1.Iterator.

It checks the validity of the User License and the Input Request Document. Incase there is a validation failure, an appropriate error message is returned. For a valid request, the requested method is executed and the corressponding output is returned.

Parameters:

p_userSession - @see com.baan.b3.boi1.IUserSession

p_request - The input document, which contains the "ObjectName", "MethodName", "ComponentName" and the input parameters.

p_responseDocument - The output Error Document.

Returns:

IXMLCIterator @see com.baan.ow.xmlconnector.IXMLCIterator

Since:

classVersion 2.5

setAdapterTimeOut

public void setAdapterTimeOut(int p_timeout)

Changes the time this manager waits for the result.

The timeout is the time the manager waits for the result from the OpenWorldX Adapter backend. When there is no reply within the timeout, a com.baan.b3.boi1.BoiException is thrown. This mechanism is to prevent client applications from 'hanging' because of non responding OpenWorldX Adapter servers.

Postconditions: The timeout is changed

Parameters:

p_timeout - the timeout in milliseconds to set on the manager, 0 = no timeout wait forever (must not be less than 0)

Since:

classVersion 2.5

setAdapterFetchSize

public void setAdapterFetchSize(int p_fetchSize)

Sets the fetch size for this iterator.

The Iterator retrieves all it's data in sets, and the size of these sets is configurable. This can be set using the adapter configuration tools, but the size of the set can also be set at runtime with this method. Note that retrieving the data in sets is done for performance reasons. The optimal fetch size depends on the size of one record (and number of sub records), the transport speed, and the time the OpenWorldX Adapter backend needs to produce the data.

Postconditions: The next fetch from the backend will use the new size

Parameters:

p_fetchSize - the Fetch size to use.

Since:

classVersion 2.5