Chapter 4 Using the Sun Java Enterprise System Application Server Plug-In

The Sun Java Enterprise System Application Server plug-in provides a number of specific component types and provides easy access to functions for working with Sun Java Enterprise System Application Server applications. This chapter describes the following information:

• Installing and Using the Sun Java Enterprise System Application Server Environment with the N1 Grid Service Provisioning System 5.0

• Creating the Sun Java Enterprise System Application Server Domain Infrastructure

• Troubleshooting

Installing and Using the Sun Java Enterprise System Application Server Environment with the N1 Grid Service Provisioning System 5.0

Use the Sun Java Enterprise System Application Server Common Tasks page as a starting point to create and manage Application Server instances and clusters.

Plug-In Conventions

The provisioning system allows you to provision and manage applications.

Plans and Component Procedures

The Sun Java Enterprise System Application Server plug-in provides both plans and component procedures as tools for you to perform tasks. By using plans, you link directly to the functionality you desire. Using component procedures, you have a greater number of tasks that you can perform.

Global Prerequisites

This section describes the requirements for using the Sun Java Enterprise System Application Server Plug-In.

Process Overview

Creating a Sun Java Enterprise System Application Server environment within the provisioning system is similar to the process of creating the environment without the provisioning system.

1. Import the Application Server plug-in.

2. Set the Application Server session variables.

3. Prepare all hosts.

4. Create an Application Server Domain Administration Server.

5. (Optional) Create an Application Server cluster.

6. (Optional) Add cluster nodes to the newly created cluster.

7. Create an Application Server instance in the new Application Server domain.

8. (Optional) Associate the server instance with the cluster.

9. Create additional resources used by the applications.

10. (Optional) Configure the JMS server.

11. Capture application files (EARs and WARs).

12. Deploy applications to target instances or clusters.

Creating the Sun Java Enterprise System Application Server Domain Infrastructure

This section describes how to prepare your N1 Grid Service Provisioning System 5.0 installation to take advantage of the featured provided by Sun Java Enterprise System Application Server Plug-In.

How to Install the Sun Java Enterprise System Application Server Software

Steps

1. Select the Sun Java Enterprise System Application Server icon under the Common Tasks section of the left control panel.

2. Click the SJSAS 8.1 Install Management: Install or Uninstall link.

3. Click the Run action next to default: install.

4. In the Plan Parameters area, select the variable settings for the Install component that you plan to deploy.

   The Install component installs the Sun Java Enterprise System Application Server on a Remote Agent. After you have installed the Install component on a Remote Agent, you do not have to reinstall that component again.

   When you run the plan to install a new domain or server instance, the provisioning system checks to see if an Install component exists in the installPath directory. If the Install component is already installed, the provisioning system does not reinstall the Install component.

   • If the variable settings have been established for this component, select the appropriate settings from the menu.

   • If the settings are not available from the menu, click Select From List.

     The Select Variable Settings From List window displays.

     • To create a new set of variable settings, select Create Set.

       The following list provides commonly-updated variables for the Install component.

       variable set name

       Required. A name for the new variable set you create.

       installDirectory

       Required. The location where the Sun Java Enterprise System Application Server software will be installed.

       sourceImage

       Required. The location of the Sun Java Enterprise System Application Server package installer.

       Typically this is an NFS-mounted directory containing the extracted Sun Java Enterprise System Application Server installer. For example, if the value of sourceImage is /net/mymachine/nfs/sjsappserver8.1, you would do the following before installing the plug-in:

       % mkdir /net/mymachine/nfs/sjsappserver8.1 % cd /net/mymachine/nfs/sjsappserver8.1 % unzip .../sjsas_ee-8_1_01_2005Q1-solaris-sparc.bin

       installId

       Required. A unique ID that associates an Install component with installed Application Server domains and clusters.

       adminUserId

       The user name of the administrator of the domain or cluster.

       Typically this will be picked up from the session variables.

       adminPassword

       The password for the administrator login of the domain or cluster.

       Typically this will be picked up from the session variables.

       httpLoadBalancerPluginType

       If you are using a web server load balancer with the domain or cluster, enter the type of web server here. Valid entries are Sun ONE Web Server or Apache HTTP Server.

       The web server must already be installed on the target host.

       webserverInstallDirectory

       Location of the web server, used when installing the load balancer plug-in. For Sun ONE Web Server, enter the instance directory. For Apache HTTP Server, enter the install directory.

       webserverConfigDirectory

       The directory where the load balancer configuration file, loadbalancer.xml will be located.

       Only set this variable if the load balancing plug-in is already installed on the web server gateway host.

       adminPasswordEncryptedFlag

       If set to true, the administrator's password will be encrypted. The default is false.

       asadminPort

       The port on which the Application Server domain administration server listens. The default is 4849.

       adminWebPort

       The port on which deployed web applications run. The default is 8090.

       instanceHTTPSPort

       The port on which secure HTTP (HTTPS) applications are run. The default is 1043.

       createSamplesDomain

       If true, a domain containing Application Server sample applications will be installed on the instance. The default is false.

       storeAdminAuth

       If true, the administrator's password will be written to a file. The default is false.

       tempStateFile

       The location of temporary files used during installation.

       We recommend that you do not change this variable.

     • To use variable components from another component, click Import Set.

       For more information about importing variable sets, see How to Run a Plan in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

