com.infoengine.edasql
Class RequestContext

java.lang.Object
  com.infoengine.edasql.RequestContext

public class RequestContext

extends Object

This class provides a wrapper to the Info*Engine server classes and data for the adapter developed with JADK. It encapsulates the input task, output task, user webject, and the request classes for the adapter developers to focus on their back end information system issues. It provides rich set of methods and functions to communicate with the Info*Engine server and to handle the various other needs for the adapter.

Field Summary

(package private) static String	ID
static Hashtable	jadkGlobalHashtable
private com.infoengine.log.LogWriter	logWriter
private Request	myRequest
private String	myResource
private Task	myTask
private Webject	myWebject
private Task	resultTask
private String	serviceName
static String[]	TYPES
private String	webjectPath

Constructor Summary

RequestContext(Request request, String servName, com.infoengine.log.LogWriter log)
Constructor for the RequestContext.

RequestContext(Request request, String servName, com.infoengine.log.LogWriter log, IeMultipartOutputStream out)
Constructor for the RequestContext.

RequestContext(Request request, String servName, String myRes, com.infoengine.log.LogWriter log)
Constructor for the RequestContext.

RequestContext(Request request, String servName, String myRes, com.infoengine.log.LogWriter log, IeMultipartOutputStream out)
Constructor for the RequestContext.

Method Summary

