Editing Java Settings

This section describes the procedures involved in editing Java related settings for a selected configuration. See the following links:

• Editing General Settings

• Editing Path Settings

• Editing JVM Settings

• Editing JVM Options

• Adding JVM Profilers

• Adding a New JVM Profiler

• Debug Java Settings

• Enable JVM Debugging

• Editing Resources Settings

• JDBC Resources

• Common JDBC Drivers

• Adding a JDBC Resource

• Custom Resources

• Adding a Custom Resource

• Properties for Custom Resources

• External JNDI Resources

• Adding an External JNDI Resource

• Properties for External JNDI Resources

• Mail Resources

• Adding a New Mail Resource

• Properties for Mail Resource

• Server Lifecycle

• Adding a New Lifecycle Module

• Deleting a Lifecycle Module

• Editing Lifecycle Modules

• Editing Authentication Settings

• Required Properties for Authentication Realm

• Editing Servlet Container Settings

• Servlet Container Parameters

• Editing Session Replication Settings

• Session Replication Parameters

• Editing SOAP Authentication Settings

• SOAP Authentication Provider Parameters

Editing General Settings

This section lets you enable Java and set Java Home variable for the selected configuration.

Editing General Java Settings

1. Select the Configuration.

   Select the configuration from the configuration list. Click Configuration tab to get the list of available configurations.

2. Click Java > General tab.

Parameters for General Java Settings

The following table describes the parameters available while configuring the general Java settings.

Table 23 Field Description > General Java Settings

Editing Path Settings

This section lets you add JVM class path for the selected configuration.

Editing Path Settings

1. Select the Configuration.

   Select the configuration from the configuration list. Click Configuration tab to get the list of available configurations.

2. Click Java > General tab. Go to Path Settings section.

Parameters for Path Settings

The following table describes the parameters available while modifying the configuration's JVM path settings.

Table 24 Field Description > Path Settings

Editing JVM Settings

To set JVM command-line options in the Administration interface, perform the following tasks:

Editing JVM Settings

1. Select the Configuration.

   Select the configuration from the configuration list. Click Configuration tab to get a list.

2. Click Java > JVM Settings tab.

Editing JVM Options

You can add/delete command line JVM options by specifying the values here. Click Add JVM Option button to add a JVM option.

Some examples for JVM options are:-Djava.security.auth.login.config=login.conf, -Djava.util.logging.manager=com.iplanet.ias.server.logging.ServerLogManager and -Xms128m -Xmx256m

Adding JVM Profilers

JVM Profiler helps you diagnose and resolve performance problems, memory leaks, multi-threading problems and system resource usage problems in your Java applications to ensure the highest level of stability and scalability for your applications.

You can use a profiler to perform remote profiling on the Sun Java System Web Server to discover bottlenecks in server-side performance.

Adding a New JVM Profiler

1. Select the Configuration.

   Select the configuration from the configuration list. Click Configurations tab to get the list of available configuration.

2. Click Java > JVM Settings tab.

3. Click New button under Profilers section.

4. Provide values for the following parameters:

   • Name -- Provide a short name for the new JVM Profiler.

   • Enabled -- Determines if the profiler is enabled at runtime.

   • Class path -- Provide a valid class path for the profiler. (Optional).

   • Native library path -- Provide a valid native library path. (Optional).

   • JVM Options -- You can specify additional JVM options for the CLI.

     For example, --Xrunhprof:file=log.txt,options

     HPROF is a simple profiler agent shipped with Java 2 SE. It is a dynamically linked library that interacts with the JVMPI (Java Virtual Machine Profiler Interface) and writes out profiling information either to a file or to a socket in ASCII or binary format. This information can be further processed by a profiler front-end tool.

     For more information on various commercial profilers, and their options, see Sun Java System Web Server 7.0 Developer's Guide to Java Web Applications.

Debug Java Settings

The JVM can be started in debug mode and can be attached with a JPDA (Java Platform Debugger Architecture) debugger. When you enable debugging, you enable both local and remote debugging.

Sun Java System Web Server's debugging is based on the JPDA software. To enable debugging, perform the following tasks.

Enable JVM Debugging

1. Select the Configuration.

   Select the configuration from the configuration list. Click Configurations tab to get the list of available configuration.

2. Click Java > JVM Settings tab.

3. Select Enable Debug checkbox under Debug Java Settings.

4. Provide JVM options as necessary by clicking the New button.

   The default JPDA options are as follows:

   -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=7.0896

   
   

   If you substitute suspend=y, the JVM starts in suspended mode and stays suspended until a debugger attaches to it. This is helpful if you want to start debugging as soon as the JVM starts. To specify the port to use when attaching the JVM to a debugger, specify address=port_number. Check out the JPDA documentation for a list of debugging options.