5. Select the target host.

   Install the Application Server software on the Remote Agent.

6. Deselect the Target Host Set checkbox.

7. If you want to run a detailed check (preflight) before installing, select Perform Detailed Preflight.

8. Click Run Plan (includes preflight).

How To Create a Sun Java Enterprise System Application Server Domain Administration Server

The Domain Administration Server manages Application Server domains. It must be installed before you can create individual domains. When you install a Domain Administration Server, you create an initial domain and an administration server that controls that domain.

Before You Begin

To create an Application Server domain, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps

1. From the Common Tasks section in the browser interface, click AppServer 8.1.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 domains click Manage.

3. Under Component Procedures click the Run action next to default: install.

4. In the Plan Parameters area, select the variable settings for the Domain Administration Server you want to install.

   • If the variable settings have been established for this component, select the appropriate settings from the menu.

   • If the settings are not available from the menu, click Select From List.

     The Select Variable Settings From List window displays.

     • To create a new set of variable settings, select Create Set.

       The following list provides commonly-updated variables for the Install component.

       variable set name

       Required. A name for the new variable set you create.

       installIdentifier

       A unique ID to associate a Domain Administration Server with an install image.

       domainName

       The name of the domain you wish to create.

       adminUserId

       The user name of the administrator of the domain or cluster.

       adminPassword

       The password for the administrator login of the domain or cluster.

       adminHost

       The name of the host on which the Domain Administration Server will be installed.

       portRangePrefix

       The HTTP port range prefix. For example, a value of 100 means the HTTP port range begin with 10000. The default value is 100.

       httpListenerPort

       The HTTP listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 00. If portRangePrefix is set to 100, the HTTP listener port is 10000.

       httpsListenerPort

       The HTTPS listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 05. If portRangePrefix is set to 100, the HTTPS listener port is 10005.

       instancePort

       The default port number for the Domain Administration Server.

       iiopListenerPort

       The Internet Inter-Orb Protrocol (IIOP) listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 10. If portRangePrefix is set to 100, the IIOP listener port is 10010.

       iiopsslListenerPort

       The SSL-enabled Internet Inter-Orb Protrocol (IIOP) listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 15. If portRangePrefix is set to 100, the secure IIOP listener port is 10015.

       iiopsslmutualauthPort

       The SSL-enabled Internet Inter-Orb Protrocol (IIOP) listener port for mutual authorization, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 20. If portRangePrefix is set to 100, the mutual authorization secure IIOP listener port is 10020.

       jmsConnectorPort

       The port on which the Java Messaging Service (JMS) connector listens. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 25. If portRangePrefix is set to 100, the JMS connector port is 10025.

       installDirectory

       The location where the Application Server is installed.

     • To use variable components from another component, click Import Set.

       For more information about importing variable sets, see “How to Run a Plan” in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

5. Select the target host.

   Install the Domain Administration Server and the domain on the Remote Agent.

6. Deselect the Target Host Set checkbox.

7. If you want to run a detailed check (preflight) before installing, select Perform Detailed Preflight.

8. Click Run Plan (includes preflight).

How To Create a Sun Java Enterprise System Application Server Instance

You can run multiple Application Server instances in each domain.

Before You Begin

Before you create an Application Server instance, you must do the following:

• Create the domain on which the server instance will run.

  For information on creating a domain, see

• The Domain Administration Server must be running.

  To manually start a Domain Administration Server,

• You must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 Managed Server Instances click Manage.

3. Under Component Procedures click the Run action next to default: install.

