Package com.progress.open4gl.javaproxy

Class OpenAppObject

java.lang.Object

com.progress.open4gl.javaproxy.OpenAppObject

All Implemented Interfaces:

SDOFactory

public class OpenAppObject
extends Object
implements SDOFactory

OpenAppObjectImpl is the primary class for interacting with procedures deployed to an application server using the Java Open Client API.

Field Summary

Fields

Modifier and Type	Field	Description
protected com.progress.open4gl.javaproxy.OpenAppObjectImpl	m_dynAOImpl
protected static final long	m_wrongProxyVer

Constructor Summary

Constructors

Constructor	Description
OpenAppObject(Connection connection, String appService)	Establishes a connection to an AppServer using the Java OpenAPI
OpenAppObject(Connection connection, String appService, com.progress.common.ehnlog.IAppLogger log)	Establishes a connection to an AppServer using the Java OpenAPI
OpenAppObject(String appService)	Deprecated. use an OpenAppObject constructor that accepts a URL or a Connection
OpenAppObject(String userId, String password, String appServerInfo, String appService)	Deprecated. use an OpenAppObject constructor that accepts a URL or a Connection
OpenAppObject(String urlString, String userId, String password, String appServerInfo, String appService)	Establishes a connection to an AppServer using the Java OpenAPI

Method Summary

Modifier and Type	Method	Description
void	_cancelAllRequests()	Stops or cancels any outstanding requests to the AppServer by this object or one that shares its connection.
SDOInterface	_createSDOProcObject(String procName)	Creates a ProcObject that knows how to talk to SDO's.
SDOResultSet	_createSDOResultSet(String sdoName)	Creates an SDO ResultSet object.
SDOResultSet	_createSDOResultSet(String sdoName, String whereClause, String sortBy)	Creates an SDO ResultSet object.
SDOResultSet	_createSDOResultSet(String sdoName, String whereClause, String sortBy, SDOParameters params)	Creates an SDO ResultSet object.
Object	_getConnectionId()	Returns a string containing a unique identifier for this connection.
String	_getProcReturnString()	Returns the current value of the AppServer RETURN-VALUE function.
Object	_getRequestId()	Returns a unique string identifying the request most recently run.
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.
OpenClassObject	createCO(String objTypeName)	Creates and instantiate a class object on the connected AppServer.
OpenClassObject	createCO(String objTypeName, int statelessMode)	Creates and instantiate a class object on the connected AppServer.
OpenProcObject	createPO(String procName)	Creates and runs a persistent procedure on the connected AppServer.
OpenProcObject	createPO(String procName, int statelessMode)	Creates and runs a persistent procedure on the connected AppServer.
OpenProcObject	createPO(String procName, ParamArray paramArray)	Creates and runs a persistent procedure on the connected AppServer.
OpenProcObject	createPO(String procName, ProcedureType procType)
boolean	isConnected()	For supported server connections, this method checks that the server can successfully serve requests.
void	runProc(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 Details

m_wrongProxyVer

protected static final long m_wrongProxyVer

See Also:

• Constant Field Values

m_dynAOImpl

protected com.progress.open4gl.javaproxy.OpenAppObjectImpl m_dynAOImpl

Constructor Details

OpenAppObject

public OpenAppObject(Connection connection,
 String appService)
              throws Open4GLException,
ConnectException,
SystemErrorException,
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

IOException

OpenAppObject

public OpenAppObject(Connection connection,
 String appService,
 com.progress.common.ehnlog.IAppLogger log)
              throws Open4GLException,
ConnectException,
SystemErrorException,
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

IOException

OpenAppObject

public OpenAppObject(String urlString,
 String userId,
 String password,
 String appServerInfo,
 String appService)
              throws Open4GLException,
ConnectException,
SystemErrorException,
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

IOException

OpenAppObject

@Deprecated
public OpenAppObject(String userId,
 String password,
 String appServerInfo,
 String appService)
              throws Open4GLException,
ConnectException,
SystemErrorException,
IOException

Deprecated.

use an OpenAppObject constructor that accepts a URL or a Connection

Establishes a connection to an AppServer using the Java OpenAPI. The url string defaults to http://localhost:8810/apsv/.

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

IOException

OpenAppObject

@Deprecated
public OpenAppObject(String appService)
              throws Open4GLException,
ConnectException,
SystemErrorException,
IOException

Deprecated.

use an OpenAppObject constructor that accepts a URL or a Connection

Establishes a connection to an AppServer using the Java OpenAPI. The url string defaults to http://localhost:8810/apsv/.

Parameters:

appService - name of the application service provided by the AppServer

Throws:

Open4GLException

ConnectException

SystemErrorException

IOException

Method Details

_release

public void _release()
              throws Open4GLException,
SystemErrorException

Makes this object unavailable for further use.

Throws:

Open4GLException

SystemErrorException

_getConnectionId

public Object _getConnectionId()
                        throws Open4GLException

Returns a string containing a unique identifier for this connection.

Throws:

Open4GLException

_getRequestId

public Object _getRequestId()
                     throws Open4GLException

Returns a unique string identifying the request most recently run.

Throws:

Open4GLException

_getSSLSubjectName

public 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

_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

_getProcReturnString

public String _getProcReturnString()
                            throws Open4GLException

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

Throws:

Open4GLException

_createSDOResultSet

public SDOResultSet _createSDOResultSet(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(String sdoName,
 String whereClause,
 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(String sdoName,
 String whereClause,
 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

_createSDOProcObject

public SDOInterface _createSDOProcObject(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

runProc

public void runProc(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

createPO

public OpenProcObject createPO(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

createPO

public OpenProcObject createPO(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(String procName,
 ProcedureType procType)
                        throws Open4GLException,
RunTime4GLException,
SystemErrorException

Throws:

Open4GLException

RunTime4GLException

SystemErrorException

createPO

public OpenProcObject createPO(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

createCO

public OpenClassObject createCO(String objTypeName,
 int statelessMode)
                         throws Open4GLException,
RunTime4GLException,
SystemErrorException

Creates and instantiate a class object on the connected AppServer.

Parameters:

objTypeName - class type name

statelessMode - Specifies stateless mode

Throws:

Open4GLException

RunTime4GLException

SystemErrorException

createCO

public OpenClassObject createCO(String objTypeName)
                         throws Open4GLException,
RunTime4GLException,
SystemErrorException

Creates and instantiate a class object on the connected AppServer.

Parameters:

objTypeName - class type name

Throws:

Open4GLException

RunTime4GLException

SystemErrorException

isConnected

public boolean isConnected()

For supported server connections, this method checks that the server can successfully serve requests.

Returns:

true if connection is valid, false otherwise