void	addMetaValue(String name, String value) Adds the specified meta name and value to the webject.
void	addOutputGroup(Group grp) Add an output group to the output task.
void	addParam(Param param) Add the parameter to the input webject.
void	addVdb(Group grp)
void	addVdb(String str)
void	addWebjectOutput(String str) Adds the output message to this webject.
void	clearAllGlobalObjects() Remove all the names and the associated global objects in the global table.
void	clearParams() Remove all parameters from the input webject.
Enumeration	getAllGlobalObjects() Get a list of all the global objects that were saved.
String	getClassName() Return a value of the class parameter from a webject.
Object	getGlobalObject(String name) Get the global object with the name.
Enumeration	getGlobalObjectKeys() Get a list of all the names that were saved previously for the global objects.
Group	getGroupIn() Get the default input group for this task.
Group	getGroupIn(String name) Get a named input group for this task.
String	getGroupInName() Return the group_in name that your defined from your input XML webject.
Enumeration	getGroupInNames() Return a list of group_in names that you defined from the webject.
Group	getGroupOut() Get the output group from the output task.
Group	getGroupOut(String name) Get a named output group from the output task.
String	getGroupOutName() Return the group_out name that you defined from your XML webject.
Enumeration	getGroupOutNames() Return a list of group_out names that you defined with your input XML webject.
Enumeration	getInputGroups() Get a list of all input groups for this task.
String	getLocalizedMessage(String message, Object[] obj)
com.infoengine.log.LogWriter	getLogWriter() Return the LogWriter object to the adapter.
Enumeration	getMessages() Get all the error messages attached to the output task.
String	getMetaValue(String name) Gets the specified meta value from the input webject.
Enumeration	getOutputGroups() Get an enumerated list of output groups from the output task.
IeMultipartOutputStream	getOutputStream() Return the IeMultipartOutputStream from the Info*Engine server.
Param	getParam(String name) Get a named parameter for this webject.
Enumeration	getParamNames() Gets a unique list of names of all the parameters that are defined from the input webject.
Enumeration	getParams(String name) Get all the parameters for this webject that have a specified name.
String	getParamValue(String name) Get the value of a named parameter from the input webject.
String	getParamValue(String name, String defaulty) Return the value of a named parameter from the input webject.
Enumeration	getParamValues(String name) Return all values of a named parameter for this webject.
String	getPassword() Return the password if you have set it with the setPassword method previously.
Properties	getProperties() Get a list of Properties that you passed or set with the adapter.
String	getProperty(String serviceName, String key) Searches for the property for the specified service name and key in the property list.
String	getProperty(String serviceName, String key, String defValue) Searches for the property for the specified service name and the key in the property list.
Request	getRequest() Return the current request object received from Info*Engine server.
IeRequest	getResponse() Return the IeRequest object to the Info*Engine server.
Task	getResultTask() Return the output task.
String	getServiceName() Return the service name.
int	getStatus() Get the status of the output task.
Task	getTask() Get the current input task.
String	getUserName() Return a webject's user name if you have set one with the setPassword method.
Webject	getWebject() Get the current input webject.
String	getWebjectName() Return the name of the current input webject, such as Query-Objects, Create-Objects, etc.
Enumeration	getWebjectOutput() Gets any output messages generated by this webject.
String	getWebjectPath() Get the adapter webject class file path.
String	getWebjectType() Get the current webject type.
boolean	isLogVerbose() Check whether the logging is in 'verbose' mode.
void	logWrite(Object X) Write the content of object to the log file.
void	logWrite(String message, Object[] obj) Write a message string with possible variables in the object to the log file.
void	logWrite(Throwable X) Write a throwable object to the log file.
void	print(Object X) Output the object to the log file.
void	readBlobStream(OutputStream fos) Read the next content object BLOB from the input stream to the output stream provided.
Vector	readGroupIn() Read the metadata from group-in into the vector-hashtable-vector structure.
Vector	readGroupIn(String GroupInName) Read the metadata from group-in into the vector-hashtable-vector structure.
Object	removeGlobalObject(String name) Remove the global object previously saved with the name.
void	removeParam(Param param) Remove a parameter from the input webject.
void	removeParams(String name) Remove all parameters from the input webject that have the specified key name.
void	setClassName(String cls) Set the class name with your XML webject.
void	setGlobalObject(String name, Object obj) Set a global object with the name for the adapter to retrive later.
void	setGlobalObject(String name, Object obj, boolean override) Set a global object with the name for the adapter to retrive later.
void	setOutputStream(IeMultipartOutputStream output) Set the IeMultipartOutputStream to the input task.
void	setParam(Param param) Set a new parameter to the input webject.
void	setPassword(String pwd) The password that you would like it to replace the existing one from your webject.
void	setProperties(Properties propers) Deprecated.
void	setRequest(Request rqt) Set the request object from the Info*Engine server and uses this request to create the input task with the webject.
void	setRequest(Request rqt, boolean override) Set the request object in the RequestContext and uses this request to create the input task.
void	setResultTask(Task tsk) Set the output task.
void	setServiceName(String svcName) Set the service name for current adapter so all the properties will be associated with the svcName.
void	setTask(Task tsk) Set the input task.
void	setUserName(String uid) Set the webject's user ID that replaces the existing one inside your webject.
void	setWebject(Webject webj) Set the webject object for adapter to use.
void	setWebjectName(String name) Set the name of the current input webject.
void	setWebjectPath(String path) Set the location of the adapter webject class files so that they can be dynamically loaded at runtime.
boolean	webjectNameMatch(String webName) Check to see if the current webject's name equals the one passed in.
void	writeBlobStream(InputStream fis, String filename, String contentType) Write one content object of a MIME multipart of object to the output stream to be sent to the browser.
void	writeGroupOut(Hashtable htab) Write the metadata from the vector-hashtable-vector structure to the output group.
void	writeGroupOut(Hashtable htab, String GroupOutName) Write the metadata from the vector-hashtable-vector structure to the output group.
void	writeGroupOut(Vector nodeVec) Write the metadata from the vector-hashtable-vector structure to the output group.
void	writeGroupOut(Vector nodeVec, String GroupOutName) Write the metadata from the vector-hashtable-vector structure to the output group.
void	writeGroupOut2(Hashtable htab) Write the metadata from the vector-hashtable-vector structure to the output group.
void	writeGroupOut2(Hashtable htab, String GroupOutName) Write the metadata from the vector-hashtable-vector structure to the output group.
void	writeGroupOut2(Vector nodeVec) Write the metadata from the vector-hashtable-vector structure to the output group.
void	writeGroupOut2(Vector nodeVec, String GroupOutName) Write the metadata from the vector-hashtable-vector structure to the output group.
void	writeObject(ResultSet rset) writeObject will pass the ResultSet to Info*Engine to build the VDB.
void	writeStatus(String str) Deprecated.
void	writeStatus(String message, int status) This method is the new replacement of the writeStatus.
void	writeStatus(String message, Object[] obj, int status) This method is the new replacement of the writeStatus.
void	writeStatus(String str, String GroupOutName) Deprecated.
void	writeStatus(String message, String GroupOutName, int status) This method is the new replacement of the writeStatus.
void	writeStatus(String message, String GroupOutName, Object[] obj, int status) This method is the new replacement of the writeStatus.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID

static final String ID

See Also:

Constant Field Values

serviceName

private String serviceName

logWriter

private com.infoengine.log.LogWriter logWriter

webjectPath

private String webjectPath

myResource

private String myResource

myRequest

private Request myRequest

myWebject

private Webject myWebject

myTask

private Task myTask

resultTask

private Task resultTask

jadkGlobalHashtable

public static Hashtable jadkGlobalHashtable

TYPES

public static String[] TYPES

Constructor Detail

RequestContext

public RequestContext(Request request,
                      String servName,
                      com.infoengine.log.LogWriter log)

Constructor for the RequestContext.

Parameters:

request - This is the Request object passed to the adapter from the Info*Engine server.

servName - The service name that is defined with your server properties file. This is also used as an adapter instance name in your XML webject.

log - The logWriter object for logging purposes for your adapter.

RequestContext

public RequestContext(Request request,
                      String servName,
                      String myRes,
                      com.infoengine.log.LogWriter log)