4. In the Plan Parameters area, select the variable settings for the managed server instance you want to install.

   • If the variable settings have been established for this component, select the appropriate settings from the menu.

   • If the settings are not available from the menu, click Select From List.

     The Select Variable Settings From List window displays.

     • To create a new set of variable settings, select Create Set.

       The following list provides commonly-updated variables for the Install component.

       variable set name

       Required. A name for the new variable set you create.

       installIdentifier

       A unique ID to associate domains, clusters, node agents, and Application Server instances with an Install component.

       domainName

       The domain name in which this server instance will be located

       targetName

       The name of the server.

       portRangePrefix

       The HTTP port range prefix. For example, a value of 100 means the HTTP port range begin with 10000. The default value is 100.

       httpListenerPort

       The HTTP listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 00. If portRangePrefix is set to 100, the HTTP listener port is 10000.

       httpsListenerPort

       The HTTPS listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 05. If portRangePrefix is set to 100, the HTTPS listener port is 10005.

       iiopListenerPort

       The Internet Inter-Orb Protocol (IIOP) listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 10. If portRangePrefix is set to 100, the IIOP listener port is 10010.

       iiopsslListenerPort

       The SSL-enabled Internet Inter-Orb Protocol (IIOP) listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 15. If portRangePrefix is set to 100, the secure IIOP listener port is 10015.

       iiopsslmutualauthPort

       The SSL-enabled Internet Inter-Orb Protocol (IIOP) listener port for mutual authorization, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 20. If portRangePrefix is set to 100, the mutual authorization secure IIOP listener port is 10020.

       jmsConnectorPort

       The port on which the Java Messaging Service (JMS) connector listens. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 25. If portRangePrefix is set to 100, the JMS connector port is 10025.

       clusterName

       The name of the cluster to which this server instance belongs. If no cluster is specified the server instance is a standalone server. By default no cluster is specified.

     • To use variable components from another component, click Import Set.

       For more information about importing variable sets, see “How to Run a Plan” in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

5. Select the target host.

   Install the server instance on the Remote Agent.

6. Deselect the Target Host Set checkbox.

7. If you want to run a detailed check (preflight) before installing, select Perform Detailed Preflight.

8. Click Run Plan (includes preflight).

How To Create a Sun Java Enterprise System Application Server Cluster

A cluster appears to clients as a single Application Server instance. The server instances that constitute a cluster can run on the same machine, or can be located on different machines. Each cluster member in a cluster must run the same version of Application Server.

A cluster provides:

• Increase application availability with the server's failover capabilities.

• Increase throughput by scaling applications across multiple servers.

Before You Begin

Before you create a cluster, you must create an Application Server domain and an Domain Administration Server.

To create a cluster, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 clusters click Manage.

3. Under Component Procedures click the Run action next to default: install.

4. In the Plan Parameters area, select the variable settings for the cluster you want to install.

   • If the variable settings have been established for this component, select the appropriate settings from the menu.

   • If the settings are not available from the menu, click Select From List.

     The Select Variable Settings From List window displays.

     • To create a new set of variable settings, select Create Set.

       The following list provides commonly-updated variables for the Install component.

       variable set name

       Required. A name for the new variable set you create.

       installIdentifier

       A unique ID to associate domains, clusters, node agents, and Application Server instances with an Install component.

       domainName

       The domain name in which this cluster will be located

       targetName

       The name of the cluster.

       portRangePrefix

       The HTTP port range prefix. For example, a value of 100 means the HTTP port range begin with 10000. The default value is 100.

       httpListenerPort

       The HTTP listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 00. If portRangePrefix is set to 100, the HTTP listener port is 10000.

       httpsListenerPort

       The HTTPS listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 05. If portRangePrefix is set to 100, the HTTPS listener port is 10005.

       iiopListenerPort

       The Internet Inter-Orb Protocol (IIOP) listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 10. If portRangePrefix is set to 100, the IIOP listener port is 10010.

       iiopsslListenerPort

       The SSL-enabled Internet Inter-Orb Protocol (IIOP) listener port, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 15. If portRangePrefix is set to 100, the secure IIOP listener port is 10015.

       iiopsslmutualauthPort

       The SSL-enabled Internet Inter-Orb Protocol (IIOP) listener port for mutual authorization, used with portRangePrefix. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 20. If portRangePrefix is set to 100, the mutual authorization secure IIOP listener port is 10020.

       jmsConnectorPort

       The port on which the Java Messaging Service (JMS) connector listens. The valid range is 1–65553. For port numbers 1–1024, superuser permissions are required. The default is portRangePrefix plus 25. If portRangePrefix is set to 100, the JMS connector port is 10025.

       httpLoadBalancer

       If true, applications deployed to this cluster will be load balanced. The default is false.

       httpsLoadBalancer

       If true, applications responding to HTTPS requests will be load balanced. This variable has no effect if httpLoadBalancer is false. The default is false.

       routeCookie

       If true, the load balancer will route cookies. This variable has no effect if httpLoadBalancer is false. The default is false.

     • To use variable components from another component, click Import Set.

       For more information about importing variable sets, see “How to Run a Plan” in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