Editing Resources Settings

This page lets you configure and manage JDBC, Mail, JNDI and other Java based resources.

Web applications may access a wide variety of resources such as resource managers, data sources (for example SQL datasources), mail sessions, and URL connection factories. The J2EE platform exposes such resources to the applications via Java Naming and Directory Interface (JNDI) service.

Sun Java System Web Server allows you to create and manage the following JavaEE resources:

• JDBC Datasources.

• JDBC Connection Pools.

• Java Mail Sessions.

• Custom Resources.

• External JNDI Resources.

JDBC Resources

A JDBC Datasource is a Java EE resource that you can create and manage using Sun Java System Web Server.

The JDBC API is the API for connectivity with relational database systems. The JDBC API has two parts:

• An application-level interface used by the application components to access databases.

• A service provider interface to attach a JDBC driver to the Java EE platform.

A JDBC Datasource object is an implementation of a data source in the Java programming language. In basic terms, a data source is a facility for storing data. It can be as sophisticated as a complex database for a large corporation or as simple as a file with rows and columns. A JDBC datasource is a Java EE resource that can be created and managed via Sun Java System Web Server.

The JDBC API provides a set of classes for Java with a standard SQL database access interface to ensure uniform access to a wide range of relational databases.

Using JDBC, SQL statements can be sent to virtually any database management system (DBMS). It is used as an interface for both relational and object DBMSs.

Common JDBC Drivers

The following table provides a list of common JDBC drivers and their properties that needs to be configured while adding a new JDBC resource. See Adding a JDBC Resource.

Note - The following list is only a subset of all supported JDBC Drivers.

Table 25 List of common and supported JDBC drivers

Adding a JDBC Resource

1. Select the configuration.

   Select the configuration from the configuration list. Click Configurations tab to get the list.

2. Click Java > Resources tab.

3. Under JDBC Resources section, click New button.

4. Select the Driver Vendor.

   Specify a unique value for the JNDI name and select the JDBC driver vendor from the available list.

5. Provide JDBC Resource Properties.

   Based on the JDBC driver vendor selection in the previous step, the class name for the driver and the JDBC resource properties are automatically populated. For a list of suggested properties for some common JDBC drivers, see Common JDBC Drivers.

6. View Summary.

   View the summary and Click Finish to create the new JDBC resource.

Custom Resources

You can use this option to register a custom resource with the instance of the configuration.

Adding a Custom Resource

1. Select the configuration.

   Select the configuration from the configuration list. Click Configurations tab to get the list.

2. Click Java > Resources tab.

3. Under Custom Resources section, click New button.

Properties for Custom Resources

The following table describes the properties available for creating a custom resource.

Table 26 Field Description > Custom Resources

External JNDI Resources

This option lets you create an external Java Naming and Directory Interface (JNDI) resource. You need an external JNDI resource to access resources stored in an internal JNDI repository.

Adding an External JNDI Resource

1. Select the configuration.

   Select the configuration from the configuration list. Click Configurations tab to get the list.

2. Click Java > Resources tab.

3. Under External JNDI Resources section, click New button.

Properties for External JNDI Resources

The following table describes the properties available while adding a new external JNDI resource.

Table 27 Field Description > External JNDI Resources

Mail Resources

JMS destinations are Java EE resources that can be created and managed via Sun Java System Web Server.

Many internet applications require the ability to send email notifications, so the Java EE platform includes the JavaMail API along with a JavaMail service provider that allows an application component to send internet mail.

Adding a New Mail Resource

1. Select the Configuration.

   Select the configuration from the configuration list. Click Configurations tab to get the list.

2. Click Java > Resources tab.

3. Under Mail Resources section, click New button.

Properties for Mail Resource

The following table describes the properties available while adding a new mail resource.

Table 28 Field Description > Mail Resource Properties

Server Lifecycle

• init -- This phase includes reading configuration, initializing built-in subsystems; naming, security and logging services; and creating the web container.

• startup -- This phase includes loading and initializing deployed applications

• service -- The server is ready to service requests

• shutdown -- This phase stops and destroys loaded applications. The system is preparing to shutdown.

• termination -- This phase terminates the built-in subsystems and server runtime environment. There won't be any more activity after this phase.

• reconfig -- The transient server state in which a server thread is dynamically reconfiguring (while the server is in the service state). This phase can occur several times during the life of the server.

Adding a New Lifecycle Module

1. Select the Configuration.

   Select the configuration, from the configuration list. For viewing the list of configuration, click Configuration tab.

2. Click Java > Lifecycle Modules tab.