Constructor for the RequestContext. The my resource name is needed for developing double byte adapters. The my resource name is the subclass of the ListResourceBundle and is usually the name of your adapter class.

Parameters:

request - This is the Request object passed to the adapter from the Info*Engine server.

servName - The service name that is defined with your server properties file. This is also used as an adapter instance name in your XML webject.

myRes - This is the base name of your resource bundle. You may either pass the name here or the adapter will try to get .myResourceBundle from your properties file. The .resourcePath can be specified as well, otherwise, it will assume the resource bundle files are using the same path as the adapter classes.

log - The logWriter object for logging purposes for your adapter.

RequestContext

public RequestContext(Request request,
                      String servName,
                      com.infoengine.log.LogWriter log,
                      IeMultipartOutputStream out)

Constructor for the RequestContext. It is provided for backward compatible with the Info*Engine 4.0 adapters.

Parameters:

request - This is the Request object passed to the adapter from the Info*Engine server.

servName - The service name that is defined with your server properties file. This is also used as an adapter instance name in your XML webject.

log - The logWriter object for logging purposes for your adapter.

out - No longer in use. You get IeMultipartOutputStream with a call to getOutputStream. See the definition for this method below.

RequestContext

public RequestContext(Request request,
                      String servName,
                      String myRes,
                      com.infoengine.log.LogWriter log,
                      IeMultipartOutputStream out)

Constructor for the RequestContext. It is provided for backward compatible with the Info*Engine 4.0 adapters.

Parameters:

request - This is the Request object passed to the adapter from the Info*Engine server.

servName - The service name that is defined with your server properties file. This is also used as an adapter instance name in your XML webject.

myRes - This is the base name of your resource bundle. You may either pass the name here or the adapter will try to get .myResourceBundle from your properties file. The .resourcePath can be specified as well, otherwise, it will assume the resource bundle files are using the same path as the adapter classes.

log - The logWriter object for logging purposes for your adapter.

out - No longer in use. You get IeMultipartOutputStream with a call to getOutputStream. See the definition for this method below.

Method Detail

setRequest

public void setRequest(Request rqt)

Set the request object from the Info*Engine server and uses this request to create the input task with the webject. This method allows you to use a different Info*Engine server request to replace the existing one.

Parameters:

rqt - The request object you would like to replace the old request for your adapter.

setRequest

public void setRequest(Request rqt,
                       boolean override)

Set the request object in the RequestContext and uses this request to create the input task. This method allows you to use a different Info* Engine server request to replace the existing one but not necessarily overwrite the existing XML webject parameters.

Parameters:

rqt - The request object you would like to replace the old request for your adapter.

override - Ture to override the previous input webject. False to keep the old webject parameters.

getRequest

public Request getRequest()

Return the current request object received from Info*Engine server.

Returns:

The request object from the server.

getOutputStream

public IeMultipartOutputStream getOutputStream()

Return the IeMultipartOutputStream from the Info*Engine server.

Returns:

The IeMultipartOutputStream from the server. You can use the output stream to return CLOB/BLOB to the Info*Engine server.

setOutputStream

public void setOutputStream(IeMultipartOutputStream output)

Set the IeMultipartOutputStream to the input task. This will replace the old IeMultipartOutputStream set by Info*Engine server.

getLogWriter

public com.infoengine.log.LogWriter getLogWriter()

Return the LogWriter object to the adapter.

Returns:

Return the current LogWriter object.

logWrite

public void logWrite(Object X)

Write the content of object to the log file.

Parameters:

X - The object to be sent to the log file.

logWrite

public void logWrite(Throwable X)

Write a throwable object to the log file.

Parameters:

X - The throwable object to be sent to the log.

logWrite

public void logWrite(String message,
                     Object[] obj)

Write a message string with possible variables in the object to the log file. The output variables can be defined inside your adapter code and the object is reserved with your adapter resource bundle file for double byte support. If you have defined the .resourcePath and the .myResourceBundle properties, this method will use them to find your resource file. Otherwise, it assumes your resource files are in the same directory as your adapter class files.

Parameters:

message - The string message or message ID from your resource bundle that your would like to output to the log file.

obj - The variable for your output along with the message.

getLocalizedMessage

public String getLocalizedMessage(String message,
                                  Object[] obj)

print

public void print(Object X)

Output the object to the log file.

Parameters:

X - The object to be sent to the log file.

isLogVerbose

public boolean isLogVerbose()

Check whether the logging is in 'verbose' mode. The 'verbose' can be defined in the adapter properties.

Returns:

True if verbose is enabled, false if not enabled.

setTask

public void setTask(Task tsk)

Set the input task.

Parameters:

tsk - The task object that you want to replace your input task. This action also replace the webject along with the input task so the new webject is used by the adapter.

getTask

public Task getTask()

Get the current input task.

Returns:

The current input task object.

setResultTask

public void setResultTask(Task tsk)

Set the output task.

Parameters:

tsk - The task object that you want to replace the output task. Once replaced, all the output will be associated with this task to send to the Info*Engine server.

getResultTask

public Task getResultTask()

Return the output task. If none is defined, it create a new output task.

Returns:

Return the output task to the adapter.

setWebject

public void setWebject(Webject webj)

Set the webject object for adapter to use. This will replace the webject object originally from your task.

Parameters:

webj - The webject object that will be used by the adapter. This will result the new paramters and values being used.

getWebject

public Webject getWebject()

Get the current input webject.

Returns:

Return the current input webject object.

getWebjectType

public String getWebjectType()

Get the current webject type. They can be one of the following: "Unknown", "OBJ", "EXT", "DSP", "GRP", "TSK", or "ACT".

Returns:

The current webject type from the 7 possible types.

webjectNameMatch

public boolean webjectNameMatch(String webName)

Check to see if the current webject's name equals the one passed in.

Parameters:

webName - The name of the match check webject.

Returns:

True or False based on name match.

setProperties

public void setProperties(Properties propers)

Deprecated.

This method does nothing but is provided for compatibility with I*E 4.0.

Parameters:

propers - The Properties that you would like to save for I*E 4.0. It is ignored with post I*E 4.0 server.

getProperties

public Properties getProperties()

Get a list of Properties that you passed or set with the adapter.

Returns:

The Properties object for use by the adapter.

getProperty

public String getProperty(String serviceName,
                          String key)

Searches for the property for the specified service name and key in the property list.

Parameters:

serviceName - The serviceName for the adapter.

key - The property key used to get the property value.

Returns:

The value in this property list corresponding to the specified key.

getProperty

public String getProperty(String serviceName,
                          String key,
                          String defValue)

Searches for the property for the specified service name and the key in the property list.

Parameters:

serviceName - The serviceName for the adapter.

key - The property key.

defValue - The default value if no value found with the specified key.

Returns:

The value in this property list corresponding to the specified key.

setWebjectPath

public void setWebjectPath(String path)

Set the location of the adapter webject class files so that they can be dynamically loaded at runtime. This is also the path that you package your adapter files.

Parameters:

path - The parameter containing the webject's path.

getWebjectPath

public String getWebjectPath()

Get the adapter webject class file path. The .myWebjectPath in the properties file is used for this data member.

Returns:

The webject's path or null if not defined.

getWebjectName

public String getWebjectName()

Return the name of the current input webject, such as Query-Objects, Create-Objects, etc.

Returns:

The webject's name.

setWebjectName

public void setWebjectName(String name)

Set the name of the current input webject. This method allows you the change the webject name at runtime so you can rediret the call to a different adapter webject.

Parameters:

name - The parameter containing the webject's name. In general, if you pass a name 'Query-XYZ", then you will need to implement the IeQueryXyz adapter webject to avoid a runtime error.

getPassword

public String getPassword()

Return the password if you have set it with the setPassword method previously. Otherwise, it returns the value of the 'PASSWD' from your XML webject.

Returns:

The predefined password or null if none is defined.

setPassword

public void setPassword(String pwd)

The password that you would like it to replace the existing one from your webject.

Parameters:

pwd - The parameter containing the password.

getUserName

public String getUserName()

Return a webject's user name if you have set one with the setPassword method. Otherwise, it returns the value of DBUSER from your input XML webject.

Returns:

The predefined user name or null if none is defined.

setUserName

public void setUserName(String uid)

Set the webject's user ID that replaces the existing one inside your webject.

Parameters:

uid - The parameter containing the user ID.

getClassName

public String getClassName()

Return a value of the class parameter from a webject.

Returns:

The value of the class that you defined with your input XML webject.

setClassName

public void setClassName(String cls)

Set the class name with your XML webject.

Parameters:

cls - The value to replace the existing 'CLASS' value from your input XML webject.

getGroupInName

public String getGroupInName()

Return the group_in name that your defined from your input XML webject.

Returns:

The group_in name.

getGroupInNames

public Enumeration getGroupInNames()

Return a list of group_in names that you defined from the webject.

Returns:

An enumerated list of group_in names.

getGroupOutName

public String getGroupOutName()

Return the group_out name that you defined from your XML webject.

Returns:

The group_out name.

getGroupOutNames

public Enumeration getGroupOutNames()

Return a list of group_out names that you defined with your input XML webject.

Returns:

An enumerated list of group_out names.

clearParams

public void clearParams()

Remove all parameters from the input webject.

addParam

public void addParam(Param param)

Add the parameter to the input webject. The param object should contains the key and value to be added.

Parameters:

param - The param object to be added.

setParam

public void setParam(Param param)

Set a new parameter to the input webject.

Parameters:

param - A new parameter.

removeParam

public void removeParam(Param param)

Remove a parameter from the input webject.

Parameters:

param - The parameter to be removed.

removeParams