5. Select the target host.

   Install the cluster on the Remote Agent.

6. Deselect the Target Host Set checkbox.

7. If you want to run a detailed check (preflight) before installing, select Perform Detailed Preflight.

8. Click Run Plan (includes preflight).

Managing Sun Java Enterprise System Application Server Instances and Clusters

This section describes how to maintain Sun Java Enterprise System Application Server managed server instances and clusters.

Managing Sun Java Enterprise System Application Server Domains and Domain Administration Servers

How to Remove a Sun Java Enterprise System Application Server Domain and Domain Administration Server

By removing an Application Server domain through the provisioning system, you automatically perform the following tasks:

• Uninstall the Domain Administration Server.

• Uninstall all Managed Servers components in the domain.

• Uninstall all cluster components in the domain.

• Remove application components and applications.

Before You Begin

To remove an Application Server domain, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to run the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 domains click Manage.

3. Under Component Procedures click the Run action next to default: uninstall.

4. Under Current Installations select the installation(s) on which the domain you'd like to remove is running.

5. Click Run Plan (Includes Preflight).

How to Start a Complete Domain

Starting a complete domain starts the domain's Domain Administration Server if it is not currently running, all clusters in the domain, and all managed server instances in the domain.

Before You Begin

To start an Application Server domain, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to run the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 domains click Manage.

3. Under Component Procedures click the Run action next to default: startCompletedDomain.

4. Under Current Installations select the installation(s) on which the domain you'd like to start was configured.

5. Click Run Plan (Includes Preflight).

How to Stop a Complete Domain

Stopping a completed domain stops all running clusters and all running managed server instances for a particular domain.

Before You Begin

To stop an Application Server domain, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to run the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 domains click Manage.

3. Under Component Procedures click the Run action next to default: stopCompletedDomain.

4. Under Current Installations select the installation(s) on which the domain you'd like to stop is running.

5. Click Run Plan (Includes Preflight).

How to Start a Domain Administration Server

Before You Begin

To start an Application Server Domain Administration Server, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to run the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 domains click Manage.

3. Under Component Procedures click the Run action next to default: startDomainServer.

4. Under Current Installations select the installation(s) on which the domain you'd like to start was configured.

5. Click Run Plan (Includes Preflight).

How to Stop a Domain Administration Server

Before You Begin

To stop an Application Server Domain Administration Server, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to run the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 domains click Manage.

3. Under Component Procedures click the Run action next to default: stopDomainServer.

4. Under Current Installations select the installation(s) on which the domain you'd like to start was configured.

5. Click Run Plan (Includes Preflight).

How to Verify a Domain Administration Server is Running

You can verify that a Domain Administration Server is running on a particular installation.

Before You Begin

To verify a Domain Administration Server is running, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to run the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 domains click Manage.

3. Under Component Procedures click the Run action next to default: verifyDomainServerIsRunning.

4. Under Current Installations select the installation(s) on which the Domain Administration Server you'd like to verify was configured.

5. Click Run Plan (Includes Preflight).

Managing Sun Java Enterprise System Application Server Clusters

How to Remove a Sun Java Enterprise System Application Server Cluster

When you remove a cluster, all cluster members associated with that cluster are also removed.

For more information about the behavior of cluster members returning to the role of Managed Servers, see

Before You Begin

To remove a cluster, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 clusters click Manage.

3. Under Component Procedures click the Run action next to default: uninstall.

4. Under Current Installations select the installation(s) on which the cluster you'd like to remove is running.

5. Click Run Plan (Includes Preflight).

How to Start a Sun Java Enterprise System Application Server Cluster

Before You Begin

To start a cluster, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 clusters click Manage.

3. Under Component Procedures click the Run action next to start.

4. Under Current Installations select the installation(s) on which the cluster you'd like to start was configured.

5. Click Run Plan (Includes Preflight).

