com.progress.open4gl.javaproxy
Class OpenAppObject

java.lang.Object
  com.progress.open4gl.javaproxy.OpenAppObject

All Implemented Interfaces:

SDOFactory

public class OpenAppObject
extends java.lang.Object
implements SDOFactory

For accessing external ABL procedures in an application service using the OpenAPI.

Field Summary

protected com.progress.open4gl.javaproxy.OpenAppObjectImpl	m_dynAOImpl
protected static long	m_wrongProxyVer

Constructor Summary

OpenAppObject(Connection connection, java.lang.String appService)
Establishes a connection to an AppServer using the Java OpenAPI

OpenAppObject(java.lang.String appService)
Establishes a connection to an AppServer using the Java OpenAPI.

OpenAppObject(java.lang.String userId, java.lang.String password, java.lang.String appServerInfo, java.lang.String appService)
Establishes a connection to an AppServer using the Java OpenAPI.

OpenAppObject(java.lang.String urlString, java.lang.String userId, java.lang.String password, java.lang.String appServerInfo, java.lang.String appService)
Establishes a connection to an AppServer using the Java OpenAPI

Method Summary

void	_cancelAllRequests() Stops or cancels any outstanding requests to the AppServer by this object or one that shares its connection.
SDOInterface	_createSDOProcObject(java.lang.String procName) Creates a ProcObject that knows how to talk to SDO's.
SDOResultSet	_createSDOResultSet(java.lang.String sdoName) Creates an SDO ResultSet object.
SDOResultSet	_createSDOResultSet(java.lang.String sdoName, java.lang.String whereClause, java.lang.String sortBy) Creates an SDO ResultSet object.
SDOResultSet	_createSDOResultSet(java.lang.String sdoName, java.lang.String whereClause, java.lang.String sortBy, SDOParameters params) Creates an SDO ResultSet object.
java.lang.Object	_getConnectionId() Returns a string containing a unique identifier for this connection.
java.lang.String	_getProcReturnString() Returns the current value of the AppServer RETURN-VALUE function.
java.lang.Object	_getRequestId() Returns a unique string identifying the request most recently run.
java.lang.Object	_getSSLSubjectName() Provides the SSL server's subject name that is obtained from its validated digital certificate.
boolean	_isStreaming() Returns true if currently streaming an output result set.
void	_release() Makes this object unavailable for further use.
OpenProcObject	createPO(java.lang.String procName) Creates and runs a persistent procedure on the connected AppServer.
OpenProcObject	createPO(java.lang.String procName, int statelessMode) Creates and runs a persistent procedure on the connected AppServer.
OpenProcObject	createPO(java.lang.String procName, ParamArray paramArray) Creates and runs a persistent procedure on the connected AppServer.
void	runProc(java.lang.String procName, ParamArray paramArray) Runs a non-persistent procedure on the connected AppServer.

Methods inherited from class java.lang.Object

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

Field Detail

m_dynAOImpl

protected com.progress.open4gl.javaproxy.OpenAppObjectImpl m_dynAOImpl

m_wrongProxyVer

protected static final long m_wrongProxyVer

See Also:

Constant Field Values

Constructor Detail

OpenAppObject

public OpenAppObject(Connection connection,
                     java.lang.String appService)
              throws Open4GLException,
                     ConnectException,
                     SystemErrorException,
                     java.io.IOException

Establishes a connection to an AppServer using the Java OpenAPI

Parameters:

connection - defines connection parameters to access the AppServer

appService - name of the application service provided by the AppServer

Throws:

Open4GLException

ConnectException

SystemErrorException

java.io.IOException

OpenAppObject

public OpenAppObject(java.lang.String appService)
              throws Open4GLException,
                     ConnectException,
                     SystemErrorException,
                     java.io.IOException

Establishes a connection to an AppServer using the Java OpenAPI. The url string defaults to AppServer://localhost:5162/appService.

Parameters:

appService - name of the application service provided by the AppServer

Throws:

Open4GLException

ConnectException

SystemErrorException

java.io.IOException

OpenAppObject

public OpenAppObject(java.lang.String userId,
                     java.lang.String password,
                     java.lang.String appServerInfo,
                     java.lang.String appService)
              throws Open4GLException,
                     ConnectException,
                     SystemErrorException,
                     java.io.IOException

Establishes a connection to an AppServer using the Java OpenAPI. The url string defaults to AppServer://localhost:5162/appService.

Parameters:

userId - user ID required to access the AppServer

password - password required to access the AppServer

appServerInfo - info required by the application service at connection time

appService - name of the application service provided by the AppServer

Throws:

Open4GLException

ConnectException

SystemErrorException

java.io.IOException

OpenAppObject

public OpenAppObject(java.lang.String urlString,
                     java.lang.String userId,
                     java.lang.String password,
                     java.lang.String appServerInfo,
                     java.lang.String appService)
              throws Open4GLException,
                     ConnectException,
                     SystemErrorException,
                     java.io.IOException

