Using Component Types to Deploy WebLogic Applications

The WebLogic 8 Plug-In includes several WebLogic-specific component types. These component types enable you to quickly model many of the most common WebLogic application components and to automatically associate install, uninstall, export, and snapshot behavior with a particular resource. Many of the component types are used by the software when you create and manage servers and clusters. As a result, you will only work with a few component types on a regular basis.

• Enterprise Application (EAR) Component Type

• Web Application (WAR) Component Type

• Java Archive Files Containing EJBs Component Type

However, based on the needs of your application, you might need to configure the WebLogic services before you can deploy the application components. To configure the services, you might need to rely on the component types that are described in the following sections:

• Connection Pool Component Type

• Data Source and Transaction Data Source Component Types

• Multi Pool Component Type

• Thread Pool Component Type

• Transaction Service Component Type

• JMS Server Component Type

• JMS Queue Component Type

• JMS Topic Component Type

• JMS File Store Component Type

• JMS JDBC Store Component Type

• JMS Connection Factory Component Type

• JMS Destination Key Component Type

• Mail Session Component Type

These configuration component types are only necessary if your application requires them. For example, if your web application uses a database to retrieve and store information, you will need to configure a connection pool and data source or transactional data source.

To use these configuration component types, select the task that you want to perform and run the associated component procedure. If you need to create and check-in a new component based on an existing component elsewhere on your file system, click Create. After checking in the new component, you can run the appropriate component procedure to configure the WebLogic environment according to your application's needs.

You usually configure and deploy these configuration component types before deploying your application. However, you can configure the WebLogic environment after the application components have been deployed by restarting the application after configuration is complete. Redeploy the application to restart it.

For more information about configuring these configuration objects, see BEA's Administration Console Online Help.

Enterprise Application (EAR) Component Type

A component of this type models an enterprise application. The component can contain either an enterprise application archive (EAR) or the expanded version of an EAR as a package.

Browsing for an Enterprise Application

You can use one of the following browsers to select your enterprise application for this component type:

• A WebLogic Administration Server browser from which you can select one of the installed applications and its relevant settings. The Administration Server browser provides an alphabetical list of enterprise applications on the Administration Server. You can choose one enterprise application for a component.

• A file system browser from which you can select the EAR file to create a component that does not include settings. The file system browser provides a list of files and directories from which you can choose. You can choose to see only those files or type *.ear in the browser.

Installing an Enterprise Application

To install an enterprise application component, you must use a WebLogic Managed Server or cluster as the target host. The installation process performs three main tasks:

1. Installs the EAR file on the target.

2. Registers the EAR with the WebLogic Administration Server.

3. Applies any properties previously captured during domain browse.

You can install the enterprise application by navigating to the application's component Details page and running the Install component procedure.

Uninstalling an Enterprise Application

When you uninstall an enterprise application component, the enterprise application no longer targets the virtual host. If the enterprise application is not targeted elsewhere, the registration component is removed from the Administration Server.

You can uninstall the enterprise application by navigating to the application's component Details page and running the Uninstall component procedure.

Error Conditions

Table 4–2 WebLogic Enterprise Application Error Conditions

Action	Condition	Result
Install	The topology is incorrectly configured (target host does not point at correct domain host)	Targeting fails
Install	The target host is not a valid WebLogic target	Installation prohibited
Browsing/Install/Uninstall	Credentials are not properly configured	Operation fails
Browsing	Path not correctly configured in domain host	Browsing fails

Web Application (WAR) Component Type

A component of this type includes a web application. The component can contain either a web application and its relevant settings or the web application without its settings.

Browsing for a Web Application

You can use one of the following browsers to select your web application for this component type:

• A WebLogic Administration Server browser from which you can select one of the installed applications and its relevant settings. The Administration Server browser provides an alphabetical list of web applications on the Administration Server. You can choose one web application for a component.

• A file system browser from which you can select the WAR file to create a component that does not include settings. The file system browser provides a list of files and directories from which you can choose. You can choose to see only those files or type *.war in the browser.

Installing a Web Application

To install a web application component, you must use a WebLogic Managed Server or cluster as the target host. The installation process will install the component on that target, and install the contained registration component on the Administration Server of the target.

You can install the web application by navigating to the application's component Details page and running the Install component procedure.

Uninstalling a Web Application

When you uninstall a web application component, the web application no longer targets the virtual host. If the web application is not targeted elsewhere, the registration component is removed from the Administration Server.

You can uninstall the web application by navigating to the application's component Details page and running the Uninstall component procedure.

Error Conditions

Table 4–3 WebLogic Web Application Error Conditions

