Skip Headers
Oracle® Fusion Middleware Administrator's Guide for Oracle Application Development Framework
11g Release 1 (11.1.1.5.0)

Part Number E15470-07
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

4 WLST Command Reference for ADF Applications

This chapter describes the WLST commands you can use to deploy, manage, and configure Oracle ADF applications.

For wsadmin commands reference for the IBM WebSphere application server, see Appendix B, "wsadmin Command Reference for ADF Applications."

This chapter includes the following sections:

4.1 Overview of Custom WSLT Commands for Oracle ADF

Use the ADF-based URL Connections WLST commands to navigate the hierarchy of configuration or runtime beans and control the prompt display. Use the getADFMArchiveConfig commands to manage the ADFMArchiveConfig object.

To use the custom WLST commands for Oracle ADF, you must invoke the WLST script from the Oracle Common home. For more information about other WLST commands, such as custom Metadata Services (MDS) commands, see the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

4.2 ADF-Specific WLST Commands

Use the commands in Table 4-1 for ADF applications.

Table 4-1 Browse Commands for WLST Configuration

Use this command... To... Use with WLST...

adf_createFileUrlConnection

Create a new ADF file connection.

Online or Offline

adf_createHttpUrlConnection

Create a new ADF URL connection.

Online or Offline

adf_setURLConnectionAttributes

Set or edit the attributes of a newly created or existing ADF connection.

Online or Offline

adf_listUrlConnection

List a new URL connection.

Online or Offline

getADFMArchiveConfig

Returns a handle to the ADFMArchiveConfig object for the specified archive.

Online or Offline


4.2.1 adf_createFileUrlConnection

Use with WLST: Online or Offline.

4.2.1.1 Description

Use this command to creates a new connection based on the oracle.adf.model.connection.url.FileURLConnection connection class.

4.2.1.2 Syntax

adf_createFileURLConnection(appName, name, URL)
Argument Definition
appName
Application name for which the connection will be created.
name
The name of the new connection.
URL
The URL associated with this connection.

4.2.1.3 Example

adf_createFileURLConnection('myapp','tempDir','/scratch/tmp')

4.2.2 adf_createHttpUrlConnection

Use with WLST: Online or Offline.

4.2.2.1 Description

Use this command to create a new connection based on the oracle.adf.model.connection.url.HttpURLConnection connection type class.

4.2.2.2 Syntax

adf_createHttpURLConnection (appName, name, [URL], [authenticationType], [realm], [user], [password])
Argument Definition
appName
Application name for which the connection will be created.
name
The name of the new connection.
url
(Optional) The URL associated with this connection.
authenticationType (Optional) The default is basic.
realm (Optional) If this connection deals with authentication, then this should be set. The default is basic.
user (Optional)
password (Optional)

4.2.2.3 Example

adf_createHttpURLConnection('myapp','cnn','http://www.cnn.com') 

4.2.3 adf_setURLConnectionAttributes

Use with WLST: Online or Offline.

4.2.3.1 Description

Use this command to set or edit the attributes of a newly created or existing ADF connection.

4.2.3.2 Syntax

adf_setURLConnectionAttributes(appname, connectionname, attributes)
Argument Definition
appname
Application name.
connectionname
The name of the connection.
attributes
The array containing attributes to set in key/value pairs.

4.2.3.3 Example