How to Stop a Sun Java Enterprise System Application Server Cluster

Before You Begin

To stop a cluster, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 clusters click Manage.

3. Under Component Procedures click the Run action next to stop.

4. Under Current Installations select the installation(s) on which the cluster you'd like to stop was configured.

5. Click Run Plan (Includes Preflight).

How to Verify a Sun Java Enterprise System Application Server Cluster is Running

Before You Begin

To verify a cluster, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 clusters click Manage.

3. Under Component Procedures click the Run action next to verifyClusterRunning.

4. Under Current Installations select the installation(s) on which the cluster you'd like to verify was configured.

5. Click Run Plan (Includes Preflight).

Managing Sun Java Enterprise System Application Server Instances

How to Remove a Sun Java Enterprise System Application Server Instance

Before You Begin

To remove a server instance you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 Managed Server Instances click Manage.

3. Under Component Procedures click the Run action next to default: uninstall.

4. Under Current Installations select the installation(s) on which the server instance you'd like to remove is configured.

5. Click Run Plan (Includes Preflight).

How to Start a Sun Java Enterprise System Application Server Instance

Before You Begin

To start a server instance, you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 Managed Server Instances click Manage.

3. Under Component Procedures click the Run action next to start.

4. Under Current Installations select the installation(s) on which the server instance you'd like to start was configured.

5. Click Run Plan (Includes Preflight).

How to Stop a Sun Java Enterprise System Application Server Instance

Before You Begin

To stop a server instance you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 Managed Server Instances click Manage.

3. Under Component Procedures click the Run action next to stop.

4. Under Current Installations select the installation(s) on which the server instance you'd like to stop was configured.

5. Click Run Plan (Includes Preflight).

How to Verify a Sun Java Enterprise System Application Server Instance is Running

Before You Begin

To verify a server instance is running you must belong to a user group that has the Run Component Procedures permission on the folder that contains the component. You must also have the Allow on Host Set permission for the host set on which you plan to deploy the component.

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS 8.1 AppServer infrastructure->SJSAS 8.1 Managed Server Instances click Manage.

3. Under Component Procedures click the Run action next to verifyClusterRunning.

4. Under Current Installations select the installation(s) on which the server instance you'd like to verify was configured.

5. Click Run Plan (Includes Preflight).

Capturing and Installing Sun Java Enterprise System Application Server Applications

This section describes how to manage Sun Java Enterprise System Application Server applications.

How to Capture a Sun Java Enterprise System Application Server Enterprise Application

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS Application Tasks->Enterprise Applications (EARs) click Create New.

3. Enter a component directory for this component. The com/sun/sjsas81 namespace is not valid.

4. Enter a label for this component.

5. Enter a description for this component.

6. Enter the host where the EAR file is located.

   To select the host from a list, click Select From List.

7. Navigate to the location of the EAR.

   1. If you know the path to the EAR, enter it in com.sun.sjsas81#EntappCT path.

   2. To browse the selected host, select the directory and click Open Highlighted Item.

8. Select the EAR and click Open Highlighted Item.

9. Click Check In Selected Item.

10. Confirm the information on the check-in page, then click Continue to Check-in.

How to Install a Sun Java Enterprise System Application Server Enterprise Application

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS Application Tasks->Enterprise Applications (EARs) click View All.

3. Click the name of the EAR you want to install.

4. Under Component Procedures click the Run action next to default: install.

5. In the Plan Parameters area, select the variable settings for the EAR you want to install.

   • If the variable settings have been established for this component, select the appropriate settings from the menu.

   • If the settings are not available from the menu, click Select From List.

     The Select Variable Settings From List window displays.

     • To create a new set of variable settings, select Create Set.

       The following list provides commonly-updated variables for the Install component.

       variable set name

       Required. A name for the new variable set you create.

       installIdentifier

       A unique ID to associate the EAR with an Install component.

       domainName

       The domain name in which this EAR will be installed

       targetName

       The cluster name or server instance where the EAR will be deployed.

     • To use variable components from another component, click Import Set.

       For more information about importing variable sets, see “How to Run a Plan” in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

6. Select the target host.

7. Deselect the Target Host Set checkbox.

8. If you want to run a detailed check (preflight) before installing, select Perform Detailed Preflight.

9. Click Run Plan (includes preflight).

How to Uninstall a Sun Java Enterprise System Application Server Enterprise Application

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS Application Tasks->Enterprise Applications (EARs) click View All.

