This chapter describes the WLST commands you can use to deploy, manage, and configure Oracle ADF applications to Oracle WebLogic Server.
This chapter includes the following sections:
For wsadmin commands for the IBM WebSphere application server, see Appendix B, "wsadmin Command Reference for ADF Applications."
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.
Use the commands in Table 5-1 for ADF applications.
Table 5-1 Browse Commands for WLST Configuration
Use this command... | To... | Use with WLST... |
---|---|---|
Create a new ADF file connection. |
Online or Offline |
|
Create a new ADF URL connection. |
Online or Offline |
|
Set or edit the attributes of a newly created or existing ADF connection. |
Online or Offline |
|
List a new URL connection. |
Online or Offline |
|
Return a handle to the |
Online or Offline |
|
Export CSV format of jars versions from current |
Offline |
|
Export CSV format of jars versions of a specified application at a specified location. |
Online |
|
Export CSV format of jars versions from current |
Online |
Use with WLST: Online or Offline.
Use this command to creates a new connection based on the oracle.adf.model.connection.url.FileURLConnection
connection class.
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. |
Use with WLST: Online or Offline.
Use this command to create a new connection based on the oracle.adf.model.connection.url.HttpURLConnection
connection type
class.
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. |
|
(Optional) The default is basic. |
|
(Optional) If this connection deals with authentication, then this should be set. The default is basic. |
|
(Optional) |
|
(Optional) |
Use with WLST: Online or Offline.
Use this command to set or edit the attributes of a newly created or existing ADF connection.
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. |
Use with WLST: Online or Offline.
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.
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 |
The syntax for getDatabaseJboSQLBuilder()
is:
archiveConfigObject.getDatabaseJboSQLBuilder()
The syntax for setDatabaseJboSQLBuilderClass([value])
is:
archiveConfigObject.setDatabaseJboSQLBuilderClass([value])
Argument | Definition |
---|---|
value
|
The value of the |
The syntax for getDatabaseJboSQLBuilderClass)
is:
archiveConfigObject.getDatabaseJboSQLBuilderClass()
The syntax for setDefaultRowLimit([value])
is:
archiveConfigObject.setDefaultRowLimit([value])
Argument | Definition |
---|---|
value
|
The value of the |
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. |
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')
Use with WLST: Offline.
Use to export CSV format of jars versions from current ORACLE_HOME
at a specified location. Exported jars versions information can be opened in Oracle OpenOffice or MS Excel.
Use with WLST: Online.
Used to export CSV format of runtime jars versions of a specified application at a specified location.
exportApplicationJarVersions(applicationName, path)
Argument | Definition |
---|---|
applicationName |
Application name to export jars versions |
path |
Location to export jars versions. |
Use with WLST: Online.
Used to export CSV format of jars versions of selected jars at a specified location.
exportApplicationSelectedJarVersions(applicationName, path, jarsLocation)
Argument | Definition |
---|---|
applicationName |
Application name to export jars versions. |
path |
Location to extract jars versions. |
jarsLocation |
Optional list of selected jars. If not specified, default jars runtime version list from If the |
This example shows how jars versions are exported to /tmp/export-MyApp-Versions.csv
using the selectedJars
property of the Versions.xml
file. In this case, since the jarsLocation
parameter is not specified, the libraries listed in the selectedJars
property of the Versions.xml
file will be exported. R/W
privileges for the CSV file need to be verified.
wls:/offline>exportApplicationSelectedJarVersions('MyApp', '/tmp/export-MyApp-Versions.csv') Versions.xml <Diagnostics xmlns="xmlns.oracle.com/adf/diagnostics"> <Versions xmlns="xmlns.oracle.com/adf/diagnostics/versions" exportVersionsOnApplicationStartup="true" selectedJars="$ORACLE_HOME$/modules/oracle.adf.model_11.1.1/adfm.jar; $ORACLE_HOME$/modules/oracle.adf.view_11.1.1/adf-richclient-impl-11.jar; $ORACLE_HOME$/modules/oracle.adf.controller_11.1.1/adf-controller.jar; $ORACLE_HOME$/modules/oracle.adf.pageflow_11.1.1/adf-pageflow-impl.jar; $ORACLE_HOME$/modules/oracle.adf.share_11.1.1/adf-share-support.jar; $ORACLE_HOME$/modules/oracle.mds_11.1.1/mdsrt.jar" /> </Diagnostics>
This example shows how jars versions are exported to /tmp/export-MyApp-Versions.csv
using the jarsLocation
parameter. In this case, the libraries passed explicitly in the jarsLocation
parameter will be exported. R/W
privileges for the CSV file need to be verified.
wls:/offline>exportApplicationSelectedJarVersions('MyApp', '/tmp/export-MyApp-Versions.csv', '$ORACLE_HOME$/modules/oracle.adf.model_11.1.1/adfm.jar;$ORACLE_HOME$/modules/oracle.adf.view_11.1.1/adf-richclient-impl-11.jar')