Skip to main contentSkip to search
Powered by Zoomin Software. For more details please contactZoomin
Progress DocumentationProgress Documentation
Progress Documentation
  • Home
  • Home
  • EnglishČeštinaDeutsch (Germany)Español (Spain)Français (France)Italiano (Italy)Português (Brasil)日本語Русский (Russia)中文 (简体) (China)中文 (繁體, 台灣) (Taiwan)ar-AR
  • Login

Java Open Clients

Sample Java OpenAPI code

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
Table of Contents
  • Configure and Deploy Java Open Client Applications
    • Java Open Client Runtime package
    • Prepare to generate proxies for a Java client in Windows using ProxyGen or Batch ProxyGen
    • Prepare to generate proxies for a Java client on UNIX using Batch ProxyGen
    • Build an Open Client application that uses a Java proxy
    • Deploy an Open Client application that uses a Java proxy
  • Proxy Objects and Methods
    • Introduction
    • Proxy objects
      • Package
    • Proxy methods
      • Connection methods
      • Remote ABL methods
        • Pass parameters
        • Handle return values
      • Class factory methods
        • SubAppObject
        • ProcObject
        • SDOResultSet
      • Common methods
        • Cancel all requests
        • Connection ID
        • Stream
        • Procedure return string
        • Release
        • Request ID
        • TLS subject name
        • Procedure type
    • Run methods on session-free AppObjects
      • Session-free threading model
      • Share of the connection pool between session-free AppObjects
    • Sample proxy
      • Sample AppObject
      • Sample SubAppObject
      • Sample ProcObject
  • Connect to an application server
    • Connection class
    • Client principal class
      • Attributes of the ClientPrincipal class
      • Methods of the ClientPrincipal class
    • Establish the connection
      • Return a user defined string to the client from the application server connection procedure
      • Supported application server modes
      • Release a session-free Connection object
    • Connection states
  • Pass Parameters
    • ABL data type mappings
      • INPUT parameters
      • Date and time conversions
      • Arrays as parameters
        • Unknown value (?) as a parameter
        • Arrays and Unknown value (?)
      • INPUT-OUTPUT and OUTPUT parameters
        • Holder classes
        • Holder class definitions
    • Pass temp-tables and ProDataSets
      • Static and dynamic temp-tables and ProDataSets
      • ABL mechanisms for passing temp-tables and ProDataSets
      • Java mechanisms for passing temp-tables and ProDataSets
        • ProDataGraph mechanism
        • SQL ResultSets mechanism
        • Choose the parameter passing mechanism
      • Map temp-table field data types and meta data
        • Java data type mappings for temp-table fields
        • Meta data for specifying the ABL data types of temp-table fields
  • Access ABL ProDataSets
    • Introduce ABL ProDataSets
    • ProDataSets and using ProDataGraphs to access them
      • ProDataSet structure and usage
        • Abstract data sources
        • Track changes
      • ProDataGraph function and foundations
        • Java SDO Foundations
        • Java SDO extensions
      • ProDataGraph object model
    • Prepare and pass ProDataSets as ProDataGraph parameters
      • Prepare and manage a ProDataGraph parameter
        • Parameter passing modes
        • ProDataGraphHolder class
      • Manage ProDataObject mappings to temp-tables
        • Map single-valued fields
        • Map array fields
        • Map the Unknown value (?)
        • Specify initial values
      • Pass a ProDataGraph as OUTPUT
        • Access a ProDataGraph with a known schema
        • Access the ProDataGraph meta data for an unknown schema
      • Pass a ProDataGraph as INPUT or INPUT-OUTPUT
        • Prepare an input ProDataGraph
        • Create and initialize a ProDataGraph object with meta data
        • Add data to a ProDataGraph
    • Update a ProDataSet
      • Typical cycle for ProDataSet updates
      • Manage a ProDataGraph through the update cycle
      • Check for errors
        • ProDataGraph level
        • Table level
        • Row level
      • Find a row in a ProDataGraph
        • Find parent rows
        • Find child rows
      • Add a row to a ProDataGraph
      • Delete a row from a ProDataGraph
    • Pass temp-tables as ProDataGraph parameters
    • ProDataGraph class
      • Constructors
        • ProDataGraph created from meta data
        • ProDataGraph created from an initial DataGraph
      • Inherited methods
        • getChangeSummary( )
        • getRootObject( )
      • Extended methods
        • acceptChanges( )
        • addProDataObject( )
        • createProDataObject( )
        • getMetaData( )
        • getNumTables( )
        • getProChangeSummary( )
        • getProDataObjects( )
        • getProDataGraphName( )
        • getTableNames( )
        • hasError( )
        • setChildTableReferences( )
      • Related RunTimeProperties methods for ProDataGraph
    • ProDataObject class
      • Inherited methods
        • get( )
        • getBigDecimal( )
        • getBoolean( )
        • getBytes( )
        • getInt( )
        • getList( )
        • getLong( )
        • getString( )
        • getType( )
        • isSet( )
        • set( )
        • setBigDecimal( )
        • setBoolean( )
        • setBytes( )
        • setInt( )
        • setList( )
        • setLong( )
        • setString( )
      • Extended methods
        • getChildRows( )
        • getFieldCount( )
        • getGregorianCalendar( )
        • getParentRow( )
        • getRowErrorString( )
        • getTableErrorString( )
        • getTableName( )
        • hasRowError( )
        • hasTableError( )
        • setGregorianCalendar( )
    • ProChangeSummary class
      • Inherited methods
        • beginLogging( )
        • endLogging( )
        • getChangedDataObjects( )
        • getOldValues( )
        • isCreated( )
        • isDeleted( )
      • Extended method
        • getChanges( )
    • ProDataGraphMetaData class
      • Constructor
      • Methods
        • addDataRelation( )
        • addTable( )
        • getNumRelations( )
        • getNumTables( )
        • getRelationMetaData( )
        • getTableMetaData( )
        • getTableNames( )
    • ProDataObjectMetaData class
      • Constructor
      • Methods
        • getBImageFlag( )
        • getExtent( )
        • getFieldCount( )
        • getFieldName( )
        • getNoSchemaMarshal( )
        • getProType( )
        • getTableName( )
        • getUserOrder( )
        • setFieldMetaData( )
        • setNoSchemaMarshal( )
    • ProDataRelationMetaData class
      • Constructors
        • Create a data-relation from parent and child ProDataObjectMetaData
        • Create a data-relation from selected parent and child key fields
      • Methods
        • getChildColumns( )
        • getChildTable( )
        • getParentColumns( )
        • getParentTable( )
        • getRelationName( )
        • setColumns( )
    • Use Java SDO classes to access Property meta data
      • Type interface
        • Methods
      • Property interface
        • Methods
  • Extend Proxy Objects
    • Example of extending proxy objects
  • Access Proxy Properties
    • Introduce proxy properties
    • Set properties on the command line
    • RunTimeProperties and Connection classes
      • RunTimeProperties class
      • Connection class
    • Access properties with methods
      • General property accessor methods for the RunTimeProperties class
        • Get property methods syntax
        • Set property methods syntax
      • General property accessor methods for Connection objects
        • Get property methods
        • Set property methods
      • Available properties
      • Access properties using purposed accessor methods
        • Session methods
        • Thread control methods
        • Proxy server specification methods
        • Transport Layer Security management methods
        • Trace methods (RunTimeProperties only)
        • Compression methods
    • Relationship between the RunTimeProperties class and the Connection class
    • Modify an instantiated Connection object's properties
    • Alphabetical list of properties
      • PROGRESS.Session.AppServerKeepalive
      • PROGRESS.Session.CertificateStore
      • PROGRESS.Session.cleanIdleAvailableSessions
      • PROGRESS.Session.ClientContextID
      • PROGRESS.Session.clientPrincipal
      • PROGRESS.Session.EnableCompression
      • PROGRESS.Session.CompressionLevel
      • PROGRESS.Session.CompressionThreshold
      • PROGRESS.Session.connectionLifetime
      • PROGRESS.Session.connectionTimeout
      • PROGRESS.Session.DatasetNullInitials
      • PROGRESS.Session.enableTracing
      • PROGRESS.Session.idleConnectionTimeout
      • PROGRESS.Session.initialConnections
      • PROGRESS.Session.LogFileName
      • PROGRESS.Session.loggingLevel
      • PROGRESS.Session.LogEntryTypes
      • PROGRESS.Session.maxConnections
      • PROGRESS.Session.minConnections
      • PROGRESS.Session.noHostVerify
      • PROGRESS.Session.noSslSessionReuse
      • PROGRESS.Session.nsClientMaxPort
      • PROGRESS.Session.nsClientMinPort
      • PROGRESS.Session.nsClientPicklistExpiration
      • PROGRESS.Session.nsClientPicklistSize
      • PROGRESS.Session.nsClientPortRetry
      • PROGRESS.Session.nsClientPortRetryInterval
      • PROGRESS.Session.PostponeRelationInfo
      • PROGRESS.Session.proxyHost
      • PROGRESS.Session.proxyPassword
      • PROGRESS.Session.proxyPort
      • PROGRESS.Session.proxyUserId
      • PROGRESS.Session.requestWaitTimeout
      • PROGRESS.Session.sessionModel
      • PROGRESS.Session.waitIfBusy
  • Handle Errors
    • Exceptions
    • General ABL exceptions
      • Exception class hierarchy
      • Exception descriptions
    • Output ResultSet exceptions
  • Use SmartDataObjects from Java Clients
    • What is a SmartDataObject?
    • Access remote SmartDataObjects from Java
      • Requirements for accessing SmartDataObjects
      • Example Java access to a SmartDataObject
    • SmartDataObject access tools and documentation
      • Objects required to access SmartDataObjects
      • Develop and deploy a SmartDataObject-aware application
        • Extend a SmartDataObject
      • Write a SmartDataObject-aware Java client
    • Connect to an application server using an SDOAppObject
    • Create an SDOResultSet object
      • The _createSDOResultSet() method
      • Set and get values on the SDOParameters object
      • Understand SDOResultSet scrolling modes
      • Understand SDOResultSet stateless mode
    • Work with SDOResultSet objects
      • Detach SDOResultSet objects [extension]
      • Navigate SDOResultSet rows
      • Get SDOResultSet column values
      • Update SDOResultSet objects
        • Transactions and concurrency control
        • Update column values
        • Insert, delete, and update rows
        • Use extended transactions
        • Use batch mode [extension]
        • Visibility of updates
      • Miscellaneous management methods
        • Standard JDBC 2 management methods
        • SmartDataObject management methods [extension]
        • Note on SDOInterface method
      • Meta data methods
        • JDBC 2 meta data methods
        • Nonstandard meta data methods [extension]
    • Multi-threading
    • Errors and exceptions
      • SDOResultSet exceptions
      • Typical errors by method category
    • Choose JDBC ResultSets or SDOResultSets to access OpenEdge data
  • Use the Open Client Java OpenAPI to Directly Access an Application Server
    • Overview of Java OpenAPI classes and enumerations
    • Connect to an application server
    • Run procedures and user-defined functions
      • Return the validity of the server session on an OpenAppObject
      • Run a non-persistent procedure on an OpenAppObject
      • Run a persistent procedure (OpenProcObject) on an OpenAppObject
      • Run a single-run or singleton procedure (OpenProcObject) on an OpenAppObject
      • Run an internal procedure or user-defined function on an OpenProcObject
    • Set up parameters
      • Create variables for parameters
      • Create a parameter array
      • Set the input and output error reset policy for the parameter array
      • Add parameters using data type-specific methods
        • General syntax for add parameter methods
        • Syntax summaries of all data type-specific add parameter methods
        • CHARACTER
        • COM-HANDLE
        • DATASET and DATASET-HANDLE
        • DATE
        • DATETIME
        • DATETIME-TZ
        • DECIMAL
        • HANDLE
        • INT64
        • INTEGER
        • LOGICAL
        • LONGCHAR
        • MEMPTR
        • RAW
        • RECID
        • ROWID
        • TABLE and TABLE-HANDLE
      • Add parameters using a generic method
      • Define the return type for a user-defined function
      • Arrays as return values
        • setIsReturnExtent( ) method
        • Handle unknown values in arrays.
        • setIsReturnUnknown( ) method
      • Define the schema for a temp-table parameter mapped to a java.sql.ResultSet
        • Define a ProResultSetMetaDataImpl object
        • Add field descriptions to the ProResultSetMetaDataImpl object
        • Add the ProResultSetMetaDataImpl object as a temp-table parameter
      • Define the schema for a ProDataSet parameter
        • Define a ProDataGraphMetaData object
        • Define the temp-tables for the ProDataGraphMetaData object
        • Define the data-relations for the ProDataGraphMetaData object
        • Define a ProDataGraph for any input parameter
        • Specify the ProDataGraphMetaData object for a ProDataSet parameter
      • Define the schema for temp-tables in a ProDataSet
        • Define a ProDataObjectMetaData object
        • Add field descriptions to the ProDataObjectMetaData object
        • Add the ProDataObjectMetaData object to the ProDataGraphMetaData
      • Define the schema for a temp-table parameter mapped to a ProDataGraph
    • Pass parameters
      • Pass INPUT parameters
      • Pass INPUT-OUTPUT parameters
      • Pass OUTPUT parameters
    • Handle returned values
      • Get OUTPUT parameter values
      • Access RETURN-VALUE function output from procedures
      • Access user-defined function return values
    • Sample Java OpenAPI code
      • Non-persistent procedure example
      • Persistent procedure example
      • Single-run/singleton procedure example
      • Pass DATASET and TABLE parameters example
      • Pass DATASET-HANDLE and TABLE-HANDLE parameters example
  • Access a SmartDataObject API Directly
    • Introduction
    • Directly access the SmartDataObject API in a proxy
    • Define a ProcObject that maps a SmartDataObject
  • Secure server connections to Java Open Clients
    • Manage certificate store files
    • Convert digital certificates
  • Pass Temp-tables as SQL ResultSet Parameters
    • Introduction
    • Prepare and manage temp-table parameters
      • Data type mapping for temp-table fields
      • Access temp-table array fields
        • Use the flat model
        • Use the array model
    • SQL ResultSet streaming and call-back sequence
      • INPUT ResultSet objects
      • OUTPUT ResultSet objects
        • Order of access for OUTPUT ResultSet objects
        • Close OUTPUT ResultSet objects
      • Result set schemas
    • Pass a TABLE or TABLE-HANDLE as an INPUT parameter
      • Instantiate the INPUT parameter
      • Use com.progress.open4gl.InputResultSet
      • Provide metadata for INPUT TABLE-HANDLE parameters
        • ProResultSetMetaDataImpl class
    • Pass a TABLE or TABLE-HANDLE as an OUTPUT parameter
      • Access TABLE or TABLE-HANDLE parameters as OUTPUT
        • Standard methods in the ProResultSet interface
        • ProResultSet interface extensions to java.sql.ResultSet
      • Temp-table field data type conversion
      • Get meta data for OUTPUT TABLE and TABLE-HANDLE parameters
        • Standard methods in the ProResultSetMetaData class
        • ProResultSetMetaData class extension to java.sql.ResultSetMetaData
    • Pass a TABLE or TABLE-HANDLE as an INPUT-OUTPUT parameter
    • Example Java client passing an SQL ResultSet parameter
Table of Contents

Sample Java OpenAPI code

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
  • Last Updated: June 9, 2025
  • 1 minute read
    • OpenEdge
    • Version 12.8
    • Documentation

Sample Java OpenAPI code

The following sections demonstrate example code for various scenarios.

Contents
  • Non-persistent procedure example
  • Persistent procedure example
  • Single-run/singleton procedure example
  • Pass DATASET and TABLE parameters example
  • Pass DATASET-HANDLE and TABLE-HANDLE parameters example
TitleResults for “How to create a CRG?”Also Available inAlert