3. Click the name of the EAR you want to uninstall.

4. Under Component Procedures click the Run action next to default: uninstall.

5. Select the installation from which you want the EAR removed.

6. Click Run Selected Installations.

7. Click Run Plan (includes preflight).

How to Capture a Sun Java Enterprise System Application Server Web Application

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS Application Tasks->Web Applications (WARs) click Create New.

3. Enter a component directory for this component. The com/sun/sjsas81 namespace is not valid.

4. Enter a label for this component.

5. Enter a description for this component.

6. Enter the host where the WAR file is located.

   To select the host from a list, click Select From List.

7. Navigate to the location of the WAR.

   1. If you know the path to the WAR, enter it in com.sun.sjsas81#WebappCT path.

   2. To browse the selected host, select the directory and click Open Highlighted Item.

8. Select the WAR and click Open Highlighted Item.

9. Click Check In Selected Item.

10. Confirm the information on the check-in page, then click Continue to Check-in.

How to Install a Sun Java Enterprise System Application Server Web Application

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS Application Tasks->Web Applications (WARs) click View All.

3. Click the name of the WAR you want to install.

4. Under Component Procedures click the Run action next to default: install.

5. In the Plan Parameters area, select the variable settings for the WAR you want to install.

   • If the variable settings have been established for this component, select the appropriate settings from the menu.

   • If the settings are not available from the menu, click Select From List.

     The Select Variable Settings From List window displays.

     • To create a new set of variable settings, select Create Set.

       The following list provides commonly-updated variables for the Install component.

       variable set name

       Required. A name for the new variable set you create.

       installIdentifier

       A unique ID to associate the WAR with an Install component.

       domainName

       The domain name in which this WAR will be installed

       targetName

       The cluster name or server instance where the WAR will be deployed.

     • To use variable components from another component, click Import Set.

       For more information about importing variable sets, see “How to Run a Plan” in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

6. Select the target host.

7. Deselect the Target Host Set checkbox.

8. Under Plan Variables set the context root of the web application.

9. If you want to run a detailed check (preflight) before installing, select Perform Detailed Preflight.

10. Click Run Plan (includes preflight).

How to Uninstall a Sun Java Enterprise System Application Server Web Application

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS Application Tasks->Web Applications (WARs) click View All.

3. Click the name of the WAR you want to uninstall.

4. Under Component Procedures click the Run action next to default: uninstall.

5. Select the installation from which you want the WAR removed.

6. Click Run Selected Installations.

7. Click Run Plan (includes preflight).

Managing Sun Java Enterprise System Application Server Resources

This section describes how to manage Sun Java Enterprise System Application Server resources: JMS resources, JDBC resources, and thread pools.

Managing Java Messaging Service (JMS) Resources

How to Install a JMS Resource on a Host

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS AppServer Resources->SJSAS 8.1 JMS Resource click Manage JMS Resources.

3. Under Component Procedures click the Run action next to default: install.

4. In the Plan Parameters area, select the variable settings for the JMS Resource you want to install.

   • If the variable settings have been established for this component, select the appropriate settings from the menu.

   • If the settings are not available from the menu, click Select From List.

     The Select Variable Settings From List window displays.

     • To create a new set of variable settings, select Create Set.

       The following list provides commonly-updated variables for the Install component.

       variable set name

       Required. A name for the new variable set you create.

       installIdentifier

       A unique ID to associate the JMS Resource with an Install component.

       domainName

       The domain name in which this JMS Resource will be located

     • To use variable components from another component, click Import Set.

       For more information about importing variable sets, see “How to Run a Plan” in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

5. Select the target host.

6. Deselect the Target Host Set checkbox.

7. If you want to run a detailed check (preflight) before installing, select Perform Detailed Preflight.

8. Click Run Plan (includes preflight).

How to Create a JMS Resource

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS AppServer Resources->SJSAS 8.1 JMS Resource click Manage JMS Resources.

3. Under Component Procedures click the Run action next to createJMSResource.

4. Select the installation on which you want to create the JMS resource.

5. Under Plan Variables:

   1. Select the resource type. It can be one of:

      • Topic

      • Queue

      • ConnectionFactory

      • TopicConnectionFactory

      • QueueConnectionFactory

   2. Enter the JNDI name for the resource.

   3. Enter the target cluster or server name where the resource will be created.

   4. (Optional) Enter a description of the resource.

   5. Enter any JMS properties, separated by colons (:).

      Valid property names are:

      • ClientId

      • AddressList

      • MessageServiceAddressList

      • UserName

      • Password

      • ReconnectEnabled

      • ReconnectAttempts

      • ReconnectInterval

      • AddressListBehavior

      • AddressListIterations

