com.softwareag.ino.sxs
Interface SXJBase

All Known Implementing Classes:

ASXJBase

public interface SXJBase

Field Summary

static int	EVENT_NO_CALLBACK Return value of SxsGetInoMsgNo to indicate an illegal callback attempt in an event function.
static int	ILLEGAL_HANDLE_TYPE Return value of SxsGetMsgNo to indicate an illegal handle type in an ODBC callback.
static int	ILLEGAL_SQL_COMMAND Return value of SxsGetMsgNo to indicate an illegal SQL command (commit or rollback) in an ODBC callback.
static int	INO_ERROR Return value of SxsGetMsgNo to indicate an XML error.
static int	INVALID_BUFFER Return value of SxsGetMsgNo to indicate an invalid (not initialized) buffer given to a callback method.
static int	IS_REPLICATION Value for parameter callType of SxsSystem.
static int	JVM_USEROPTIONS Value for parameter callType of SxsSystem.
static int	NO_CALLBACK_ENVIRON Return value of SxsGetMsgNo to indicate that callback environment was not set up.
static int	NO_ODBC_CALLBACK Return value of SxsGetMsgNo to indicate that ODBC callback is not available.
static int	PASSWORD Value for parameter callType of SxsSystem.
static int	PROPERTY_RSP_MEDIATYPE Value for parameter callType of SxsSetProperty.
static java.lang.String	REQUEST_ACCEPTED_CHARSETS Value for parameter attrName of SxsGetHttpHeaderField.
static java.lang.String	REQUEST_CLIENT_ADDRESS Value for parameter attrName of SxsGetHttpHeaderField.
static java.lang.String	REQUEST_CLIENT_HOST Value for parameter attrName of SxsGetHttpHeaderField.
static java.lang.String	REQUEST_CONTENT_LENGTH
static java.lang.String	REQUEST_CONTENT_TYPE Value for parameter attrName of SxsGetHttpHeaderField.
static java.lang.String	REQUEST_DOCUMENT_MEDIATYPE Value for parameter attrName of SxsGetHttpHeaderField.
static java.lang.String	REQUEST_LENGTH Value for parameter attrName of SxsGetHttpHeaderField.
static java.lang.String	REQUEST_MEDIATYPE Value for parameter attrName of SxsGetHttpHeaderField.
static java.lang.String	REQUEST_METHOD Value for parameter attrName of SxsGetHttpHeaderField.
static java.lang.String	REQUEST_PREFERRED_LANGUAGE Value for parameter attrName of SxsGetHttpHeaderField.
static java.lang.String	REQUEST_QUERY_STRING
static java.lang.String	REQUEST_REMOTE_ADDRESS
static java.lang.String	REQUEST_REMOTE_HOST
static java.lang.String	REQUEST_SERVER_HOST Value for parameter attrName of SxsGetHttpHeaderField.
static java.lang.String	REQUEST_STRING Value for parameter attrName of SxsGetHttpHeaderField.
static java.lang.String	REQUEST_URI Value for parameter attrName of SxsGetHttpHeaderField.
static java.lang.String	REQUEST_URI_PREFIX Value for parameter attrName of SxsGetHttpHeaderField.
static int	SCHEMA_NODE_INFO Value for parameter callType of SxsSystem.
static int	SERVER_READ_ONLY Value for parameter callType of SxsSystem.
static int	SERVERURL Value for parameter callType of SxsSystem.
static int	SESSIONID Value for parameter callType of SxsSystem.
static short	SQL_BIGINT SQL extended data type.
static short	SQL_BINARY SQL extended data type.
static short	SQL_BIT SQL extended data type.
static short	SQL_C_CHAR C data type SQL_C_CHAR is mapped to SQL data type SQL_CHAR.
static short	SQL_C_DATE C data type SQL_C_DATE is mapped to SQL data type SQL_DATE.
static short	SQL_C_DEFAULT C data type SQL_C_DEFAULT to map parameter to the default C data type specified for the SQL data type.
static short	SQL_C_DOUBLE C data type SQL_C_DOUBLE is mapped to SQL data type SQL_DOUBLE.
static short	SQL_C_FLOAT C data type SQL_C_FLOAT is mapped to SQL data type SQL_REAL.
static short	SQL_C_LONG C data type SQL_C_LONG is mapped to SQL data type SQL_INTEGER.
static short	SQL_C_NUMERIC C data type SQL_C_NUMERIC is mapped to SQL data type SQL_NUMERIC.
static short	SQL_C_SHORT C data type SQL_C_SHORT is mapped to SQL data type SQL_SMALLINT.
static short	SQL_C_TIME C data type SQL_C_TIME is mapped to SQL data type SQL_TIME.
static short	SQL_C_TIMESTAMP C data type SQL_C_TIMESTAMP is mapped to SQL data type SQL_TIMESTAMP.
static int	SQL_CALLB_ERROR Return value of SxsGetMsgNo to indicate an SQL error in an ODBC callback.
static short	SQL_CHAR SQL data type.
static int	SQL_DATA_AT_EXEC Return value of parameter StrLen_or_IndPtr to indicate a long value to be sent by SQL_Execute.
static short	SQL_DATE SQL extended data type.
static short	SQL_DATETIME SQL data type.
static short	SQL_DECIMAL SQL data type.
static short	SQL_DIAG_CLASS_ORIGIN To get a string that indicates the class portion of the SQL state using SxsSQLGetDiagField.
static short	SQL_DIAG_CONNECTION_NAME To get the name of the connection that the diagnostic record relates to using SxsSQLGetDiagField.
static short	SQL_DIAG_DYNAMIC_FUNCTION To get a description of the SQL statement of the underlying function using SxsSQLGetDiagField.
static short	SQL_DIAG_DYNAMIC_FUNCTION_CODE To get a numeric code of the SQL statement of the underlying function using SxsSQLGetDiagField.
static short	SQL_DIAG_MESSAGE_TEXT To get the informal error message or warning using SxsSQLGetDiagField.
static short	SQL_DIAG_NATIVE To get the driver-specific error code using SxsSQLGetDiagField.
static short	SQL_DIAG_NUMBER To get the number of status records using SxsSQLGetDiagField.
static short	SQL_DIAG_RETURNCODE Value for parameter DiagIdentifier of SxsSQLGetDiagField.
static short	SQL_DIAG_ROW_COUNT To get the number of rows affected by an SQL command using SxsSQLGetDiagField.
static short	SQL_DIAG_SERVER_NAME To get the name of the server that the diagnostic record relates to using SxsSQLGetDiagField.
static short	SQL_DIAG_SQLSTATE To get the SQL state using SxsSQLGetDiagField.
static short	SQL_DIAG_SUBCLASS_ORIGIN To get a string that indicates the subclass portion of the SQL state using SxsSQLGetDiagField.
static short	SQL_DOUBLE SQL data type.
static int	SQL_ERROR Return value of ODBC callback methods to indicate that an SQL error occurred.
static short	SQL_FLOAT SQL data type.
static short	SQL_GUID SQL extended data type.
static short	SQL_HANDLE_DBC Handle type 'connection handle'.
static short	SQL_HANDLE_DESC Handle type 'descriptor handle'.
static short	SQL_HANDLE_ENV Handle type 'environment handle'.
static short	SQL_HANDLE_STMT Handle type 'statement handle'.
static short	SQL_INTEGER SQL data type.
static short	SQL_INTERVAL SQL extended data type.
static int	SQL_INVALID_HANDLE Return value of ODBC callback methods to indicate that an invalid handle was given.
static short	SQL_LONGVARBINARY SQL extended data type.
static short	SQL_LONGVARCHAR SQL extended data type.
static int	SQL_NEED_DATA Return value of ODBC callback methods to indicate that more data is required.
static int	SQL_NO_DATA Return value of ODBC callback methods to indicate that no more data is available.
static int	SQL_NTS Special value in parameter StrLen_or_IndPtr to indicate a null terminated string.
static int	SQL_NULL_DATA Special value in parameter StrLen_or_IndPtr to indicate a null value.
static short	SQL_NUMERIC SQL data type.
static short	SQL_PARAM_INPUT Value for parameter InputOutputType of SxsSQLBindParameter.
static short	SQL_PARAM_INPUT_OUTPUT Value for parameter InputOutputType of SxsSQLBindParameter.
static short	SQL_PARAM_OUTPUT Value for parameter InputOutputType of SxsSQLBindParameter.
static short	SQL_PARAM_TYPE_UNKNOWN Value for parameter InputOutputType of SxsSQLBindParameter.
static short	SQL_REAL SQL data type.
static short	SQL_RESULT_COL Value for parameter InputOutputType of SxsSQLBindParameter.
static short	SQL_RETURN_VALUE Value for parameter InputOutputType of SxsSQLBindParameter.
static short	SQL_SMALLINT SQL data type.
static int	SQL_STILL_EXECUTING Return value of ODBC callback methods to indicate that method is still executing.
static int	SQL_SUCCESS Return value of callback methods to indicate successful completion.
static int	SQL_SUCCESS_WITH_INFO Return value of ODBC callback methods to indicate successful completion with a warning.
static short	SQL_TIME SQL extended data type.
static short	SQL_TIMESTAMP SQL extended data type.
static short	SQL_TINYINT SQL extended data type.
static short	SQL_TYPE_DATE SQL data type (one-parameter shortcut).
static short	SQL_TYPE_TIME SQL data type (one-parameter shortcut).
static short	SQL_TYPE_TIMESTAMP SQL data type (one-parameter shortcut).
static short	SQL_UNKNOWN_TYPE SQL data type.
static short	SQL_VARBINARY SQL extended data type.
static short	SQL_VARCHAR SQL data type.
static int	SX_IS_REPLICATION
static int	SX_JVM_USEROPTIONS
static int	SX_PASSWORD
static int	SX_PROPERTY_RSP_MEDIATYPE
static int	SX_SCHEMA_NODE_INFO
static int	SX_SERVER_READ_ONLY
static int	SX_SERVERURL
static int	SX_SESSIONID
static int	SX_USERID
static int	SX_USERURL
static int	SX_XML_CLOSED_CONTENT
static int	SX_XML_DEF_ENCODING
static int	SX_XML_DEF_TOKENIZER
static int	SX_XML_SERVER_VERSION
static int	SX_XNODE_DEF_ENCODING
static int	SX_XTENSION_COM_USAGE
static int	SX_XTENSION_DIRECT_USAGE
static int	SX_XTENSION_JAVA_USAGE
static int	USERID Value for parameter callType of SxsSystem.
static int	USERURL Value for parameter callType of SxsSystem.
static java.lang.String	WEBSERVER_ADDRESS Value for parameter attrName of SxsGetHttpHeaderField.
static int	XML_CLOSED_CONTENT Value for parameter callType of SxsSystem.
static int	XML_COMMIT XML event type 'commit transaction'.
static int	XML_CONNECTION_END XML event type 'end of connection'.
static int	XML_DEF_ENCODING Value for parameter callType of SxsSystem.
static int	XML_DEF_TOKENIZER Value for parameter callType of SxsSystem.
static int	XML_REQUEST_END XML event type 'end of request'.
static int	XML_ROLLBACK XML event type 'rollback transaction'.
static int	XML_SERVER_VERSION Value for parameter callType of SxsSystem.
static int	XML_SUB_COMMIT XML event type 'commit subtransaction'.
static int	XML_SUB_ROLLBACK XML event type 'rollback subtransaction'.
static int	XNODE_DEF_ENCODING Value for parameter callType of SxsSystem.
static int	XTENSION_COM_USAGE Value for parameter callType of SxsSystem.
static int	XTENSION_DIRECT_USAGE Value for parameter callType of SxsSystem.
static int	XTENSION_JAVA_USAGE Value for parameter callType of SxsSystem.

