Java Proxy (Classic Style) › Java Proxy (Classic Style) Interface › Common Properties and Methods

Common Properties and Methods

The following properties and methods are common to all Java (Classic Style) proxies:

• Clear-Clears all import and export attributes to their default values if one is specified in the model or otherwise to 0 for numeric, empty string for string attributes, and null for date, time, and timestamp attributes.
• For attributes in repeating groups, the Clear method sets the repeat count to the max occurrences. In addition to clearing attribute properties, the Clear method also clears the system properties commandReturned, exitStateReturned, and exitStateMsg.
• ClientID-Retrieves or sets the client user ID property (String data type) to be sent to the server where the procedure step executable code is installed. A client user ID is usually accompanied by a client user password that can be set with the clientPassword property. Security is not enabled until the security user exit is modified to enable it.
• ClientPassword-Retrieves or sets the client user password property (String data type), which is sent to the server where the procedure step executable code is installed. A client user password is usually accompanied by a client user id, which can be set with the ClientId property.
• ComCfg-Set this value to the string value associated with the desired communications configuration. The string should take the form similar to the configuration string described in the commcfg.properties file, with the exception that it should not contain the trancode parameter. For example, for a TCP/IP transport configuration a commcfg.properties specification might be:

  tranX TCP hostname portNumber
  

  The corresponding ComCfg string would then be:

  TCP hostname portNumber
  

  Each supported transport has a slightly different communication string specification. In all cases the ComCfg string is expected to be the same as defined in the commcfg.properties file, but without the trancode parameter at the beginning. For more information, see the chapter “Overriding Communications Support at Execution Time” in the Distributed Processing - Overview Guide.

• CommandReturned-Retrieves the command returned property (read only String property), if any, after the server procedure step has been executed.
• CommandSent-Retrieves or sets the command sent property (String data type) to be sent to the server where the procedure step executable code is installed. This property should only be set if the procedure step uses case of command construct.
• Dialect-Sets or retrieves the dialect property (String property). It has the default value of DEFAULT.
• SAXParser-Optional. Retrieves or sets the classname of the SAXParser. This method can be used to override the default XML SAX parser used when performing XML parsing.
• Execute-This method executes the server operation as a synchronous cooperative flow.
• ExecuteXML-Optional. This method executes the server operation as a synchronous cooperative flow. However, unlike the normal execute method, it receives and returns its data as XML streams.
• ExecuteAsync-Optional. This method executes the send portion of an asynchronous cooperative flow. An ID is returned containing a unique identifier, which can be used later for retrieving the associated results. If no response is required, a parameter setting can indicate that no results are needed for this flow.
• ExecuteAsyncXML-Optional. This method executes the send portion of an asynchronous cooperative flow. However, unlike the normal executeAsync method, it receives its import data as an XML stream. All other parameters behave similarly to the executeAsync method.
• ExecuteAsyncGetResponse-Optional. This method executes the retrieve portion of an asynchronous cooperative flow. This method requires the ID of the associated request. It also lets you specify whether the method should block or wait if the results are not immediately available.
• In a non-blocking situation, the method returns before the results are processed. The result value indicates whether results are processed. If they are processed successfully, the export view area is populated with data, the transaction is considered complete, and the ID is no longer valid.
• ExecuteAsyncGetResponseXML-Optional. This method executes the receive portion of an asynchronous cooperative flow. However, unlike the normal executeAsyncGetResponse method, it returns its results as an XML stream. All other parameters behave similarly to the executeAsyncGetResponse method.
• CheckAsyncResponse-Optional. This method checks the status of an outstanding asynchronous request for a specific ID. The result value indicates whether the status is PENDING or AVAILABLE. There are generated constant values for each proxy that can be checked. This is the same as performing an ExecuteGetResponse in a non-blocking mode, but it usually executes many times faster due to less overhead.
• IgnoreAsyncResponse-Optional. This method indicates the runtime that the application is no longer interested in the outstanding request and the results may be discarded. All asynchronous programs should either finish a request by retrieving the results or calling this method. The runtime can save processing time and memory if it is aware that the results are no longer required.
• ExitStateMsg-Returns the current status text message (read only String property), if one exists. A status message is associated with a status code and can be returned by a CA Gen exit state.
• ExitStateReturned-Read only property (int data type) containing the exit state returned from the server.
• ExitStateSent-Retrieves or sets the exit state property (int data type) sent to server procedure step (typically, a 10-digit numeric representation of the exit states).
• ExitStateType-Read only property that returns the exitstatetype based upon the server procedure step exit state.
• FileEncoding-Specifies a specific Codepage that the CA Gen communications runtime uses when translating Unicode data prior to transmitting a flow request to the target server execution environment. By default, the file encoding for the Unicode data will be the system default for the JVM.
• NextLocation-Retrieves or sets the location name (NEXTLOC) property (String data type) that may be used by ODC user exits.
• ServerLocation-(Only Used by applet/Servlet Bean) Sets or returns the URL (URL data type) for the server hosting the servlet.

  Note: Java never lets an applet to connect to any arbitrary server. If the applet is running in a browser, it can only connect to the servlet running on the server from where the applet was downloaded. This property is useful for testing and running an applet outside the browser environment, or for using the bean as part of a Java application. This property must be set before calling the execute method.

  From an applet:

  object.setServerLocation(getDocumentBase());
  

  Or, for an application:

  try { object.setServerLocation (new URL ("http://hostname"));}
  catch ( malformedURL Exception e) { }
  

• Tracing-Setting this property to one, enables the JavaBean to write trace statements to the standard output (the Java console in a browser).