Service Registry 3 2005Q4 Administration Guide

Configuring Service Registry

The Sun Java Enterprise System 2005Q4 Installation Guide for UNIX describes how to perform post-install configuration of Service Registry using default property settings for the Registry. To use custom property settings, edit the file ServiceRegistry-base/install/install.properties before you perform the configuration.

The ServiceRegistry-base location is /opt/SUNWsoar in the Solaris operating environment and /opt/sun/SUNWsoar on Linux systems.


Note –

Before you configure Service Registry, you must first install and configure Sun Java System Application Server (“Application Server”). The configuration process for Service Registry installs the Registry into an Application Server domain.

It is recommended that you install Application Server in its default location. If you installed Application Server in a non-default location, follow the instructions in Configuring Service Registry for a Non-Default Application Server Installation before you configure Service Registry.


The install.properties file contains a set of modifiable property settings. The properties that are listed in Table 1–1 are used by the installation process. Each property name has the prefix registry.install. (terminating in a period). Most of these properties set non-default ports for the Application Server domain created for the Registry.

Table 1–1 Service Registry Installation Properties

Property Name 

Description 

Default Property Value 

DomainName

Application Server domain name 

registry

ServerInstancePort

Application Server HTTP port.  

6060

ServerInstanceSecurePort

Application Server HTTPS port.  

6443

ServerJMSPort

Application Server Message Queue port 

6484

ServerIIOPPort

Application Server IIOP port 

6485

ServerIIOPSecurePort

Application Server IIOP secure port 

6486

ServerIIOPMutualAuthPort

Application Server IIOP mutual authentication port 

6487

AdministrationJMXPort

Application Server JMX port 

6488

AdministrationPort

Application Server Administrative Server port 

6489

AdministratorUserID

User name used to access Application Server Administrative Server 

admin

AdministratorPassword

Password used to access Application Server Administrative Server 

12345678

ApplicationServerKeystorePassword

Password used to access Application Server keystore 

12345678

RegistryServerKeystorePassword

Password used to access Service Registry keystore 

12345678

ProcedureTo Configure Service Registry After a Configure Later Installation Using Custom Properties

Before You Begin

To configure the Registry, you must be logged in as root or become superuser.

Steps
  1. Change to the ServiceRegistry-base/install directory.

  2. Edit the modifiable properties in the file install.properties.

    For security reasons, it is recommended that you not edit this file to change the password values. Instead, specify these values on the command line.

  3. After editing the file, run the following command (all on one line):

    On Solaris: /usr/sfw/bin/ant -f build-install.xml install

    On Linux: /opt/sun/bin/ant --noconfig -f build-install.xml install

    The ant command requires the JAVA_HOME environment variable to be set. Ordinarily, you set this variable to the following value:

    /usr/jdk/entsys-j2se

    To specify changed passwords on the command line, specify the following options to the command (all on one line):


    /usr/sfw/bin/ant -f build-install.xml
    -Dregistry.install.RegistryServerKeystorePassword=passwd1
    -Dregistry.install.AdministratorPassword=passwd2
    -Dregistry.install.ApplicationServerKeystorePassword=passwd3 install
    

    The Registry configuration process creates an Application Server domain at RegistryDomain-base/domains/${registry.install.DomainName}. The default domain name is registry. The configuration process then starts the domain, deploys the Registry, and leaves the domain running.

    The Registry configuration process installs the Registry database and server keystore in the directory RegistryDomain-base/3.0. This directory is not removed when the Registry is uninstalled, so that the database can be preserved for use in a future release. The administrator has control over when and whether to remove this directory.

    The RegistryDomain-base location is /var/opt/SUNWsoar in the Solaris operating environment and /var/opt/sun/SUNWsoar on Linux systems.

  4. Review the output of the ant install command for any errors.

    If there are no errors, you can now begin using the Web Console or the Admin Tool.

ProcedureTo Enable Use of the Administration Tool

To perform Admin Tool tasks that are restricted to users with the role of administrator, you need to work around a bug by adding a JAR file to the Admin Tool manifest classpath.

Steps
  1. Make sure you are still in the ServiceRegistry-base/install directory.

  2. Copy the file soapprocessor.jar from the deployed Registry to the Registry lib directory. Execute the following command (all on one line):


    cp 
    RegistryDomain-base/domains/registry/applications/j2ee-modules/soar/WEB-INF/lib/soapprocessor.jar 
    ../lib
    
  3. Run the admin.jar.manifest.fix installation target as follows:

    On Solaris: /usr/sfw/bin/ant -f build-install.xml admin.jar.manifest.fix

    On Linux: /opt/sun/bin/ant --noconfig -f build-install.xml admin.jar.manifest.fix

Administering the Application Server Domain for Service Registry

The configuration process for Service Registry by default creates an Application Server domain named registry, to which the Service Registry web application is deployed. This domain is in the RegistryDomain-base/domains/registry directory.

This location is different from the default location for Application Server domains, /var/opt/SUNWappserver/domains (Solaris) or /var/opt/sun/appserver/domains (Linux).

To administer the registry domain, you can use the Application Server Administration Console (“Admin Console”). You can use the Admin Console to start and stop the domain, view the server log, and perform other administrative tasks. See To Use the Application Server Admin Console for details.

You can also examine the server log directly. The log is in the file RegistryDomain-base/domains/registry/logs/server.log.