Method Summary

int	pt_c(char[] var, char val) Callback method for server trace.
int	pt_decl(char[] pszName, int errlev) Callback method for server trace.
int	pt_i(char[] var, int val) Callback method for server trace.
int	pt_leave() Callback method for server trace.
int	pt_s(char[] var, char[] val) Callback method for server trace.
int	pt_text(char[] text) Callback method for server trace.
int	pt_ws(char[] var, char[] val) Callback method for server trace.
void	SxsException(int errnr, java.lang.String msg) Tells the Tamino server that an exception happened in a Java extension.
int	SxsGetDocument(java.lang.String collection, java.lang.String doctype, int inoid, Result result) Get a XML/non-XML document from Tamino based on the ino:id.
int	SxsGetDocument(java.lang.String collection, java.lang.String doctype, java.lang.String documentId, Result result) Get a XML/non-XML document from Tamino based on the docname/ino:id.
int	SxsGetHttpHeaderField(java.lang.String attrName, java.lang.StringBuffer value) Get an attribute value of the HTTP header of the request
int	SxsGetInoMsgNo() Gets the error number if an XML request via callback failed.
int	SxsGetMsgNo() Gets the error number if a callback method failed.
java.lang.String	SxsGetMsgText() Gets the error message if a callback method failed.
int	SxsGetNonXMLDocument(java.lang.String collection, java.lang.String doctype, int inoid, java.io.ByteArrayOutputStream nonXmlDoc) Get a NonXML document from Tamino based on the ino:id.
int	SxsGetNonXMLDocument(java.lang.String collection, java.lang.String doctype, java.lang.String documentId, java.io.ByteArrayOutputStream nonXmlDoc) Get a NonXML document from Tamino based on the docname/ino:id.
int	SxsGetPasswordAuthentication(SxsPasswordAuthentication auth) Get the UserId/Password for the current user as a Java PasswordAuthentication object
int	SxsGetProperty(int property, java.lang.StringBuffer value) Get a property via callback.
int	SxsGetSQLMsgNo() Gets the error number an SQL query via ODBC callback failed.
java.lang.String	SxsGetStackTrace() Gets the stack trace of a call.
int	SxsPutDocument(InputDocument document, java.lang.StringBuffer response) Inserts an XML/Non-XML document into the Tamino server via callback.
int	SxsRepairOperation(java.lang.String op, java.lang.String[] data, java.lang.StringBuffer value) Perform specified operation for OnStartup repairs.
int	SxsSetProperty(int property, java.lang.String value) Set a property via callback.
int	SxsSQLAllocHandle(short HandleType, int InputHandle, IntRef OutputHandle) Creates an ODBC statement handle.
int	SxsSQLBindCol(int StatementHandle, short ColumnNumber, short TargetType, byte[] TargetValue, int BufferLength, IntRef StrLen_or_IndPtr) Binds a buffer to a result column of an SQL query.
int	SxsSQLBindParameter(int StatementHandle, short ParameterNumber, short InputOutputType, short ValueType, short ParameterType, int ColumnSize, short DecimalDigits, byte[] ParameterValuePtr, int BufferLength, IntRef StrLen_or_IndPtr) Binds a buffer to an input parameter of an SQL statement.
int	SxsSQLCloseCursor(int StatementHandle) Closes the cursor of an SQL query via ODBC callback.
int	SxsSQLExecute(int StatementHandle) Executes an SQL statement via ODBC callback.
int	SxsSQLFetch(int StatementHandle) Fetches the next result row of an SQL statement via ODBC callback.
int	SxsSQLFreeHandle(short HandleType, int Handle) Drops an ODBC statement handle via callback.
int	SxsSQLGetConnect(java.lang.String dbName, java.lang.String userName, java.lang.String password, IntRef Handle) Creates a connection to the OCDC interface of a Tamino server via callback.
int	SxsSQLGetData(int StatementHandle, short ColumnNumber, short TargetType, byte[] TargetValue, int BufferLength, IntRef StrLen_or_IndPtr) Writes the value of a result column into a buffer.
int	SxsSQLGetDiagField(short HandleType, int Handle, short RecNumber, short DiagIdentifier, byte[] DiagInfoPtr, short BufferLength, IntRef StringLengthPtr) Returns the current value of a field of a record of the diagnostic data structure for a handle.
int	SxsSQLPrepare(int StatementHandle, java.lang.String StatementText) Prepares an SQL statement via ODBC callback.
int	SxsSystem(int callType, java.lang.StringBuffer property) Get a system property from the Tamino server via callback.
int	SxsTrace(java.lang.String packet) Writes a message into the extension trace via callback.
int	SXSTrace(java.lang.String packet) Writes a message into the extension trace via callback (spelling like in COM).
void	SxsWarning(int warnNum, java.lang.String msg) Informs the Tamino server that a warning has occurred.
int	SxsXMLAdmin(java.lang.String command, java.lang.StringBuffer response) Perform an admin command in the Tamino server via callback.
int	SxsXMLDefine(java.lang.String xmlSchema, java.lang.StringBuffer response) Defines an XML schema in the Tamino server via callback.
int	SxsXMLDefine(java.lang.String xmlSchema, java.lang.String mode, java.lang.StringBuffer response) Defines an XML schema in the Tamino server via callback.
int	SxsXMLDelete(java.lang.String collection, java.lang.String query, java.lang.StringBuffer response) Deletes an XML document from the Tamino server via callback.
int	SxsXMLGetMessage(java.lang.StringBuffer msgContent) Gets the last message from the Tamino server via callback.
int	SxsXMLProcess(java.lang.String collection, java.lang.String xmlDoc, java.lang.StringBuffer response) Inserts an XML document into the Tamino server via callback.
int	SxsXMLProcess(java.lang.String collection, java.lang.String xmlDoc, java.lang.StringBuffer response, boolean hasResultElement) Inserts an XML document into the Tamino server via callback.
int	SxsXMLUndefine(java.lang.String collection, java.lang.String schema, java.lang.String doctype, java.lang.StringBuffer response) Undefine a collection, schema or doctype in the Tamino server via callback.
int	SxsXMLXql(java.lang.String collection, java.lang.String query, java.lang.StringBuffer response) Performs an XQL query in the Tamino server via a callback.
int	SxsXMLXQuery(java.lang.String collection, java.lang.String query, java.util.Map values, Result result) Performs an XQuery in the Tamino server via a callback.
int	SxsXMLXQuery(java.lang.String collection, java.lang.String query, java.util.Map values, Result result, boolean hasResultElement) Performs an XQuery in the Tamino server via a callback.
int	SxsXMLXQuery(java.lang.String collection, java.lang.String query, Result result) Performs an XQuery in the Tamino server via a callback.
int	SxsXMLXQuery(java.lang.String collection, java.lang.String query, Result result, boolean hasResultElement) Performs an XQuery in the Tamino server via a callback.