public void removeParams(String name)

Remove all parameters from the input webject that have the specified key name.

Parameters:

name - All param objects with the key equals to the name to be removed.

getParamValue

public String getParamValue(String name)

Get the value of a named parameter from the input webject.

Parameters:

name - The name of the desired parameter.

Returns:

The named parameter's value, or an empty string (if the name is not defined).

getParamValue

public String getParamValue(String name,
                            String defaulty)

Return the value of a named parameter from the input webject.

Parameters:

name - The name of the desired parameter.

defaulty - The default value to use if the parameter is not defined.

Returns:

The named parameter's value, or the default value (if the name is not defined).

getParamValues

public Enumeration getParamValues(String name)

Return all values of a named parameter for this webject.

Parameters:

name - The name of the desired parameter.

Returns:

A list of the named parameter's values.

getParam

public Param getParam(String name)

Get a named parameter for this webject.

Parameters:

name - The name of the desired parameter.

Returns:

The Param object containing the key and the value.

getParams

public Enumeration getParams(String name)

Get all the parameters for this webject that have a specified name.

Parameters:

name - The name of the desired parameters.

Returns:

The list of param objects with the name.

getParamNames

public Enumeration getParamNames()

Gets a unique list of names of all the parameters that are defined from the input webject.

Returns:

The full list of string names defined with your input XML webject.

getMetaValue

public String getMetaValue(String name)

Gets the specified meta value from the input webject.

Parameters:

name - The name of the desired meta value.

Returns:

The value of the named meta, or null if not defined.

addMetaValue

public void addMetaValue(String name,
                         String value)

Adds the specified meta name and value to the webject.

Parameters:

name - The name of the new meta value.

value - The value of the named meta.

setGlobalObject

public void setGlobalObject(String name,
                            Object obj)

Set a global object with the name for the adapter to retrive later. This global object is accessable to all the adapter webject with the current adapter instance. This object is not available to the other adapter instances even if they are running in the same JVM with your current adapter.

Parameters:

name - The name of object for later retrieval.

obj - The object that you want to save off for later use by the adapter.

setGlobalObject

public void setGlobalObject(String name,
                            Object obj,
                            boolean override)

Set a global object with the name for the adapter to retrive later. This global object is accessable to all the adapter webject with the current adapter instance. This object is not available to the other adapter instances even if they are running in the same JVM with your current adapter.

Parameters:

name - The name of object for later retrieval.

obj - The object that you want to saved off for later use.

override - True will enable to override, false will keep the existing value without overridding.

getGlobalObject

public Object getGlobalObject(String name)

Get the global object with the name. The name is provided when you set the global object. The object is accessable to all the adapter webject with the current adapter instance. It is not available for other adapter instances.

Parameters:

name - The name that you used to save the global object.

Returns:

The global object that you saved.

removeGlobalObject

public Object removeGlobalObject(String name)

Remove the global object previously saved with the name. This method will make the global object unavailable to any of the current adapter webject until you set the global object passing the same name again.

Parameters:

name - The name that was saved with the global object to be removed.

Returns:

The global object previously saved, or null if there is no mapped name.

getGlobalObjectKeys

public Enumeration getGlobalObjectKeys()

Get a list of all the names that were saved previously for the global objects.

Returns:

A list of all the names or null if none has been saved before.

getAllGlobalObjects

public Enumeration getAllGlobalObjects()

Get a list of all the global objects that were saved.

Returns:

A list of previously saved global objects. or null if none has been saved.

clearAllGlobalObjects

public void clearAllGlobalObjects()

Remove all the names and the associated global objects in the global table. This action will void any subsequent get method for the global objects until you set a global object with another setGlobalObject method.

getWebjectOutput

public Enumeration getWebjectOutput()

Gets any output messages generated by this webject.

Returns:

A list of strings generated by this webject.

addWebjectOutput

public void addWebjectOutput(String str)

Adds the output message to this webject.

Parameters:

str - An output string generated by this webject.

getStatus

public int getStatus()

Get the status of the output task.

Returns:

The integer value representing the status of the output group. The zero means the output group is good. A non-zero value implies an error or warning message.

getMessages

public Enumeration getMessages()

Get all the error messages attached to the output task.

Returns:

An enumerated list of error/warning messages that were set with the output groups.

getInputGroups

public Enumeration getInputGroups()

Get a list of all input groups for this task.

Returns:

The list of input groups.

getGroupIn

public Group getGroupIn()

Get the default input group for this task.

Returns:

The default input group if there is one.

getGroupIn

public Group getGroupIn(String name)

Get a named input group for this task.

Parameters:

name - The name of the desired input group.

Returns:

The named input group.

addVdb

public void addVdb(String str)

addVdb

public void addVdb(Group grp)

addOutputGroup

public void addOutputGroup(Group grp)

Add an output group to the output task.

Parameters:

grp - A group object to be added as output group to the output task.

getGroupOut

public Group getGroupOut()

Get the output group from the output task.

Returns:

The default output group, or null if there is no group_out or output task is not created.

getGroupOut

public Group getGroupOut(String name)

Get a named output group from the output task.

Parameters:

name - The name of the desired output group.

Returns:

The named output group, or null if there is no named group_out or the output task is not created.

getOutputGroups

public Enumeration getOutputGroups()

Get an enumerated list of output groups from the output task.

Returns:

An enumerated list of output groups, or null if no output groups or output task is not created.

getResponse

public IeRequest getResponse()

Return the IeRequest object to the Info*Engine server. This request object is stored within the output task and is expected by the server as the normal adapter response.

setServiceName

public void setServiceName(String svcName)

Set the service name for current adapter so all the properties will be associated with the svcName.

Parameters:

svcName - The name of the service.

getServiceName

public String getServiceName()

Return the service name.

Returns:

The name of the service.

writeStatus

public void writeStatus(String str)

Deprecated.

Write the status with a string for the client. This new version of status will always assume the message is an error or warning by assigning a non- zero value to the status. The earlier version of the JADK is neutral and don't assign any value. You should always use the new setMessage to send a message to the browser. This method is provided for compatibility with the early version of JADK.

Parameters:

str - The error message you would like for output to the browser.

writeStatus

public void writeStatus(String str,
                        String GroupOutName)

Deprecated.

Write the status with a string for the client. This new version of status will always assume the message is an error or warning by assigning a non- zero value to the status. The earlier version of the JADK is neutral and don't assign any value. You should always use the new setMessage to send a message to the browser. This method is provided for compatibility with the early version of JADK.

Parameters:

str - The error message you would like for output to the browser.

GroupOutName - The name of the Group out you would like to use.

writeStatus

public void writeStatus(String message,
                        int status)

This method is the new replacement of the writeStatus. The status parameter allows you to set your message type. In general, a zero means the message is neither error nor warning such as "Hello World" type of neutual message. A non-zero value implies an error or a warning. Some of the adapters assume positive integer to be an error message whereas a negative integer to be a warning messsage.

Parameters:

message - The message you would like to output to the browser.

status - The integer value that you would like Info*Engine server to know the type of message.

writeStatus

public void writeStatus(String message,
                        String GroupOutName,
                        int status)

This method is the new replacement of the writeStatus. The status parameter allows you to set your message type. In general, a zero means the message is neither error nor warning such as "Hello World" type of neutual message. A non-zero value implies an error or a warning. Some of the adapters assume positive integer to be an error message whereas a negative integer to be a warning messsage.

Parameters:

message - The message you would like to output to the browser.

GroupOutName - The name of the Group Out you would like to use.

status - The integer value that you would like Info*Engine server to know the type of message.

writeStatus

public void writeStatus(String message,
                        Object[] obj,
                        int status)

This method is the new replacement of the writeStatus. The status parameter allows you to set your message type. In general, a zero means the message is neither error nor warning such as "Hello World" type of neutual message. A non-zero value implies an error or a warning. Some of the adapters assume positive integer to be an error message whereas a negative integer to be a warning messsage. This method is the double byte version of previous setMessage that will use the localized message in your resource bundle.

Parameters:

message - The message you would like to output to the browser.

obj - The varialbe that you would like to be replaced in your resource bundle.

status - The integer value that you would like Info*Engine server to know the type of message.

writeStatus

public void writeStatus(String message,
                        String GroupOutName,
                        Object[] obj,
                        int status)

This method is the new replacement of the writeStatus. The status parameter allows you to set your message type. In general, a zero means the message is neither error nor warning such as "Hello World" type of neutual message. A non-zero value implies an error or a warning. Some of the adapters assume positive integer to be an error message whereas a negative integer to be a warning messsage. This method is the double byte version of previous setMessage that will use the localized message in your resource bundle.

Parameters:

message - The message you would like to output to the browser.

GroupOutName - The name of the Group Out you would like to use.

obj - The varialbe that you would like to be replaced in your resource bundle.

status - The integer value that you would like Info*Engine server to know the type of message.

writeBlobStream

public void writeBlobStream(InputStream fis,
                            String filename,
                            String contentType)

Write one content object of a MIME multipart of object to the output stream to be sent to the browser.

Parameters:

fis - Any input stream type containing the file or the binary data as content data.

filename - The string name that you would like to provide for the Content-Disposition header for the content object.

contentType - The mimetype of the contend object as provided by your with a file or binary data.

readBlobStream

public void readBlobStream(OutputStream fos)

Read the next content object BLOB from the input stream to the output stream provided.

Parameters:

fos - Any output stream on which to write the BLOB.

writeGroupOut

public void writeGroupOut(Hashtable htab)