3. Click New button.

   Provide values for the following parameters:

   • Name -- Provide a valid unique name for the new lifecycle module.

   • Enabled -- If you want to enable this lifecycle module, use this option.

   • Class Name -- Fully qualified Java class name. The class should implement LifecycleListener interface. For more information on using this interface, refer to the Developer's Guide.

   • Class Path -- Optional. You can specify a class path for the listener class.

   • Load Order -- > 100. Order of loading the lifecycle event listeners, in the numerical order. It is recommended to choose a load-order that is greater than or equal to 100 to avoid conflicts with internal lifecycle modules.

   • On Load Failure -- If this option is enabled, the server does not treat exceptions thrown from the listener classes as fatal thus it continues with the normal startup. Disabled by default.

   • Description -- Provide a short description about the lifecycle module.

   • Properties -- Properties can be used to pass arguments to a Java Lifecycle Module. For adding a new property, click Add Property button and enter text for name, value and description.

   ---

   Caution - The server lifecycle listener classes are invoked synchronously from the main server thread and hence extra precaution must be taken to ensure that the listener classes don't block the server. The listener classes may create threads if appropriate but they must be stopped during the shutdown/termination phases.

   ---

Deleting a Lifecycle Module

1. Select the Configuration.

   Select the configuration, from the configuration list. For viewing the list of configuration, click Configuration tab.

2. Click Java > Lifecycle Modules tab.

3. Select the lifecycle module and click Delete Lifecycle Module button.

Editing Lifecycle Modules

Java Server Lifecycle Modules are Java classes that listen for server lifecycle events in order to perform certain tasks whenever server events like start or stop occur.

The server supports running short or long duration Java based tasks within the web server environment. These tasks get automatically initiated upon server startup and be notified upon server shutdown. So now you can hook up tasks like instantiating singletons, RMI servers, etc.

A brief description of the server's lifecycle is given below:

Editing Authentication Settings

From this page, you can add and delete authentication realms. The Java EE based security model provides for security realms that identify and authenticate users.

The authentication process verifies users through Java Realm. A realm consists of a set of users, optional group mappings, and authentication logic that can validate authentication requests. Once an authentication request is validated by a configured realm and the security context established, this identity is applied to all subsequent authorization decisions.

The Java Realms are analogous to the auth-dbs (Authentication Databases) with the difference that while auth-dbs are used by the ACL engine (based on rules in your ACL file), the Java Realms are used by the Java Servlet access control rules (specified in each web application's web.xml).

A server instance may have any number of configured realms. The configuration information is present in the auth-realm element in the server.xml file.

The following table defines the different types of realms supported in Sun Java System Web Server 7.0

Table 29 Types of Realms

The following section describes the steps involved in adding a new authentication realm.

Adding a Authentication Realm

1. Select the configuration.

   Select the configuration for which you need to add a new authentication realm. Click Configurations tab and select the configuration.

2. Click Java > Authentication tab.

3. Click New under Servlet Authentication.

4. Provide Realm Details.

   • Name -- Enter a short name for the realm. This name is used to refer to the realm from, for example, web.xml.

   • Class -- If you are configuring a custom realm, enter the full Java class name, which implements your custom realm. There is no need to enter a class for any of the built-in realms.

   • Type -- Select the type of realm. See Table 29

   • Properties -- Add realm specific properties. For instance property name="file" value="instance_dir/config/keyfile" and property name="jaas-context" value="fileRealm.

Required Properties for Authentication Realm

Each authentication realm needs required properties to be added. Some required properties are listed in the following table:

Table 30 Required Properties for Authentication Realm

Editing Servlet Container Settings

This section describes the procedure for configuring the servlet container.

Editing Servlet Container Settings

1. Select the configuration.

   Select the configuration from the configuration list. Click Configurations tab to get the list.

2. Click Java > Servlet Container.

Servlet Container Parameters

The following table describes the parameters available servlet container page.

Table 31 Field Description > Servlet Container

Editing Session Replication Settings

This section describes the procedure for setting up session replication properties for a selected configuration.

Editing Session Replication Settings

1. Select the configuration.

   Select the configuration from the configuration list. Click Configurations tab to get the list.

2. Click Java > Session Replication.

Session Replication Parameters

The following table describes the parameters available session replication page.

Table 32 Field Description > Session Replication

Editing SOAP Authentication Settings

Java Authentication Service Provider Interface for Containers specification defines a standard service provider interface by which authentication mechanism providers may be integrated with containers. You can use the Administration Console to add a new SOAP authentication provider.

Adding a SOAP Authentication Provider

1. Select the configuration.

   Select the configuration from the configuration list. Click Configurations tab to get the list.

2. Click Java > Authentication tab.

3. Under SOAP Authentication section, click New button.

SOAP Authentication Provider Parameters

The following table describes the parameters available new SOAP authentication provider page.

Table 33 Field Description > SOAP Authentication Provider