Field Detail

XML_REQUEST_END

static final int XML_REQUEST_END

XML event type 'end of request'.

See Also:

Constant Field Values

XML_COMMIT

static final int XML_COMMIT

XML event type 'commit transaction'.

See Also:

Constant Field Values

XML_ROLLBACK

static final int XML_ROLLBACK

XML event type 'rollback transaction'.

See Also:

Constant Field Values

XML_CONNECTION_END

static final int XML_CONNECTION_END

XML event type 'end of connection'.

See Also:

Constant Field Values

XML_SUB_COMMIT

static final int XML_SUB_COMMIT

XML event type 'commit subtransaction'.

See Also:

Constant Field Values

XML_SUB_ROLLBACK

static final int XML_SUB_ROLLBACK

XML event type 'rollback subtransaction'.

See Also:

Constant Field Values

SERVERURL

static final int SERVERURL

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_SERVERURL

static final int SX_SERVERURL

See Also:

Constant Field Values

USERID

static final int USERID

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_USERID

static final int SX_USERID

See Also:

Constant Field Values

PASSWORD

static final int PASSWORD

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_PASSWORD

static final int SX_PASSWORD

See Also:

Constant Field Values

USERURL

static final int USERURL

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_USERURL

static final int SX_USERURL

See Also:

Constant Field Values

SESSIONID

static final int SESSIONID

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_SESSIONID

static final int SX_SESSIONID

See Also:

Constant Field Values

SCHEMA_NODE_INFO

static final int SCHEMA_NODE_INFO

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_SCHEMA_NODE_INFO

static final int SX_SCHEMA_NODE_INFO

See Also:

Constant Field Values

SERVER_READ_ONLY

static final int SERVER_READ_ONLY

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_SERVER_READ_ONLY

static final int SX_SERVER_READ_ONLY

See Also:

Constant Field Values

XML_DEF_ENCODING

static final int XML_DEF_ENCODING

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_XML_DEF_ENCODING

static final int SX_XML_DEF_ENCODING

See Also:

Constant Field Values

XML_DEF_TOKENIZER

static final int XML_DEF_TOKENIZER

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_XML_DEF_TOKENIZER

static final int SX_XML_DEF_TOKENIZER

See Also:

Constant Field Values

XML_CLOSED_CONTENT

static final int XML_CLOSED_CONTENT

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_XML_CLOSED_CONTENT

static final int SX_XML_CLOSED_CONTENT

See Also:

Constant Field Values

XNODE_DEF_ENCODING

static final int XNODE_DEF_ENCODING

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_XNODE_DEF_ENCODING

static final int SX_XNODE_DEF_ENCODING

See Also:

Constant Field Values

XTENSION_JAVA_USAGE

static final int XTENSION_JAVA_USAGE

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_XTENSION_JAVA_USAGE

static final int SX_XTENSION_JAVA_USAGE

See Also:

Constant Field Values

XTENSION_COM_USAGE