Write the metadata from the vector-hashtable-vector structure to the output group. JADK maintains two type of internal structures for table output. The writeGroupOut methods work with vector-hashtable-vector structure and the writeGroupOut2 methods work with vector-hashtable structure. In general, the first vector in the two structures is called the head vector. The head vector may contain multiple hashtables that each corresponds to a row for the table. In the first structure, each hashtable's value point to a vector so that it allows multiple values for each field in a row. In the second structure, each key field may have only one value which is saved as key and value pair into the hashtable. Each writeGroupOut or writeGroupOut2 method create a new output group to send to the Info*Engine server. You can create multiple tables or metadata by using these methods repeatedly in your adapter. The following method uses the first structure but starts with the hashtable-vector so there is no head vector. It only output one row or some key and value pairs for the output. It is primarily used with the simple data output. A output group name will be generated by the Info*Engine server if you don't specify the GROUP_OUT parameter in your input webject. Otherwise, the GROUP_OUT value will be used as name.

Parameters:

htab - The hash table containing simple metadata, usually from the backend information system, that you would like to send to the output group.

writeGroupOut

public void writeGroupOut(Hashtable htab,
                          String GroupOutName)

Write the metadata from the vector-hashtable-vector structure to the output group. JADK maintains two type of internal structures for table output. The writeGroupOut methods work with vector-hashtable-vector structure and the writeGroupOut2 methods work with vector-hashtable structure. In general, the first vector in the two structures is called the head vector. The head vector may contain multiple hashtables that each corresponds to a row for the table. In the first structure, each hashtable's value point to a vector so that it allows multiple values for each field in a row. In the second structure, each key field may have only one value which is saved as key and value pair into the hashtable. Each writeGroupOut or writeGroupOut2 method create a new output group to send to the Info*Engine server. You can create multiple tables or metadata by using these methods repeatedly in your adapter. The following method uses the first structure but starts with the hashtable-vector so there is no head vector. It only output one row or some key and value pairs for the output. It is primarily used with the simple data output.

Parameters:

htab - The hash table containing simple metadata, usually from the backend information system, that you would like to send to the output group.

GroupOutName - The name of the output group. You can assign any string value to give the output group a name. This name will be used to replace the GROUP_OUT parameter if you defined one in your input webject.

writeGroupOut

public void writeGroupOut(Vector nodeVec)

Write the metadata from the vector-hashtable-vector structure to the output group. JADK maintains two type of internal structures for table output. The writeGroupOut methods work with vector-hashtable-vector structure and the writeGroupOut2 methods work with vector-hashtable structure. In general, the first vector in the two structures is called the head vector. The head vector may contain multiple hashtables that each corresponds to a row for the table. In the first structure, each hashtable's value point to a vector so that it allows multiple values for each field in a row. In the second structure, each key field may have only one value which is saved as key and value pair into the hashtable. Each writeGroupOut or writeGroupOut2 method create a new output group to send to the Info*Engine server. You can create multiple tables or metadata by using these methods repeatedly in your adapter. The following method uses the first structure with the head vector. It can be used with a table output. A output group name will be generated by the Info*Engine server if you don't specify the GROUP_OUT parameter in your input webject. Otherwise, the GROUP_OUT value will be used as name.

Parameters:

nodeVec - The head vector structure containing a table, usually from the backend, that you would like to send to the Info*Engine server for output.

writeGroupOut

public void writeGroupOut(Vector nodeVec,
                          String GroupOutName)

Write the metadata from the vector-hashtable-vector structure to the output group. JADK maintains two type of internal structures for table output. The writeGroupOut methods work with vector-hashtable-vector structure and the writeGroupOut2 methods work with vector-hashtable structure. In general, the first vector in the two structures is called the head vector. The head vector may contain multiple hashtables that each corresponds to a row for the table. In the first structure, each hashtable's value point to a vector so that it allows multiple values for each field in a row. In the second structure, each key field may have only one value which is saved as key and value pair into the hashtable. Each writeGroupOut or writeGroupOut2 method create a new output group to send to the Info*Engine server. You can create multiple tables or metadata by using these methods repeatedly in your adapter. The following method uses the first structure to send a table to for output to the Info*Engine server.

Parameters:

nodeVec - The head vector containing a table, usually from the backend information system, that you would like to send to the output group.

GroupOutName - The name of the output group. You can assign any string value to give the output group a name. This name will be used to replace the GROUP_OUT parameter if you defined one in your input webject.

writeGroupOut2

public void writeGroupOut2(Vector nodeVec)