You can also use the asadmin command to administer the registry domain. Because the domain is not in the default location, you must specify the --domaindir option when you use asadmin commands that provide that option.

The password file for the registry domain is ServiceRegistry-base/pw.txt. Specify this password file as the argument to the --passwordfile option of asadmin commands when you administer the registry domain.

The registry domain uses a set of non-default ports so as not to cause conflicts with the default Application Server domain, domain1. Table 1–2 lists and describes these ports. For more information, see Ports in the Application Server in Sun Java System Application Server Enterprise Edition 8.1 2005Q2 Administration Guide.

Table 1–2 Service Registry Domain Default Ports

Port Value 

Description 

6060 

HTTP port 

6443 

HTTPS over SSL 

6484 

Message Queue port 

6485 

IIOP port 

6486 

IIOP SSL port 

6487 

IIOP Mutual Authentication port 

6488 

JMX port 

6489 

Application Server domain administration port 

ProcedureTo Use the Application Server Admin Console

Steps
  1. In a web browser, go to the URL https://hostname:6489/.

    hostname is the system on which Application Server and Service Registry are running.

  2. Accept the certificate that is offered.

    A login page appears

  3. On the login page, type admin in the User Name field.

  4. Type the Application Server administrator password in the Password field. Use the value that you specified for the AdministratorPassword property when you configured the Registry. The default is 12345678.

  5. Click Log In.

See Also

For details on using the Admin Console, refer to the online help for the Admin Console or to the Sun Java System Application Server Enterprise Edition 8.1 2005Q2 Administration Guide.

To change the logging level for Service Registry, follow the instructions in To configure log levels in Sun Java System Application Server Enterprise Edition 8.1 2005Q2 Administration Guide. The property to specify in the Additional Properties area is org.apache.commons.logging.simplelog.log.org.freebxml.omar.

ProcedureTo Stop and Restart the Application Server Domain for the Registry

The configuration process for the Registry starts the Application Server domain in which the registry is deployed. After you perform certain administrative tasks, you need to stop and restart the domain. Examples of such tasks are Allowing Access to External Web Sites and Creating an Administrator.

The Admin Console informs you if you need to restart the domain. You can use the Admin Console to perform this task. If you are using the asadmin command, you can use Ant tasks to stop and start the domain.

Steps
  1. Change to the Service Registry install directory.

    cd ServiceRegistry-base/install

  2. Run the following command (all on one line):

    Solaris: /usr/sfw/bin/ant -f build-install.xml appserver.domain.bounce

    Linux: /opt/sun/bin/ant --noconfig -f build-install.xml appserver.domain.bounce

    This target stops the domain and then restarts it.

    The build-install.xml file also contains separate Ant targets for stopping and starting the Registry domain. To stop the domain, use the Ant target appserver.domain.stop. To start the domain, use the Ant target appserver.domain.start.

ProcedureTo Add Root Certificates to the Trusted Certificates in the Registry Domain

This task extends the list of trusted certificates in the Application Server registry domain.

Perform this task only if you use a third-party certificate and the root Certificate Authority (CA) certificate for the third party is not already in the Application Server truststore. Do not perform this task if you use only registry-issued certificates.

Steps
  1. Download any root certificates that you want to support. Sites that provide root certificates include the following:

  2. If necessary, use the unzip command to extract .cer files from the downloaded archive.


    Note –

    Some files have the suffix .der.


  3. Copy the .cer files to the directory ServiceRegistry-base/install/cacerts.

  4. Change to the directory ServiceRegistry-base/install.

  5. Run the following command (all on one line):

    Solaris: /usr/sfw/bin/ant -f build-install.xml install.cacerts

    Linux: /opt/sun/bin/ant --noconfig -f build-install.xml install.cacerts

    This command installs any certificates found in the directory ServiceRegistry-base/install/cacerts into the Application Server domain truststore.

    You can use the list.cacerts target to make sure that the certificates have been installed correctly.

  6. Follow the instructions in To Stop and Restart the Application Server Domain for the Registry.

Configuring Service Registry for a Non-Default Application Server Installation

The default location for installing Application Server is /opt/SUNWappserver/appserver in the Solaris operating environment and /opt/sun/appserver on Linux systems. If you installed Application Server in a different location, you must edit the file install.properties before you configure Service Registry.

ProcedureTo Edit the install.properties File

Steps
  1. In the ServiceRegistry-base/install directory, open the file install.properties in a text editor.

  2. Find the commented-out definition of the property appserver.root.dir.

  3. Remove the comment character (#) and replace the property definition with the actual location of Application Server.

  4. Save and close the install.properties file.

Next Steps

Continue with the instructions in Configuring Service Registry.

Configuring Service Registry for a Non-Default Service Registry Installation

The default location for installing Service Registry is /opt/SUNWsoar in the Solaris operating environment and /opt/sun/SUNWsoar on Linux systems. If you installed Service Registry in a different location, you must edit the file install.properties before you configure Service Registry.

ProcedureTo Edit the install.properties File

Steps
  1. In the ServiceRegistry-base/install directory, open the file install.properties in a text editor.

  2. Find the commented-out definition of the properties soar.sdk.home and soar.server.home.

  3. For each property, remove the comment character (#) and replace the property definition with the actual location of Service Registry.

  4. Save and close the install.properties file.

Next Steps

Continue with the instructions in Configuring Service Registry.