static final int XTENSION_COM_USAGE

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_XTENSION_COM_USAGE

static final int SX_XTENSION_COM_USAGE

See Also:

Constant Field Values

XTENSION_DIRECT_USAGE

static final int XTENSION_DIRECT_USAGE

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_XTENSION_DIRECT_USAGE

static final int SX_XTENSION_DIRECT_USAGE

See Also:

Constant Field Values

IS_REPLICATION

static final int IS_REPLICATION

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_IS_REPLICATION

static final int SX_IS_REPLICATION

See Also:

Constant Field Values

JVM_USEROPTIONS

static final int JVM_USEROPTIONS

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_JVM_USEROPTIONS

static final int SX_JVM_USEROPTIONS

See Also:

Constant Field Values

XML_SERVER_VERSION

static final int XML_SERVER_VERSION

Value for parameter callType of SxsSystem.

See Also:

Constant Field Values

SX_XML_SERVER_VERSION

static final int SX_XML_SERVER_VERSION

See Also:

Constant Field Values

PROPERTY_RSP_MEDIATYPE

static final int PROPERTY_RSP_MEDIATYPE

Value for parameter callType of SxsSetProperty.

and SxsGetProperty.

See Also:

Constant Field Values

SX_PROPERTY_RSP_MEDIATYPE

static final int SX_PROPERTY_RSP_MEDIATYPE

See Also:

Constant Field Values

REQUEST_URI

static final java.lang.String REQUEST_URI

Value for parameter attrName of SxsGetHttpHeaderField.

See Also:

Constant Field Values

REQUEST_STRING

static final java.lang.String REQUEST_STRING

Value for parameter attrName of SxsGetHttpHeaderField.

See Also:

Constant Field Values

REQUEST_QUERY_STRING

static final java.lang.String REQUEST_QUERY_STRING

See Also:

Constant Field Values

REQUEST_METHOD

static final java.lang.String REQUEST_METHOD

Value for parameter attrName of SxsGetHttpHeaderField.

See Also:

Constant Field Values

REQUEST_CLIENT_ADDRESS

static final java.lang.String REQUEST_CLIENT_ADDRESS

Value for parameter attrName of SxsGetHttpHeaderField.

See Also:

Constant Field Values

REQUEST_REMOTE_ADDRESS

static final java.lang.String REQUEST_REMOTE_ADDRESS

See Also:

Constant Field Values

REQUEST_CLIENT_HOST

static final java.lang.String REQUEST_CLIENT_HOST

Value for parameter attrName of SxsGetHttpHeaderField.

See Also:

Constant Field Values

REQUEST_REMOTE_HOST

static final java.lang.String REQUEST_REMOTE_HOST

See Also:

Constant Field Values

REQUEST_SERVER_HOST

static final java.lang.String REQUEST_SERVER_HOST

Value for parameter attrName of SxsGetHttpHeaderField.

See Also:

Constant Field Values

REQUEST_LENGTH

static final java.lang.String REQUEST_LENGTH

Value for parameter attrName of SxsGetHttpHeaderField.

See Also:

Constant Field Values

REQUEST_CONTENT_LENGTH

static final java.lang.String REQUEST_CONTENT_LENGTH

See Also:

Constant Field Values

REQUEST_CONTENT_TYPE

static final java.lang.String REQUEST_CONTENT_TYPE

Value for parameter attrName of SxsGetHttpHeaderField.

See Also:

Constant Field Values

REQUEST_MEDIATYPE

static final java.lang.String REQUEST_MEDIATYPE

Value for parameter attrName of SxsGetHttpHeaderField.

See Also:

Constant Field Values

REQUEST_ACCEPTED_CHARSETS

static final java.lang.String REQUEST_ACCEPTED_CHARSETS

Value for parameter attrName of SxsGetHttpHeaderField.

See Also:

Constant Field Values

REQUEST_PREFERRED_LANGUAGE

static final java.lang.String REQUEST_PREFERRED_LANGUAGE

Value for parameter attrName of SxsGetHttpHeaderField.

See Also:

Constant Field Values

REQUEST_DOCUMENT_MEDIATYPE

static final java.lang.String REQUEST_DOCUMENT_MEDIATYPE

Value for parameter attrName of SxsGetHttpHeaderField.

See Also:

Constant Field Values

REQUEST_URI_PREFIX

static final java.lang.String REQUEST_URI_PREFIX

Value for parameter attrName of SxsGetHttpHeaderField.

See Also:

Constant Field Values

WEBSERVER_ADDRESS

static final java.lang.String WEBSERVER_ADDRESS

Value for parameter attrName of SxsGetHttpHeaderField.

See Also:

Constant Field Values

SQL_HANDLE_ENV

static final short SQL_HANDLE_ENV

Handle type 'environment handle'.

See Also:

Constant Field Values

SQL_HANDLE_DBC

static final short SQL_HANDLE_DBC

Handle type 'connection handle'.

See Also:

Constant Field Values

SQL_HANDLE_STMT

static final short SQL_HANDLE_STMT

Handle type 'statement handle'.

See Also:

Constant Field Values

SQL_HANDLE_DESC

static final short SQL_HANDLE_DESC

Handle type 'descriptor handle'.

See Also:

Constant Field Values

SQL_UNKNOWN_TYPE

static final short SQL_UNKNOWN_TYPE

SQL data type.

See Also:

Constant Field Values

SQL_CHAR

static final short SQL_CHAR

SQL data type.

See Also:

Constant Field Values

SQL_NUMERIC

static final short SQL_NUMERIC

SQL data type.

See Also:

Constant Field Values

SQL_DECIMAL

static final short SQL_DECIMAL

SQL data type.

See Also:

Constant Field Values

SQL_INTEGER

static final short SQL_INTEGER

SQL data type.

See Also:

Constant Field Values

SQL_SMALLINT

static final short SQL_SMALLINT

SQL data type.

See Also:

Constant Field Values

SQL_FLOAT

static final short SQL_FLOAT

SQL data type.

See Also:

Constant Field Values

SQL_REAL

static final short SQL_REAL

SQL data type.

See Also:

Constant Field Values

SQL_DOUBLE

static final short SQL_DOUBLE

SQL data type.

See Also:

Constant Field Values

SQL_DATETIME

static final short SQL_DATETIME

SQL data type.

See Also:

Constant Field Values

SQL_VARCHAR

static final short SQL_VARCHAR

SQL data type.

See Also:

Constant Field Values

SQL_TYPE_DATE

static final short SQL_TYPE_DATE

SQL data type (one-parameter shortcut).

See Also:

Constant Field Values

SQL_TYPE_TIME

static final short SQL_TYPE_TIME

SQL data type (one-parameter shortcut).

See Also:

Constant Field Values

SQL_TYPE_TIMESTAMP

static final short SQL_TYPE_TIMESTAMP

SQL data type (one-parameter shortcut).

See Also:

Constant Field Values

SQL_DATE

static final short SQL_DATE

SQL extended data type.

See Also:

Constant Field Values

SQL_INTERVAL

static final short SQL_INTERVAL

SQL extended data type.

See Also:

Constant Field Values

SQL_TIME

static final short SQL_TIME

SQL extended data type.

See Also:

Constant Field Values

SQL_TIMESTAMP

