4 Configuring and Administering Partner Applications

Syntax and Parameters for ossoreg.jar

Use the ossoreg.jar tool to register an application. Run the following command:

$ORACLE_HOME/jdk/bin/java -jar $ORACLE_HOME/sso/lib/ossoreg.jar
-oracle_home_path orcl_home_path
-site_name site_name
-config_mod_osso TRUE
-mod_osso_url mod_osso_url
-u userid
[-virtualhost]
[-update_mode CREATE | DELETE | MODIFY]
[-config_file config_file_path]
[-admin_info admin_info]
[-admin_id adminid]

A description of the parameters passed to the tool follows.

oracle_home_path

Absolute path to the Oracle home.

site_name

Name of the site—typically, the effective host name and port of the partner application. For example, application.mydomain.com.

config_mod_osso

If set to TRUE, this parameter indicates that the application being registered is mod_osso. You must include config_mod_osso for osso.conf to be generated.

mod_osso_url

The effective URL of the partner application. This is the URL that is used to access the partner application. The value should be specified in this URL format:

http://oracle_http_host.domain:port

For example:

http://application.mydomain.com:7777

Omit the port number if the partner Oracle HTTP Server is listening on the default HTTP port of 80 or on the default HTTPS port of 443.

u

The user name that will start the Oracle HTTP Server. In UNIX, this name is usually "root." On Windows NT/2000, it is SYSTEM. The parameter u is mandatory.

virtualhost

Optional. Include this parameter only if you are registering an Oracle HTTP virtual host with the single sign-on server. Omit the parameter if you are not registering a virtual host.

If you are creating an HTTP virtual host, use the httpd.conf file to fill in the following directive for each protected URL:

<VirtualHost host_name>
  OssoConfigFile $ORACLE_HOME/Apache/Apache/conf/osso/host_name/osso.conf
  OssoIpCheck off
  #<Location /your_protected_url>
  #  AuthType basic
  #  Require valid-user
  #</Location>
  #Other configuration information for the virtual host
</VirtualHost>

If, on the other hand, you are creating an HTTPS virtual host, use the ssl.conf file to fill in the same directive. Note that the commented lines must be uncommented before the application is deployed. Both httpd.conf and ssl.conf are in $ORACLE_HOME/Apache/Apache/conf.

After creating a virtual host, run this command to update the Distributed Cluster Management schema:

$ORACLE_HOME/dcm/bin/dcmctl updateConfig -v -d

config_file

Location of the osso.conf file for the virtual host if one is being configured. It may, for example, be $ORACLE_HOME/Apache/Apache/conf/osso/virtual_host_name/osso.conf.

This parameter is mandatory if you are registering a virtual host. If you omit config_file, the assumption is that you are registering a nonvirtual host. In this case, ossoreg.jar creates a file with the name osso.conf in $ORACLE_HOME/Apache/Apache/conf/osso.

update_mode

Optional. Creates, deletes, or modifies the partner registration record. CREATE, the default, generates a new record. DELETE removes the existing record. MODIFY deletes the existing record and then creates a new one.

admin_info

Optional. User name of the mod_osso administrator. If you omit this parameter, the Administrator Information field on the Edit Partner Application page is left blank.

admin_id

Optional. Any additional information, such as e-mail address, about the administrator. If you omit this parameter, the Administrator E-mail field on the Edit Partner Application page is left blank.

Command Example

This command sequence shows a mod_osso instance being reregistered with the single sign-on server:

• UNIX:

  setenv $ORACLE_HOME /private/oracle/gitm1
  
  setenv LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:$ORACLE_HOME/lib
  
  $ORACLE_HOME/jdk/bin/java -jar $ORACLE_HOME/sso/lib/ossoreg.jar     
  -oracle_home_path $ORACLE_HOME
  -site_name portal.mydomain.com
  -config_mod_osso TRUE
  -mod_osso_url http://portal.mydomain.com
  -u root
  
  

• Windows NT/2000:

  set ORACLE_HOME=c:\private\oracle\gitml
  
  set PATH=%PATH%;%ORACLE_HOME%\bin;%ORACLE_HOME%\lib
  
  %ORACLE_HOME%\jdk\bin\java -jar %ORACLE_HOME%\sso\lib\ossoreg.jar
  -oracle_home_path %ORACLE_HOME%
  -site_name portal.mydomain.com
  -config_mod_osso TRUE
  -mod_osso_url http://portal.mydomain.com
  -u SYSTEM
  

Restarting the Oracle HTTP Server

After running ossoreg.jar, restart the Oracle HTTP Server. For instructions, see "Stopping and Starting the Oracle HTTP Server" in Chapter 2.

Usage Scenario

This scenario assumes the following hypothetical configurations:

• There are two partner application computers: pa1.mydomain.com and pa2.mydomain.com. Both application servers listen on non-SSL port 7777.

• The partner application computers are configured to use the single sign-on server located at sso.mydomain.com.

• The effective host name of the partner application published to users is pa.mydomain.com. An HTTP load balancer is configured to listen at this address, on port 80. It load balances and fails over user requests between pa1.mydomain.com and pa2.mydomain.com.

• The single sign-on server, directory server, and identity management infrastructure database are located at sso.mydomain.com.

  
  

  Notes: In this scenario, the load balancer is listening on port 80, a non-SSL port number. If the load balancer is configured to use SSL to interact with the browser, a different port number must be selected. The default SSL port number is 443. In this scenario, two partner application computers are shown. There can, in fact, be any number of them.

  
  

Figure 4-1 shows what this hypothetical system looks like.

Figure 4-1 Load Balancer with Multiple Partner Applications

Description of the illustration ssoag034.gif

Configuration Steps

Setting up the system presented in Figure 4–1 involves the following tasks:

• Installing the Partner Applications

• Configuring the Oracle HTTP Servers on the Partner Application Middle Tiers

• Configuring the HTTP Load Balancer

• Reregistering mod_osso on the Partner Application Middle Tiers

$ORACLE_HOME/jdk/bin/java -jar $ORACLE_HOME/sso/lib/ossoreg.jar
-oracle_home_path orcl_home_path
-site_name site_name
-config_mod_osso TRUE
-mod_osso_url mod_osso_url
-u userid
[-virtualhost]
[-update_mode CREATE | DELETE | MODIFY]
[-config_file config_file_path]
[-admin_id adminid]
[-admin_info admin_info]

$ORACLE_HOME/dcm/bin/dcmctl updateConfig -v -d