6. Click Run Plan (includes preflight).

How to Delete a JMS Resource

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS AppServer Resources->SJSAS 8.1 JMS Resource click Manage JMS Resources.

3. Under Component Procedures click the Run action next to deleteJMSResource.

4. Select the installation on which you want to delete the JMS resource.

5. Under Plan Variables:

   1. Enter the JNDI name of the resource you want to delete.

   2. Enter the target name of the resource you want to delete.

6. Click Run Plan (includes preflight).

Managing Java Database Connectivity (JDBC) Resources

How to Install a JDBC Resource on a Host

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS AppServer Resources->SJSAS 8.1 JDBC Resource click Manage JDBC Resources.

3. Under Component Procedures click the Run action next to default: install.

4. In the Plan Parameters area, select the variable settings for the JDBC Resource you want to install.

   • If the variable settings have been established for this component, select the appropriate settings from the menu.

   • If the settings are not available from the menu, click Select From List.

     The Select Variable Settings From List window displays.

     • To create a new set of variable settings, select Create Set.

       The following list provides commonly-updated variables for the Install component.

       variable set name

       Required. A name for the new variable set you create.

       installIdentifier

       A unique ID to associate the JDBC Resource with an Install component.

       domainName

       The domain name in which this JDBC Resource will be located

     • To use variable components from another component, click Import Set.

       For more information about importing variable sets, see “How to Run a Plan” in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

5. Select the target host.

6. Deselect the Target Host Set checkbox.

7. If you want to run a detailed check (preflight) before installing, select Perform Detailed Preflight.

8. Click Run Plan (includes preflight).

How to Create a JDBC Resource

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS AppServer Resources->SJSAS 8.1 JDBC Resource click Manage JDBC Resources.

3. Under Component Procedures click the Run action next to createJDBCResource.

4. Select the installation on which you want to create the JDBC resource.

5. Under Plan Variables:

   1. Set the name of the Connection Pool.

   2. Enter the JNDI name for the resource.

   3. Enter the target cluster or server name where the resource will be created.

   4. (Optional) Enter a description of the resource.

   5. Enter any JDBC properties, separated by colons (:).

6. Click Run Plan (includes preflight).

How to Delete a JDBC Resource

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS AppServer Resources->SJSAS 8.1 JDBC Resource click Manage JDBC Resources.

3. Under Component Procedures click the Run action next to deleteJDBCResource.

4. Select the installation on which you want to delete the JDBC resource.

5. Under Plan Variables:

   1. Enter the JNDI name of the resource you want to delete.

   2. Enter the target cluster or server instance name of the resource you want to delete.

6. Click Run Plan (includes preflight).

How to List JDBC Resources

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS AppServer Resources->SJSAS 8.1 JDBC Resource click Manage JDBC Resources.

3. Under Component Procedures click the Run action next to listJDBCResources.

4. Select the installation on which you want to list the JDBC resources.

5. Under Plan Variables enter the target cluster or server instance name of the resource you want to delete.

6. Click Run Plan (includes preflight).

How to Create a JDBC Connection Pool

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS AppServer Resources->SJSAS 8.1 JDBC Resource click Manage JDBC Resources.

3. Under Component Procedures click the Run action next to createJDBCConnectionPool.

4. Select the installation on which you want to create the connection pool.

5. Under Plan Variables:

   1. Set the name of the Connection Pool.

   2. (Optional) Enter a description of the connection pool.

   3. Enter the JDBC data source resource manager for your connection pool.

   4. Enter the interface the data source class implements.

      Valid entries are:

      • DataSource

      • ConnectionPoolDataSource

      • XADataSource

   5. Enter the minimum number of connections created by the pool.

   6. Enter the maximum number of connections maintained by the pool.

   7. Enter the number of connections to be removed when the time out timer expires.

   8. Enter the maximum number of seconds a connection can be idle in the pool.

   9. Enter the transaction isolation level for the connection pool.

      Valid entries are:

      • read-uncommitted

      • read-committed

      • repeatable-read

      • serializable

      If the entry is blank, the default isolation level of the JDBC driver is used.

   10. Specify whether the connections should be validated before being allocated to an application. Valid entries are true or false.

   11. Enter any attribute name/value pairs for the JDBC driver.