static final short SQL_TIMESTAMP

SQL extended data type.

See Also:

Constant Field Values

SQL_LONGVARCHAR

static final short SQL_LONGVARCHAR

SQL extended data type.

See Also:

Constant Field Values

SQL_BINARY

static final short SQL_BINARY

SQL extended data type.

See Also:

Constant Field Values

SQL_VARBINARY

static final short SQL_VARBINARY

SQL extended data type.

See Also:

Constant Field Values

SQL_LONGVARBINARY

static final short SQL_LONGVARBINARY

SQL extended data type.

See Also:

Constant Field Values

SQL_BIGINT

static final short SQL_BIGINT

SQL extended data type.

See Also:

Constant Field Values

SQL_TINYINT

static final short SQL_TINYINT

SQL extended data type.

See Also:

Constant Field Values

SQL_BIT

static final short SQL_BIT

SQL extended data type.

See Also:

Constant Field Values

SQL_GUID

static final short SQL_GUID

SQL extended data type.

See Also:

Constant Field Values

SQL_C_CHAR

static final short SQL_C_CHAR

C data type SQL_C_CHAR is mapped to SQL data type SQL_CHAR.

See Also:

Constant Field Values

SQL_C_LONG

static final short SQL_C_LONG

C data type SQL_C_LONG is mapped to SQL data type SQL_INTEGER.

See Also:

Constant Field Values

SQL_C_SHORT

static final short SQL_C_SHORT

C data type SQL_C_SHORT is mapped to SQL data type SQL_SMALLINT.

See Also:

Constant Field Values

SQL_C_FLOAT

static final short SQL_C_FLOAT

C data type SQL_C_FLOAT is mapped to SQL data type SQL_REAL.

See Also:

Constant Field Values

SQL_C_DOUBLE

static final short SQL_C_DOUBLE

C data type SQL_C_DOUBLE is mapped to SQL data type SQL_DOUBLE.

See Also:

Constant Field Values

SQL_C_NUMERIC

static final short SQL_C_NUMERIC

C data type SQL_C_NUMERIC is mapped to SQL data type SQL_NUMERIC.

See Also:

Constant Field Values

SQL_C_DEFAULT

static final short SQL_C_DEFAULT

C data type SQL_C_DEFAULT to map parameter to the default C data type specified for the SQL data type.

See Also:

Constant Field Values

SQL_C_DATE

static final short SQL_C_DATE

C data type SQL_C_DATE is mapped to SQL data type SQL_DATE.

See Also:

Constant Field Values

SQL_C_TIME

static final short SQL_C_TIME

C data type SQL_C_TIME is mapped to SQL data type SQL_TIME.

See Also:

Constant Field Values

SQL_C_TIMESTAMP

static final short SQL_C_TIMESTAMP

C data type SQL_C_TIMESTAMP is mapped to SQL data type SQL_TIMESTAMP.

See Also:

Constant Field Values

SQL_PARAM_TYPE_UNKNOWN

static final short SQL_PARAM_TYPE_UNKNOWN

Value for parameter InputOutputType of SxsSQLBindParameter.

See Also:

Constant Field Values

SQL_PARAM_INPUT

static final short SQL_PARAM_INPUT

Value for parameter InputOutputType of SxsSQLBindParameter.

See Also:

Constant Field Values

SQL_PARAM_INPUT_OUTPUT

static final short SQL_PARAM_INPUT_OUTPUT

Value for parameter InputOutputType of SxsSQLBindParameter.

See Also:

Constant Field Values

SQL_RESULT_COL

static final short SQL_RESULT_COL

Value for parameter InputOutputType of SxsSQLBindParameter.

See Also:

Constant Field Values

SQL_PARAM_OUTPUT

static final short SQL_PARAM_OUTPUT

Value for parameter InputOutputType of SxsSQLBindParameter.

See Also:

Constant Field Values

SQL_RETURN_VALUE

static final short SQL_RETURN_VALUE

Value for parameter InputOutputType of SxsSQLBindParameter.

See Also:

Constant Field Values

SQL_NULL_DATA

static final int SQL_NULL_DATA

Special value in parameter StrLen_or_IndPtr to indicate a null value.

See Also:

Constant Field Values

SQL_NTS

static final int SQL_NTS

Special value in parameter StrLen_or_IndPtr to indicate a null terminated string.

See Also:

Constant Field Values

SQL_DATA_AT_EXEC

static final int SQL_DATA_AT_EXEC

Return value of parameter StrLen_or_IndPtr to indicate a long value to be sent by SQL_Execute.

Not yet supported by Tamino ODBC callbacks.

See Also:

Constant Field Values

SQL_SUCCESS

static final int SQL_SUCCESS

Return value of callback methods to indicate successful completion.

See Also:

Constant Field Values

SQL_SUCCESS_WITH_INFO

static final int SQL_SUCCESS_WITH_INFO

Return value of ODBC callback methods to indicate successful completion with a warning.

See Also:

Constant Field Values

SQL_NO_DATA

static final int SQL_NO_DATA

Return value of ODBC callback methods to indicate that no more data is available.

See Also:

Constant Field Values

SQL_ERROR

static final int SQL_ERROR

Return value of ODBC callback methods to indicate that an SQL error occurred.

See Also:

Constant Field Values

SQL_INVALID_HANDLE

static final int SQL_INVALID_HANDLE

Return value of ODBC callback methods to indicate that an invalid handle was given.

See Also:

Constant Field Values

SQL_STILL_EXECUTING

static final int SQL_STILL_EXECUTING

Return value of ODBC callback methods to indicate that method is still executing.

See Also:

Constant Field Values

SQL_NEED_DATA

static final int SQL_NEED_DATA

Return value of ODBC callback methods to indicate that more data is required.

See Also:

Constant Field Values

SQL_DIAG_RETURNCODE

static final short SQL_DIAG_RETURNCODE

Value for parameter DiagIdentifier of SxsSQLGetDiagField.

See Also:

Constant Field Values

SQL_DIAG_NUMBER

static final short SQL_DIAG_NUMBER

To get the number of status records using SxsSQLGetDiagField.

Value for parameter DiagIdentifier

See Also:

Constant Field Values

SQL_DIAG_ROW_COUNT

static final short SQL_DIAG_ROW_COUNT

To get the number of rows affected by an SQL command using SxsSQLGetDiagField.

Value for parameter DiagIdentifier

See Also:

Constant Field Values

SQL_DIAG_SQLSTATE

static final short SQL_DIAG_SQLSTATE

To get the SQL state using SxsSQLGetDiagField.

Value for parameter DiagIdentifier

See Also:

Constant Field Values

SQL_DIAG_NATIVE

static final short SQL_DIAG_NATIVE

To get the driver-specific error code using SxsSQLGetDiagField.

Value for parameter DiagIdentifier

See Also:

Constant Field Values

SQL_DIAG_MESSAGE_TEXT

static final short SQL_DIAG_MESSAGE_TEXT

To get the informal error message or warning using SxsSQLGetDiagField.

Value for parameter DiagIdentifier

See Also:

Constant Field Values

SQL_DIAG_DYNAMIC_FUNCTION

static final short SQL_DIAG_DYNAMIC_FUNCTION

To get a description of the SQL statement of the underlying function using SxsSQLGetDiagField.