Write the metadata from the vector-hashtable-vector structure to the output group. JADK maintains two type of internal structures for table output. The writeGroupOut methods work with vector-hashtable-vector structure and the writeGroupOut2 methods work with vector-hashtable structure. In general, the first vector in the two structures is called the head vector. The head vector may contain multiple hashtables that each corresponds to a row for the table. In the first structure, each hashtable's value point to a vector so that it allows multiple values for each field in a row. In the second structure, each key field may have only one value which is saved as key and value pair into the hashtable. Each writeGroupOut or writeGroupOut2 method create a new output group to send to the Info*Engine server. You can create multiple tables or metadata by using these methods repeatedly in your adapter. The following method uses the second structure with the head vector. It can be used with a table output. A output group name will be generated by the Info*Engine server if you don't specify the GROUP_OUT parameter in your input webject. Otherwise, the GROUP_OUT value will be used as name.

Parameters:

nodeVec - The head vector structure containing a table, usually from the backend, that you would like to send to the Info*Engine server for output.

writeGroupOut2

public void writeGroupOut2(Vector nodeVec,
                           String GroupOutName)

Write the metadata from the vector-hashtable-vector structure to the output group. JADK maintains two type of internal structures for table output. The writeGroupOut methods work with vector-hashtable-vector structure and the writeGroupOut2 methods work with vector-hashtable structure. In general, the first vector in the two structures is called the head vector. The head vector may contain multiple hashtables that each corresponds to a row for the table. In the first structure, each hashtable's value point to a vector so that it allows multiple values for each field in a row. In the second structure, each key field may have only one value which is saved as key and value pair into the hashtable. Each writeGroupOut or writeGroupOut2 method create a new output group to send to the Info*Engine server. You can create multiple tables or metadata by using these methods repeatedly in your adapter. The following method uses the second structure to send a table to for output to the Info*Engine server.

Parameters:

nodeVec - The head vector containing a table, usually from the backend information system, that you would like to send to the output group.

GroupOutName - The name of the output group. You can assign any string value to give the output group a name. This name will be used to replace the GROUP_OUT parameter if you defined one in your input webject.

writeGroupOut2

public void writeGroupOut2(Hashtable htab)

Write the metadata from the vector-hashtable-vector structure to the output group. JADK maintains two type of internal structures for table output. The writeGroupOut methods work with vector-hashtable-vector structure and the writeGroupOut2 methods work with vector-hashtable structure. In general, the first vector in the two structures is called the head vector. The head vector may contain multiple hashtables that each corresponds to a row for the table. In the first structure, each hashtable's value point to a vector so that it allows multiple values for each field in a row. In the second structure, each key field may have only one value which is saved as key and value pair into the hashtable. Each writeGroupOut or writeGroupOut2 method create a new output group to send to the Info*Engine server. You can create multiple tables or metadata by using these methods repeatedly in your adapter. The following method uses the second structure but starts with the hashtable so there is no head vector. It only output one row or some simple key and value pairs for the output. It is primarily used with the simple data output. A output group name will be generated by the Info*Engine server if you don't specify the GROUP_OUT parameter in your input webject. Otherwise, the GROUP_OUT value will be used as name.

Parameters:

htab - The hash table containing simple metadata, usually from the backend information system, that you would like to send to the output group.

writeGroupOut2

public void writeGroupOut2(Hashtable htab,
                           String GroupOutName)

Write the metadata from the vector-hashtable-vector structure to the output group. JADK maintains two type of internal structures for table output. The writeGroupOut methods work with vector-hashtable-vector structure and the writeGroupOut2 methods work with vector-hashtable structure. In general, the first vector in the two structures is called the head vector. The head vector may contain multiple hashtables that each corresponds to a row for the table. In the first structure, each hashtable's value point to a vector so that it allows multiple values for each field in a row. In the second structure, each key field may have only one value which is saved as key and value pair into the hashtable. Each writeGroupOut or writeGroupOut2 method create a new output group to send to the Info*Engine server. You can create multiple tables or metadata by using these methods repeatedly in your adapter. The following method uses the second structure but starts with the hashtable so there is no head vector. It only output one row or some simple key and value pairs for the output. It is primarily used with the simple data output.

Parameters:

htab - The hash table containing simple metadata, usually from the backend information system, that you would like to send to the output group.

GroupOutName - The name of the output group. You can assign any string value to give the output group a name. This name will be used to replace the GROUP_OUT parameter if you defined one in your input webject.

writeObject

public void writeObject(ResultSet rset)
                 throws SQLException

writeObject will pass the ResultSet to Info*Engine to build the VDB.

Parameters:

rset - The result set containing simple metadata, usually from the backend information system, that you would like to send to the output VDB.

Throws:

SQLException

readGroupIn

public Vector readGroupIn()

Read the metadata from group-in into the vector-hashtable-vector structure. readGroupIn methods use the first JADK internal structure as a input format to the adapter.

Returns:

The vector structure with data from group-in.

readGroupIn

public Vector readGroupIn(String GroupInName)

Read the metadata from group-in into the vector-hashtable-vector structure. readGroupIn methods use the first JADK internal struture as the input format to the adapter.

Parameters:

GroupInName - The name of the group-in that you defined in your input webject.

Returns:

The vector structure with data from group-in.