6. Click Run Plan (includes preflight).

How to Delete a JDBC Connection Pool

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS AppServer Resources->SJSAS 8.1 JDBC Resource click Manage JDBC Resources.

3. Under Component Procedures click the Run action next to deleteJDBCConnectionPool.

4. Select the installation on which you want to delete the JDBC resource.

5. Under Plan Variables:

   1. Enter the name of the connection pool you want to delete.

   2. Specify whether all connector resources associated with the connection pool should also be deleted. Valid entries are true or false.

6. Click Run Plan (includes preflight).

How to List JDBC Connection Pools

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS AppServer Resources->SJSAS 8.1 JDBC Resource click Manage JDBC Resources.

3. Under Component Procedures click the Run action next to listJDBCConnectionPools.

4. Select the installation on which you want to list the JDBC resources.

5. Click Run Plan (includes preflight).

Managing Thread Pool Resources

How to Install a Thread Pool Resource on a Host

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS AppServer Resources->SJSAS 8.1 Threadpool Resource click Manage Threadpool Resources.

3. Under Component Procedures click the Run action next to default: install.

4. In the Plan Parameters area, select the variable settings for the Thread Pool Resource you want to install.

   • If the variable settings have been established for this component, select the appropriate settings from the menu.

   • If the settings are not available from the menu, click Select From List.

     The Select Variable Settings From List window displays.

     • To create a new set of variable settings, select Create Set.

       The following list provides commonly-updated variables for the Install component.

       variable set name

       Required. A name for the new variable set you create.

       installIdentifier

       A unique ID to associate the thread pool resource with an Install component.

       domainName

       The domain name in which this thread pool resource will be located

     • To use variable components from another component, click Import Set.

       For more information about importing variable sets, see “How to Run a Plan” in N1 Grid Service Provisioning System 5.0 Operation and Provisioning Guide.

5. Select the target host.

6. Deselect the Target Host Set checkbox.

7. If you want to run a detailed check (preflight) before installing, select Perform Detailed Preflight.

8. Click Run Plan (includes preflight).

How to Create a Thread Pool Resource

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS AppServer Resources->SJSAS 8.1 Threadpool Resource click Manage Threadpool Resources.

3. Under Component Procedures click the Run action next to createThreadpool.

4. Select the installation on which you want to create the connection pool.

5. Under Plan Variables:

   1. Enter the thread pool ID.

   2. Enter the maximum number of threads in the thread pool servicing requests.

   3. Enter the minimum number of threads in the thread pool servicing requests.

   4. Enter the idle time out value, in seconds, after which idle threads will be returned to the pool.

   5. Enter the total number of work queues serviced by the thread pool.

   6. Enter the cluster or server instance name on which the thread pool will be created.

6. Click Run Plan (includes preflight).

How to Delete a Thread Pool Resource

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS AppServer Resources->SJSAS 8.1 Threadpool Resource click Manage Threadpool Resources.

3. Under Component Procedures click the Run action next to deleteThreadpool.

4. Select the installation on which you want to delete the thread pool.

5. Click Run Plan (includes preflight).

How to List Threadpools on a Target

Steps

1. From the Common Tasks section in the browser interface, click Sun Java System AS 8.

2. Under SJSAS AppServer Resources->SJSAS 8.1 Threadpool Resource click Manage Threadpool Resources.

3. Under Component Procedures click the Run action next to listThreadpools.

4. Select the installation on which you want to list the thread pools.

5. Under Plan Variables enter the target cluster or server instance name on which you want to list the thread pools.

6. Click Run Plan (includes preflight).

Troubleshooting

This section describes common problem you might encounter while using the Sun Java Enterprise System Application Server Plug-In.

If You Encounter Errors When Running a Task

If you encounter an error when running a task, double check that you didn't make these common mistakes.

Check Your Variable Names

When you create a variable set used by a plan, it is easy to enter the wrong variable value. For example, you might incorrectly enter a cluster name instead of a domain name.

Unavailable Ports

When entering port ranges in a variable set, check to make sure the ports are available on the target host or host sets.

Component Directory Namespace Problems When Installing Applications

The com.sun.sjsas81 namespace is invalid for user-supplied applications. When you enter a component directory for an application, make sure you change the namespace, as com.sun.sjsas81 is selected by default.

Problems During Installation

If you encounter errors when trying to install plug-in components, make sure the sourceImage variable points to a directory containing a valid install image of Sun Java Enterprise System Application Server.