Value for parameter DiagIdentifier

See Also:

Constant Field Values

SQL_DIAG_CLASS_ORIGIN

static final short SQL_DIAG_CLASS_ORIGIN

To get a string that indicates the class portion of the SQL state using SxsSQLGetDiagField.

Value for parameter DiagIdentifier

See Also:

Constant Field Values

SQL_DIAG_SUBCLASS_ORIGIN

static final short SQL_DIAG_SUBCLASS_ORIGIN

To get a string that indicates the subclass portion of the SQL state using SxsSQLGetDiagField.

Value for parameter DiagIdentifier

See Also:

Constant Field Values

SQL_DIAG_CONNECTION_NAME

static final short SQL_DIAG_CONNECTION_NAME

To get the name of the connection that the diagnostic record relates to using SxsSQLGetDiagField.

Value for parameter DiagIdentifier

See Also:

Constant Field Values

SQL_DIAG_SERVER_NAME

static final short SQL_DIAG_SERVER_NAME

To get the name of the server that the diagnostic record relates to using SxsSQLGetDiagField.

Value for parameter DiagIdentifier

See Also:

Constant Field Values

SQL_DIAG_DYNAMIC_FUNCTION_CODE

static final short SQL_DIAG_DYNAMIC_FUNCTION_CODE

To get a numeric code of the SQL statement of the underlying function using SxsSQLGetDiagField.

Value for parameter DiagIdentifier

See Also:

Constant Field Values

INO_ERROR

static final int INO_ERROR

Return value of SxsGetMsgNo to indicate an XML error.

See Also:

Constant Field Values

SQL_CALLB_ERROR

static final int SQL_CALLB_ERROR

Return value of SxsGetMsgNo to indicate an SQL error in an ODBC callback.

See Also:

Constant Field Values

ILLEGAL_HANDLE_TYPE

static final int ILLEGAL_HANDLE_TYPE

Return value of SxsGetMsgNo to indicate an illegal handle type in an ODBC callback.

See Also:

Constant Field Values

ILLEGAL_SQL_COMMAND

static final int ILLEGAL_SQL_COMMAND

Return value of SxsGetMsgNo to indicate an illegal SQL command (commit or rollback) in an ODBC callback.

See Also:

Constant Field Values

INVALID_BUFFER

static final int INVALID_BUFFER

Return value of SxsGetMsgNo to indicate an invalid (not initialized) buffer given to a callback method.

See Also:

Constant Field Values

NO_ODBC_CALLBACK

static final int NO_ODBC_CALLBACK

Return value of SxsGetMsgNo to indicate that ODBC callback is not available.

See Also:

Constant Field Values

NO_CALLBACK_ENVIRON

static final int NO_CALLBACK_ENVIRON

Return value of SxsGetMsgNo to indicate that callback environment was not set up.

See Also:

Constant Field Values

EVENT_NO_CALLBACK

static final int EVENT_NO_CALLBACK

Return value of SxsGetInoMsgNo to indicate an illegal callback attempt in an event function.

See Also:

Constant Field Values

Method Detail

SxsException

void SxsException(int errnr,
                  java.lang.String msg)

Tells the Tamino server that an exception happened in a Java extension.

extensions should call this method instead of throwing Java exceptions to tell the Tamino server that something went wrong. The current transaction will be aborted by this method.

Parameters:

errnr - an error number for this exception

msg - the error message

SxsWarning

void SxsWarning(int warnNum,
                java.lang.String msg)

Informs the Tamino server that a warning has occurred.

Parameters:

warnNum - warning number

msg - warning text

SxsXMLXql

int SxsXMLXql(java.lang.String collection,
              java.lang.String query,
              java.lang.StringBuffer response)

Performs an XQL query in the Tamino server via a callback.

Parameters:

collection - the collection for this query

query - the XQL query string

response - the response buffer in which the query result is written (should be initialized with the empty string)

Returns:

0 if the query succeeded or an error number otherwise

SxsXMLXQuery

int SxsXMLXQuery(java.lang.String collection,
                 java.lang.String query,
                 Result result)

Performs an XQuery in the Tamino server via a callback.

Parameters:

collection - the collection for this query

query - the XQuery string

result - the result object in which the query result is written

Returns:

0 if the query succeeded or an error number otherwise

SxsXMLXQuery

int SxsXMLXQuery(java.lang.String collection,
                 java.lang.String query,
                 Result result,
                 boolean hasResultElement)

Performs an XQuery in the Tamino server via a callback.

Parameters:

collection - the collection for this query

query - the XQuery string

result - the result object in which the query result is written

hasResultElement - is true wrap result with a result element

Returns:

0 if the query succeeded or an error number otherwise

SxsXMLXQuery

int SxsXMLXQuery(java.lang.String collection,
                 java.lang.String query,
                 java.util.Map values,
                 Result result)

Performs an XQuery in the Tamino server via a callback.

Parameters:

collection - the collection for this query

query - the XQuery string

values - Map of values (name/value pairs). The name should be of type String. The value should be of type String (parsed variable) or InputDocument (unparsed variable).

result - the result object in which the query result is written

Returns:

0 if the query succeeded or an error number otherwise

SxsXMLXQuery

int SxsXMLXQuery(java.lang.String collection,
                 java.lang.String query,
                 java.util.Map values,
                 Result result,
                 boolean hasResultElement)

Performs an XQuery in the Tamino server via a callback.

Parameters:

collection - the collection for this query

query - the XQuery string

values - Map of values (name/value pairs). The name should be of type String. The value should be of type String (parsed variable) or InputDocument (unparsed variable).

result - the result object in which the query result is written

hasResultElement - is true wrap result with a result element

Returns:

0 if the query succeeded or an error number otherwise

SxsGetNonXMLDocument

int SxsGetNonXMLDocument(java.lang.String collection,
                         java.lang.String doctype,
                         int inoid,
                         java.io.ByteArrayOutputStream nonXmlDoc)

Get a NonXML document from Tamino based on the ino:id.

Parameters:

collection - the collection for this query

doctype - the doctype where the document is in

inoid - the Tamino ino:id of the document

nonXmlDoc - the result buffer in which the Non XML document is written into

Returns:

0 if the query succeeded or an error number otherwise

SxsGetNonXMLDocument

int SxsGetNonXMLDocument(java.lang.String collection,
                         java.lang.String doctype,
                         java.lang.String documentId,
                         java.io.ByteArrayOutputStream nonXmlDoc)

Get a NonXML document from Tamino based on the docname/ino:id.

Parameters:

collection - the collection for this query

doctype - the doctype where the document is in

documentId - either "@" (without the <>) or the ino:docname

nonXmlDoc - the result buffer in which the Non XML document is written into

Returns:

0 if the query succeeded or an error number otherwise

SxsGetDocument

int SxsGetDocument(java.lang.String collection,
                   java.lang.String doctype,
                   int inoid,
                   Result result)

Get a XML/non-XML document from Tamino based on the ino:id.

Parameters:

collection - the collection for this query

doctype - the doctype where the document is in

inoid - the Tamino ino:id of the document

result - the result object in which the query result is written

Returns:

0 if the query succeeded or an error number otherwise

SxsGetDocument