adf_setURLConnectionAttributes ('myapp','cnn','ChallengeAuthenticationType:digest',
'AuthenticationRealm:XMLRealm'

4.2.4 adf_listUrlConnection

Use with WLST: Online or Offline.

4.2.4.1 Description

Use this command to list the connections of the application.

4.2.4.2 Syntax

adf_listURLConnection(appname)
Argument Definition
appname
Application name.

4.2.4.3 Example

adf_listURLConnection ('myapp')

4.2.5 getADFMArchiveConfig

Use with WLST: Online or Offline.

4.2.5.1 Description

Returns a handle to the ADFMArchiveConfig object for the specified archive. The returned ADFMArchiveConfig object's methods can be used to change application configuration in an archive.

The ADFMArchiveConfig object provides the following methods:

  • setDatabaseJboSQLBuilder([value]) - Sets the Database jbo.SQLBuilder attribute.

  • getDatabaseJboSQLBuilder() - Returns the current value of the jbo.SQLBuilder attribute.

  • setDatabaseJboSQLBuilderClass([value]) - Sets the Database jbo.SQLBuilderClass attribute. Value is the full name of the custom builder class.

  • getDatabaseJboSQLBuilderClass() - Returns the current value of the jbo.SQLBuilderClass attribute.

  • setDefaultRowLimit([value]) - Sets the defaults rowLimit attribute. Value is a long specifying the row limit (Default -1).

  • getDefaultRowLimit() - Returns the current value of the rowLimit attribute.

  • save([toLocation]) - If you specify the toLocation, then the changes will be stored in the target archive file and the original file will remain unchanged. Otherwise, the changes will be saved in the original file itself.

4.2.5.2 Syntax

archiveConfigObject = ADFMAdmin.getADFMArchiveConfig(fromLocation)
Argument Definition
fromLocation 
The name of the ear file, including its complete path.

The syntax for setDatabaseJboSQLBuilder([value]) is:

archiveConfigObject.setDatabaseJboSQLBuilder([value])
Argument Definition
value 
The value of the jbo.SQLBuilder attribute. Valid values are: 'Oracle' (Default), 'OLite', 'DB2', 'SQL92', 'SQLServer', or 'Custom. If 'Custom' is specified, then the jbo.SQLBuilderClass attribute should also be set.

The syntax for getDatabaseJboSQLBuilder() is:

archiveConfigObject.getDatabaseJboSQLBuilder()

The syntax for setDatabaseJboSQLBuilderClass([value]) is:

archiveConfigObject.setDatabaseJboSQLBuilderClass([value])
Argument Definition
value 
The value of the jbo.SQLBuilderClass attribute.

The syntax for getDatabaseJboSQLBuilderClass) is:

archiveConfigObject.getDatabaseJboSQLBuilderClass()

The syntax for setDefaultRowLimit([value]) is:

archiveConfigObject.setDefaultRowLimit([value])
Argument Definition
value 
The value of the rowLimit attribute.

The syntax for getDefaultRowLimit() is:

archiveConfigObject.getDefaultRowLimit([value])

The syntax for save([toLocation]) is:

archiveConfigObject.save([toLocation])
Argument Definition
toLocation 
The file name along with the absolute path to store the changes.

4.2.5.3 Example

In the following example. the jbo.SQLBuilder attribute is set to 'DB2'.

wls:/offline> archive =
               ADFMAdmin.getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wls:/offline> archive.setDatabaseJboSQLBuilder(value='DB2') 
wls:/offline> archive.save() 

In the following example, the jbo.SQLBuilder attribute is removed so that application default is used.

wls:/offline> archive =
              ADFMAdmin.getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wls:/offline> archive.setDatabaseJboSQLBuilder()
wls:/offline> archive.save(toLocation='/tmp/targetArchive.ear')

In the following example, the jbo.SQLBuilder attribute is set to 'Custom', and the jbo.SQLBuilderClass attribute is set to the class 'com.example.CustomBuilder'.

wls:/offline> archive =
              ADFMAdmin.getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wls:/offline> archive.setDatabaseJboSQLBuilder('Custom') 
wls:/offline> archive.setDatabaseJboSQLBuilderClass('com.example.CustomBuilder') 
wls:/offline> archive.save(toLocation='/tmp/targetArchive.ear')

In the following example, the rowLimit attribute is set to 100.

wls:/offline> archive = getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wls:/offline> archive.setDefaultRowLimit(100)
wls:/offline> archive.save(toLocation='/tmp/targetArchive.ear')