Action	Condition	Result
Install	The topology is incorrectly configured (target host doesn't point at correct domain host)	Targeting fails.
Install	The target host is not a valid WL target.	Installation prohibited.
Browsing/Install/Uninstall	Credentials aren't properly configured.	Operation fails.
Browsing	Path not correctly configured in domain host.	Browsing fails.

Java Archive Files Containing EJBs Component Type

Browsing for a JAR or EJB File

You can use one of the following browsers to select your EJB or JAR files for this component type:

• A WebLogic Administration Server browser from which you can select one of the installed applications and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server. You can choose one EJB for a component.

• A file system browser from which you can select the JAR file to create a component that does not include settings. The file system browser provides a list of files and directories from which you can choose. You can choose to see only those files or type *.jar in the browser.

Installing a JAR or EJB File

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the JAR or EJB file by navigating to the application's component Details page and running the Install component procedure.

Uninstalling a JAR or EJB File

When you uninstall a component of this type, the file or directory is removed from the master server.

You can uninstall the JAR or EJB file by navigating to the component Details page and running the Uninstall component procedure.

Error Conditions

Table 4–4 WebLogic EJB container Error Conditions

Action	Condition	Result
Uninstall	A dependant WebLogic EJB is still installed.	Uninstall fails indicating the dependency.

Connection Pool Component Type

Browsing for a Connection Pool

You can use a WebLogic Administration Server browser from which you can select a connection pool and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

The WebLogic plug-in also includes a default connection pool component called WLJDBCConnectionPoolConfig. This default component eliminates the need for browsing. You can find the default component in the /com/sun/webLogic8 folder or by selecting View All from the Common Tasks page. The default component can then be installed through the component Details page using the Default: Install component procedure.

Installing a Connection Pool

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the connection pool by navigating to the component Details page and running the Install component procedure.

You must set the following required variables before installing the connection pool:

• Pool name

• URL

• Driver

• Database name

• User

• Password

Uninstalling a Connection Pool

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the connection pool by navigating to the component Details page and running the Uninstall component procedure.

Data Source and Transaction Data Source Component Types

Browsing for a Data Source or Transaction Data Source

You can use a WebLogic Administration Server browser from which you can select the data source or transaction data source and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

The WebLogic plug-in also includes a default data source and transaction data source, which eliminates the need for browsing. You can find the default components in the /com/sun/webLogic8 folder or by selecting View All from the Common Tasks page. The default components can then be installed through the component Details page using the Default: Install component procedure. The default components are named as follows:

• WLDataSourceConfig – the data source component

• WLTxDataSourceConfig – the transactional data source component

Installing a Data Source or Transaction Data Source

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the data source or transaction data source by navigating to the component Details page and running the Install component procedure.

---

Note –

Before you install a data source or transaction data source component, a connection pool component must already be installed.

---

You must set the following required variables before installing the data source or transaction data source:

• Data Source or Transaction Data Source name

• Java Naming and Directory Interface™ (JNDI™) name

• Pool name

Uninstalling a Data Source or Transaction Data Source

When you uninstall a component of this type, the file or directory is removed from the master server.

You can uninstall the data source or transaction data source by navigating to the component Details page and running the Uninstall component procedure.

Multi Pool Component Type

Browsing for a Multi Pool

You can use a WebLogic Administration Server browser from which you can select a Multi Pool and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

The WebLogic plug-in also includes a default multi pool component called WLJDBCMultiPoolConfig. This default component eliminates the need for browsing. You can find the default component in the /com/sun/webLogic8 folder or by selecting View All from the Common Tasks page. The default component can then be installed through the component Details page using the Default: Install component procedure.

Installing a Multi Pool

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the multi pool by navigating to the component Details page and running the Install component procedure.

You must set the following required variables before installing the multi pool:

• Multi Pool name

• Algorithm type

• Pool List – A pipe-separated (|) list of connection pools.

Uninstalling a Multi Pool

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the Multi Pool by navigating to the component Details page and running the Uninstall component procedure.

Thread Pool Component Type

Configuring the Thread Pool

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the thread pool by navigating to the component Details page and running the Install component procedure.

You can edit the plan parameter variable settings.

Uninstalling a Thread Pool

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the thread pool by navigating to the component Details page and running the Uninstall component procedure.

Transaction Service Component Type

Configuring the Transaction Service

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the transaction service by navigating to the component Details page and running the Install component procedure.

You can edit the plan parameter variable settings.

Uninstalling a Transaction Service

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the transaction service by navigating to the component Details page and running the Uninstall component procedure.

JMS Server Component Type

Browsing for a JMS Server

You can use a WebLogic Administration Server browser from which you can select a JMS Server and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

The WebLogic plug-in also includes a default JMS server component called WLJMSServerConfig. This default component eliminates the need for browsing. You can find the default component in the /com/sun/webLogic8 folder or by selecting View All from the Common Tasks page. The default component can then be installed through the component Details page using the Default: Install component procedure.

Installing a JMS Server

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the JMS Server by navigating to the component Details page and running the Install component procedure.

You must set the required JMS Server name variable before installing the JMS Server.

Uninstalling a JMS Server

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the JMS Server by navigating to the component Details page and running the Uninstall component procedure.

JMS Queue Component Type

Browsing for a JMS Queue

You can use a WebLogic Administration Server browser from which you can select a JMS queue and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

The WebLogic plug-in also includes a default JMS Queue component called WLJMSQueueConfig. This default component eliminates the need for browsing. You can find the default component in the /com/sun/webLogic8 folder or by selecting View All from the Common Tasks page. The default component can then be installed through the component Details page using the Default: Install component procedure.

Installing a JMS Queue

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the JMS Queue by navigating to the component Details page and running the Install component procedure.

---

Note –

Before you install a JMS Queue component, a JMS Server component must already be installed.

---

You must set the following required variables before installing the component:

• jmsDestName

• jmsserverName

• jndiName

Uninstalling a JMS Queue

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the JMS Queue by navigating to the component Details page and running the Uninstall component procedure.

JMS Topic Component Type

Browsing for a JMS Topic

You can use a WebLogic Administration Server browser from which you can select a JMS topic and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

The WebLogic plug-in also includes a default JMS Topic component called WLJMSTopicConfig. This default component eliminates the need for browsing. You can find the default component in the /com/sun/webLogic8 folder or by selecting View All from the Common Tasks page. The default component can then be installed through the component Details page using the Default: Install component procedure.

Installing a JMS Topic

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the connection pool by navigating to the component Details page and running the Install component procedure.

---

Note –

Before you install a JMS Topic component, a JMS Server component must already be installed.

---

You must set the following required variables before installing the component:

• jmsDestName

• jmsserverName

• jndiName

Uninstalling a JMS Topic

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the JMS topic by navigating to the component Details page and running the Uninstall component procedure.

JMS File Store Component Type

Browsing for a JMS File Store

You can use a WebLogic Administration Server browser from which you can select a JMS File Store and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

The WebLogic plug-in also includes a default JMS File Store component called WLJMSFileStoreConfig. This default component eliminates the need for browsing. You can find the default component in the /com/sun/webLogic8 folder or by selecting View All from the Common Tasks page. The default component can then be installed through the component Details page using the Default: Install component procedure.

Installing a JMS File Store

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the JMS File Store by navigating to the component Details page and running the Install component procedure.

You must set the following required variables before installing the component:

• jmsFileStoreName

Uninstalling a JMS File Store

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the JMS File Store by navigating to the component Details page and running the Uninstall component procedure.

JMS JDBC Store Component Type

Browsing for a JMS JDBC Store

You can use a WebLogic Administration Server browser from which you can select a JMS JDBC Store and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

The WebLogic plug-in also includes a default JMS JDBC Store component called WLJMSJDBCStoreConfig. This default component eliminates the need for browsing. You can find the default component in the /com/sun/webLogic8 folder or by selecting View All from the Common Tasks page. The default component can then be installed through the component Details page using the Default: Install component procedure.

Installing a JMS JDBC Store

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the JMS JDBC Store by navigating to the component Details page and running the Install component procedure.

You must set the following required variables before installing the component:

• jmsJDBCStoreName

Uninstalling a JMS JDBC Store

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the JMS JDBC Store by navigating to the component Details page and running the Uninstall component procedure.

JMS Connection Factory Component Type

A JMS connection factory encapsulates connection configuration information and enables JMS applications to communicate with the messaging system.

Browsing for a JMS Connection Factory

You can use a WebLogic Administration Server browser from which you can select a JMS connection factory and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

The WebLogic plug-in also includes a default JMS Connection Factory component called WLJMSConnectionFactoryConfig. This default component eliminates the need for browsing. You can find the default component in the /com/sun/webLogic8 folder or by selecting View All from the Common Tasks page. The default component can then be installed through the component Details page using the Default: Install component procedure.

Installing a JMS Connection Factory

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the JMS Connection Factory by navigating to the component Details page and running the Install component procedure.

You must set the following required variables before installing the component:

• jmsConnectionFactoryName

• jndiName

Uninstalling a JMS Connection Factory

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the JMS Connection Factory by navigating to the component Details page and running the Uninstall component procedure.

JMS Destination Key Component Type

Browsing for a JMS Destination Key

You can use a WebLogic Administration Server browser from which you can select a JMS destination key and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

The WebLogic plug-in also includes a default JMS Destination Key component called WLJMSDestinationKeyConfig. This default component eliminates the need for browsing. You can find the default component in the /com/sun/webLogic8 folder or by selecting View All from the Common Tasks page. The default component can then be installed through the component Details page using the Default: Install component procedure.

Installing a JMS Destination Key

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the JMS Destination Key by navigating to the component Details page and running the Install component procedure.

You must set the following required variables before installing the component:

• jmsDestinationKeyName

Uninstalling a JMS Destination Key

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the JMS Destination Key by navigating to the component Details page and running the Uninstall component procedure.

Mail Session Component Type

Browsing for a Mail Session

You can use a WebLogic Administration Server browser from which you can select a mail session and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

Installing a Mail Session

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the mail session by navigating to the component Details page and running the Install component procedure.

You must set the following required variables before installing the mail session:

• msName

• jndiName

• Mail session property – This variable is generated by the WebLogic 8 plug-in, and is set to the value you set for the property of the mail session in the WebLogic console. For example, mail.user.

Uninstalling a Mail Session

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the mail session by navigating to the component Details page and running the Uninstall component procedure.

Configuring WebLogic With Component Types

Browsing for Existing Configuration Settings and Infrastructure Objects

You can use a WebLogic Administration Server browser to select application server configuration objects and their relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

The WebLogic plug-in also includes default components, which eliminate the need for browsing. You can find the default component in the /com/sun/webLogic8 folder or by selecting View All from the Configuration Tasks section of the Common Tasks page. The default component can then be installed through the component Details page using the Default: Install component procedure.

The following list contains each WebLogic configuration object that has been modeled as a component type. The list also provides the default component name and the component variables that require custom values.

Data Source Component Type

The default component for this component type is WLDataSourceConfig. Required component variables: Data source name (dataSourceName), JNDI name (jndiName), Pool name (poolName).

Transactional Data Source Component Type

The default component for this component type is WLTxDataSourceConfig. Required component variables: Transaction data source name (dataSourceName), JNDI name (jndiName), Pool name (poolName).

Connection Pool Component Type

The default component for this component type is WLJDBCConnectionPoolConfig. Required component variables: Pool name (name), URL (url), Driver (driverName), Database name (databaseName), User (user), Password (password).

Multi Pool Component Type

The default component for this component type is WLJDBCMultiPoolConfig. Required component variables: Multi Pool name(multiPoolName), Algorithm type(algorithmType), Pool list – A pipe-separated (|) list of connection pools (poolList).

Thread Pool Component Type

You cannot browse for an existing thread pool.

Transaction Service Component Type

You cannot browse for an existing thread pool.

JMS Server Component Type

The default component for this component type is WLJMSServerConfig. Required component variables: JMS Server name (jmsServerName).

JMS Queue Component Type

The default component for this component type is WLJMSQueueConfig. Required component variables: JMS destination name (jmsDestName), JMS Server name (jmsserverName), JNDI name of the JMS destination (jndiName).

JMS Topic Component Type

The default component for this component type is WLJMSTopicConfig. Required component variables: JMS destination name (jmsDestName), JMS Server name (jmsserverName), JNDI name of the JMS destination (jndiName).

JMS File Store Component Type

The default component for this component type is WLJMSFileStoreConfig. Required component variables: Name of the JMS file store (jmsFileStoreName).

JMS JDBC Store Component Type

The default component for this component type is WLJMSJDBCStoreConfig. Required component variables: Name of the JMS JDBC store (jmsJDBCStoreName).

JMS Connection Factory Component Type

The default component for this component type is WLJMSConnectionFactoryConfig. Required component variables:Name of the JMS connection factory (jmsConnectionFactoryName), JNDI name (jndiName).

JMS Destination Key Component Type

The default component for this component type is WLJMSDestinationKeyConfig. Required component variables: Name of the JMS destination key (jmsDestinationKeyName).

Mail Session Component Type

No default component exists for this component type.

Required component variables: Mail session name (msName), JNDI name (jndiName), and the variable generated from the WebLogic value of the mail session property.

Installing a WebLogic Configuration Component

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the component by navigating to the component Details page and running the Install component procedure. Many components require that you edit certain component variables. See the list of WebLogic configuration component types for variables that require custom values.

Uninstalling a WebLogic Configuration Component

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the configuration component by navigating to the component Details page and running the Uninstall component procedure.

License Component Type

Browsing for a License

You can use a WebLogic Administration Server browser from which you can select a mail session and its relevant settings. The Administration Server browser provides an alphabetical list of applications on the Administration Server.

You can use a file system browser from which you can select the license. The file system browser provides a list of files and directories from which you can choose.

Installing a License

When you install a component of this type, the file or directory is copied to the file system based on the install path. Once that copy finishes, the file or directory is registered with the WebLogic Administration Server.

You can install the license by navigating to the component Details page and running the Install component procedure.

Uninstalling a License

When you uninstall a component of this type, the file or directory is removed from the Master Server.

You can uninstall the license by navigating to the component Details page and running the Uninstall component procedure.