int SxsGetDocument(java.lang.String collection,
                   java.lang.String doctype,
                   java.lang.String documentId,
                   Result result)

Get a XML/non-XML document from Tamino based on the docname/ino:id.

Parameters:

collection - the collection for this query

doctype - the doctype where the document is in

documentId - either "@" (without the <>) or the ino:docname

result - the result object in which the query result is written

Returns:

0 if the query succeeded or an error number otherwise

SxsXMLDefine

int SxsXMLDefine(java.lang.String xmlSchema,
                 java.lang.StringBuffer response)

Defines an XML schema in the Tamino server via callback.

Parameters:

xmlSchema - a string containing the schema

response - the result buffer in which the XML result document is written (should be initialized with the empty string)

Returns:

0 if the definition succeeded or an error number otherwise

SxsXMLDefine

int SxsXMLDefine(java.lang.String xmlSchema,
                 java.lang.String mode,
                 java.lang.StringBuffer response)

Defines an XML schema in the Tamino server via callback.

Parameters:

xmlSchema - a string containing the schema

mode - mode value to be used (for example "validate")

response - the result buffer in which the XML result document is written (should be initialized with the empty string)

Returns:

0 if the definition succeeded or an error number otherwise

SxsXMLUndefine

int SxsXMLUndefine(java.lang.String collection,
                   java.lang.String schema,
                   java.lang.String doctype,
                   java.lang.StringBuffer response)

Undefine a collection, schema or doctype in the Tamino server via callback.

Warning: When you delete a collection, schema or doctype, all documents and other data belonging to that collection, schema or doctype are also deleted!

Parameters:

collection - collection to undefine OR collection of schema/doctype

schema - schema to undefine OR schema of doctype. May be empty string.

doctype - doctype to undefine. May be empty string.

response - the result buffer in which the XML result document is written (should be initialized with the empty string)

Returns:

0 if the definition succeeded or an error number otherwise

SxsXMLProcess

int SxsXMLProcess(java.lang.String collection,
                  java.lang.String xmlDoc,
                  java.lang.StringBuffer response)

Inserts an XML document into the Tamino server via callback.

Parameters:

collection - the collection into which the document will be inserted

xmlDoc - the XML document to insert

response - the result buffer in which the XML result document is written (should be initialized with the empty string)

Returns:

0 if the insertion succeeded and an error number otherwise

SxsXMLProcess

int SxsXMLProcess(java.lang.String collection,
                  java.lang.String xmlDoc,
                  java.lang.StringBuffer response,
                  boolean hasResultElement)

Inserts an XML document into the Tamino server via callback.

Parameters:

collection - the collection into which the document will be inserted

xmlDoc - the XML document to insert

response - the result buffer in which the XML result document is written (should be initialized with the empty string)

hasResultElement - if true then wrap result with a result element

Returns:

0 if the insertion succeeded and an error number otherwise

SxsPutDocument

int SxsPutDocument(InputDocument document,
                   java.lang.StringBuffer response)

Inserts an XML/Non-XML document into the Tamino server via callback.

Parameters:

document - document to be inserted

response - the result buffer in which the XML result document is written (should be initialized with the empty string)

Returns:

0 if the insertion succeeded and an error number otherwise

SxsXMLDelete

int SxsXMLDelete(java.lang.String collection,
                 java.lang.String query,
                 java.lang.StringBuffer response)

Deletes an XML document from the Tamino server via callback.

Parameters:

collection - the collection from which the document will be removed

query - X-Query identifying document to delete

response - the result buffer in which the XML result document is written (should be initialized with the empty string)

Returns:

0 if the deletion succeeded or an error number otherwise

SxsXMLAdmin

int SxsXMLAdmin(java.lang.String command,
                java.lang.StringBuffer response)

Perform an admin command in the Tamino server via callback.

Parameters:

command - admin command to perform

response - the result buffer in which the XML result document is written (should be initialized with the empty string)

Returns:

0 if the definition succeeded or an error number otherwise

SxsXMLGetMessage

int SxsXMLGetMessage(java.lang.StringBuffer msgContent)

Gets the last message from the Tamino server via callback.

Parameters:

msgContent - the buffer in which the message is written (should be initialized with the empty string)

Returns:

0 if the callback succeeded or an error number otherwise

SxsSystem

int SxsSystem(int callType,
              java.lang.StringBuffer property)

Get a system property from the Tamino server via callback.

Parameters:

callType - specifies the system property to be retrieved (SERVERURL, USERID, PASSWORD, USERURL, SESSIONID or SCHEMA_NODE_INFO)

property - the result buffer in which the XML result document is written (should be initialized with the empty string)

Returns:

0 if the callback succeeded or an error number otherwise

SxsSetProperty

int SxsSetProperty(int property,
                   java.lang.String value)

Set a property via callback.

Parameters:

property - specifies the property to be set (SX_PROPERTY_RSP_MEDIATYPE, ...)

value - the new value for the property

Returns:

0 if the callback succeeded or an error number otherwise

SxsGetProperty

int SxsGetProperty(int property,
                   java.lang.StringBuffer value)

Get a property via callback.

Parameters:

property - specifies the property to get (SX_PROPERTY_RSP_MEDIATYPE, ...)

value - the retrieved value of the property

Returns:

0 if the callback succeeded or an error number otherwise

SxsGetPasswordAuthentication

int SxsGetPasswordAuthentication(SxsPasswordAuthentication auth)

Get the UserId/Password for the current user as a Java PasswordAuthentication object

Parameters:

auth - the retrieved userid/password.

Returns:

0 if the callback succeeded or an error number otherwise

SxsRepairOperation

int SxsRepairOperation(java.lang.String op,
                       java.lang.String[] data,
                       java.lang.StringBuffer value)

Perform specified operation for OnStartup repairs.

Parameters:

op - operation to be performed

data - operation data

value - response of operation (maybe empty)

Returns:

0 if the callback succeeded or an error number otherwise

SxsGetHttpHeaderField

int SxsGetHttpHeaderField(java.lang.String attrName,
                          java.lang.StringBuffer value)

Get an attribute value of the HTTP header of the request

Parameters:

attrName - the name of the attribute to be retrieved

value - the result buffer in which the XML result document is written (should be initialized with the empty string)

Returns:

0 if the callback succeeded or an error number otherwise

SxsSQLGetConnect

int SxsSQLGetConnect(java.lang.String dbName,
                     java.lang.String userName,
                     java.lang.String password,
                     IntRef Handle)

Creates a connection to the OCDC interface of a Tamino server via callback.

Parameters:

dbName - a data source name defined in the ODBC manager

userName - a valid user account

password - the password will not appear in the trace

Handle - the address of the connection handle will be entered here (should be initialized with the default constructor)

Returns:

the return code of the ODBC call (a negative value indicates an error).

SxsSQLAllocHandle

int SxsSQLAllocHandle(short HandleType,
                      int InputHandle,
                      IntRef OutputHandle)

Creates an ODBC statement handle.

In Tamino extensions this method can only create statement handles.

Parameters:

HandleType - the type of the handle to be allocated (must be SQL_HANDLE_STMT)

InputHandle - a connection handle received from SxsSQLGetConnect

OutputHandle - the address of the statement handle will be entered here (should be initialized with the default constructor)