Establishes a connection to an AppServer using the Java OpenAPI

Parameters:

urlString - URL to connect to an Appserver URL

userId - user ID required to access the AppServer

password - password required to access the AppServer

appServerInfo - info required by the application service at connection time

appService - name of the application service provided by the AppServer

Throws:

Open4GLException

ConnectException

SystemErrorException

java.io.IOException

Method Detail

_cancelAllRequests

public void _cancelAllRequests()
                        throws Open4GLException

Stops or cancels any outstanding requests to the AppServer by this object or one that shares its connection.

Throws:

Open4GLException

_createSDOProcObject

public SDOInterface _createSDOProcObject(java.lang.String procName)
                                  throws Open4GLException

Creates a ProcObject that knows how to talk to SDO's.

Specified by:

_createSDOProcObject in interface SDOFactory

Parameters:

procName - Specifies the procedure name

Throws:

Open4GLException

_createSDOResultSet

public SDOResultSet _createSDOResultSet(java.lang.String sdoName)
                                 throws Open4GLException,
                                        ProSQLException

Creates an SDO ResultSet object.

Parameters:

sdoName - Specifies the filename of the SmartDataObject

Throws:

Open4GLException

ProSQLException

_createSDOResultSet

public SDOResultSet _createSDOResultSet(java.lang.String sdoName,
                                        java.lang.String whereClause,
                                        java.lang.String sortBy)
                                 throws Open4GLException,
                                        ProSQLException

Creates an SDO ResultSet object.

Parameters:

sdoName - Specifies the filename of the SmartDataObject

whereClause - Specifies where expression for query

sortBy - Specifies sort expression for query

Throws:

Open4GLException

ProSQLException

_createSDOResultSet

public SDOResultSet _createSDOResultSet(java.lang.String sdoName,
                                        java.lang.String whereClause,
                                        java.lang.String sortBy,
                                        SDOParameters params)
                                 throws Open4GLException,
                                        ProSQLException

Creates an SDO ResultSet object.

Parameters:

sdoName - Specifies the filename of the SmartDataObject

whereClause - Specifies where expression for query

sortBy - Specifies sort expression for query

params - Used for passing additional initial parameters such as scrolling mode.

Throws:

Open4GLException

ProSQLException

_getConnectionId

public java.lang.Object _getConnectionId()
                                  throws Open4GLException

Returns a string containing a unique identifier for this connection.

Throws:

Open4GLException

_getProcReturnString

public java.lang.String _getProcReturnString()
                                      throws Open4GLException

Returns the current value of the AppServer RETURN-VALUE function.

Throws:

Open4GLException

_getRequestId

public java.lang.Object _getRequestId()
                               throws Open4GLException

Returns a unique string identifying the request most recently run.

Throws:

Open4GLException

_getSSLSubjectName

public java.lang.Object _getSSLSubjectName()
                                    throws Open4GLException

Provides the SSL server's subject name that is obtained from its validated digital certificate.

Throws:

Open4GLException

_isStreaming

public boolean _isStreaming()
                     throws Open4GLException

Returns true if currently streaming an output result set.

Throws:

Open4GLException

_release

public void _release()
              throws Open4GLException,
                     SystemErrorException

Makes this object unavailable for further use.

Throws:

Open4GLException

SystemErrorException

createPO

public OpenProcObject createPO(java.lang.String procName)
                        throws Open4GLException,
                               RunTime4GLException,
                               SystemErrorException

Creates and runs a persistent procedure on the connected AppServer.

Parameters:

procName - Name of the procedure to run, including any path relative to the PROPATH

Throws:

Open4GLException

RunTime4GLException

SystemErrorException

createPO

public OpenProcObject createPO(java.lang.String procName,
                               int statelessMode)
                        throws Open4GLException,
                               RunTime4GLException,
                               SystemErrorException

Creates and runs a persistent procedure on the connected AppServer.

Parameters:

procName - Name of the procedure to run, including any path relative to the PROPATH

statelessMode - Specifies stateless mode

Throws:

Open4GLException

RunTime4GLException

SystemErrorException

createPO

public OpenProcObject createPO(java.lang.String procName,
                               ParamArray paramArray)
                        throws Open4GLException,
                               RunTime4GLException,
                               SystemErrorException

Creates and runs a persistent procedure on the connected AppServer.

Parameters:

procName - Name of the procedure to run, including any path relative to the PROPATH

paramArray - Holds the parameters for the procedure

Throws:

Open4GLException

RunTime4GLException

SystemErrorException

runProc

public void runProc(java.lang.String procName,
                    ParamArray paramArray)
             throws Open4GLException,
                    RunTime4GLException,
                    SystemErrorException

Runs a non-persistent procedure on the connected AppServer.

Parameters:

procName - Name of the procedure to run, including any path relative to the PROPATH

paramArray - Holds the parameters for the procedure

Throws:

Open4GLException

RunTime4GLException

SystemErrorException