Returns:

the return code of the ODBC call (a negative value indicates an error).

SxsSQLFreeHandle

int SxsSQLFreeHandle(short HandleType,
                     int Handle)

Drops an ODBC statement handle via callback.

Parameters:

HandleType - the type of the Handle (must be SQL_HANDLE_STMT)

Handle - the handle to be freed

Returns:

the return code of the ODBC call (a negative value indicates an error).

SxsSQLPrepare

int SxsSQLPrepare(int StatementHandle,
                  java.lang.String StatementText)

Prepares an SQL statement via ODBC callback.

Parameters:

StatementHandle - the handle received from SxsSQLAllocHandle

StatementText - the SQL statement to prepare

Returns:

the return code of the ODBC call (a negative value indicates an error).

SxsSQLBindParameter

int SxsSQLBindParameter(int StatementHandle,
                        short ParameterNumber,
                        short InputOutputType,
                        short ValueType,
                        short ParameterType,
                        int ColumnSize,
                        short DecimalDigits,
                        byte[] ParameterValuePtr,
                        int BufferLength,
                        IntRef StrLen_or_IndPtr)

Binds a buffer to an input parameter of an SQL statement.

Before executing the statement the parameter values must be written into the buffers bound with this method. The length of string parameters or the null value indicator must be set in StrLen_or_IndPtr.

Parameters:

StatementHandle - a handle received from SxsSQLAllocHandle

ParameterNumber - the number of the parameter within the statement (counting starts with 1)

InputOutputType - one of the types defined in SXJBase

ValueType - the C data type of the parameter

ParameterType - the SQL data type of the parameter

ColumnSize - the size of the column of the corresponding parameter

DecimalDigits - the decimal digits of the column of the corresponding parameter

ParameterValuePtr - a buffer for the parameter value (should be allocated with the length given in BufferLength)

BufferLength - the length of the ParameterValuePtr buffer in bytes

StrLen_or_IndPtr - null value indicator or value length for character or binary data

Returns:

the return code of the ODBC call (a negative value indicates an error).

SxsSQLGetData

int SxsSQLGetData(int StatementHandle,
                  short ColumnNumber,
                  short TargetType,
                  byte[] TargetValue,
                  int BufferLength,
                  IntRef StrLen_or_IndPtr)

Writes the value of a result column into a buffer.

Parameters:

StatementHandle - a handle received from SxsSQLAllocHandle

ColumnNumber - the number of the column within the result table (counting starts with 1)

TargetType - the C data type of the TargetValue

TargetValue - a buffer in which to return the column value (should be allocated with the length given in BufferLength)

BufferLength - the length of the TargetValue buffer in bytes

StrLen_or_IndPtr - null value indicator or value length for character or binary data

Returns:

the return code of the ODBC call (a negative value indicates an error).

SxsSQLBindCol

int SxsSQLBindCol(int StatementHandle,
                  short ColumnNumber,
                  short TargetType,
                  byte[] TargetValue,
                  int BufferLength,
                  IntRef StrLen_or_IndPtr)

Binds a buffer to a result column of an SQL query.

When executing SxsSQLFetch all buffers bound to columns are filled with the values of the corresponding columns.

Parameters:

StatementHandle - a handle received from SxsSQLAllocHandle

ColumnNumber - the number of the column within the result table (counting starts with 1)

TargetType - the C data type of the TargetValue

TargetValue - a buffer to bind to the column (should be allocated with the length given in BufferLength)

BufferLength - the length of the TargetValue buffer in bytes

StrLen_or_IndPtr - null value indicator or value length for character or binary data

Returns:

the return code of the ODBC call (a negative value indicates an error).

SxsSQLGetDiagField

int SxsSQLGetDiagField(short HandleType,
                       int Handle,
                       short RecNumber,
                       short DiagIdentifier,
                       byte[] DiagInfoPtr,
                       short BufferLength,
                       IntRef StringLengthPtr)

Returns the current value of a field of a record of the diagnostic data structure for a handle.

Parameters:

HandleType - the type of the Handle (must be SQL_HANDLE_STMT

Handle - the handle for which diagnostics are requested

RecNumber - indicates the status record from which diagnostics are requested

DiagIdentifier - indicates the field of the diagnostic whose value is requested

DiagInfoPtr - a buffer in which to return the diagnostic information (should be allocated with the length given in BufferLength)

BufferLength - the length of the DiagInfoPtr buffer in bytes

StringLengthPtr - total number of bytes available in DiagInfoPtr

Returns:

the return code of the ODBC call (a negative value indicates an error).

SxsSQLExecute

int SxsSQLExecute(int StatementHandle)

Executes an SQL statement via ODBC callback.

Parameters:

StatementHandle - the handle received from SxsSQLAllocHandle

Returns:

the return code of the ODBC call (a negative value indicates an error).

SxsSQLFetch

int SxsSQLFetch(int StatementHandle)

Fetches the next result row of an SQL statement via ODBC callback.

After fetching the row its values can be retrieved using SxsSQLGetData or can be read in the buffers bound with SxsSQLBindCol.

Parameters:

StatementHandle - the handle received from SxsSQLAllocHandle

Returns:

the return code of the ODBC call (a negative value indicates an error).

SxsSQLCloseCursor

int SxsSQLCloseCursor(int StatementHandle)

Closes the cursor of an SQL query via ODBC callback.

Parameters:

StatementHandle - the handle received from SxsSQLAllocHandle

Returns:

the return code of the ODBC call (a negative value indicates an error).

SxsTrace

int SxsTrace(java.lang.String packet)

Writes a message into the extension trace via callback.

Parameters:

packet - the trace message

Returns:

0 if the callback succeeded or an error number otherwise

SXSTrace

int SXSTrace(java.lang.String packet)

Writes a message into the extension trace via callback (spelling like in COM).

Parameters:

packet - the trace message

Returns:

0 if the callback succeeded or an error number otherwise

pt_decl

int pt_decl(char[] pszName,
            int errlev)

Callback method for server trace.

pt_s

int pt_s(char[] var,
         char[] val)

Callback method for server trace.

pt_ws

int pt_ws(char[] var,
          char[] val)

Callback method for server trace.

pt_i

int pt_i(char[] var,
         int val)

Callback method for server trace.

pt_c

int pt_c(char[] var,
         char val)

Callback method for server trace.

pt_text

int pt_text(char[] text)

Callback method for server trace.

pt_leave

int pt_leave()

Callback method for server trace.

SxsGetMsgNo

int SxsGetMsgNo()

Gets the error number if a callback method failed.

Returns:

the callback error number (0 if no error occurred)

SxsGetInoMsgNo

int SxsGetInoMsgNo()

Gets the error number if an XML request via callback failed.

Returns:

the XML error number (0 if no XML error occurred)

SxsGetSQLMsgNo

int SxsGetSQLMsgNo()

Gets the error number an SQL query via ODBC callback failed.

Returns:

the SQL error number (0 if no SQL error occurred)

SxsGetMsgText

java.lang.String SxsGetMsgText()

Gets the error message if a callback method failed.

Returns:

the callback error message

SxsGetStackTrace

java.lang.String SxsGetStackTrace()

Gets the stack trace of a call.

Returns:

the stack trace