Sun OpenSSO Enterprise Policy Agent 3.0 Guide for Oracle WebLogic Server/Portal 10

Post-Installation Tasks for the WebLogic Server/Portal 10 Agent on WebLogic Portal 10

The post-installation tasks are similar to configuring the agent on WebLogic Server 10, with the exceptions noted in the following tables.

Table 5 Required Post-Installation Tasks for the WebLogic Server/Portal 10 Agent on WebLogic Portal 10

Required Post-Installation Task 

Where to go for Information 

Configuring the Agent classpath and Java Options

Different for WebLogic Portal 10. 

See WebLogic Portal 10: Configuring the Agent classpath and Java Options.

Configuring the Agent Authentication Provider 

Different for WebLogic Portal 10. 

See WebLogic Portal 10: Configuring the Agent Authentication Provider.

Adding a WebLogic Administrator to the Bypass List 

Same as for WebLogic Server 10. 

See Adding a WebLogic Administrator to the Bypass List for the WebLogic Server/Portal 10 Agent.

Configuring the Agent Filter Modes 

Different for WebLogic Portal 10. 

See WebLogic Portal 10: Configuring the Agent Filter Modes.

Setting Logout-Related Properties for the Sample Portal 

Applies only to WebLogic Portal 10. 

See WebLogic Portal 10: Setting Logout-Related Properties for the Sample Portal.

Deploying the Agent Application 

Same as for WebLogic Server 10. 

See Deploying the Agent Application.

Table 6 Optional Post-Installation Tasks for the WebLogic Server/Portal 10 Agent on WebLogic Portal 10

Optional Post-Installation Task 

Where to go for Information 

Changing the Password for an Agent Profile 

Same as for WebLogic Server 10. 

See Changing the Password for an Agent Profile.

Creating the Necessary URL Policies 

Same as for WebLogic Server 10. 

See Creating the Necessary URL Policies.

Deploying the Policy Agent Sample Application 

Same as for WebLogic Server 10. 

See Deploying the Policy Agent Sample Application.

Mapping OpenSSO Enterprise Roles to Principal Names 

Same as for WebLogic Server 10. 

See Mapping OpenSSO Enterprise Roles to Principal Names.

WebLogic Portal 10: Configuring the Agent classpath and Java Options

ProcedureTo Configure the WebLogic Portal 10 Instance With the Agent classpath and Java Options

  1. Using a text editor, edit the following WebLogic Portal 10 startup script, depending on your platform:

    • Solaris and Linux systems: DeployContainer-base/wlserver_10.0/samples/domains/portal/bin/startWeblogic.sh

    • Windows systems: DeployContainer-base\wlserver_10.0\samples\domains\portal\bin\startWeblogic.cmd

    DeployContainer-base represents the directory where the WebLogic Portal 10 instance is installed.

  2. Add the path of the agent environment variable script to the WebLogic Portal 10 startup script:

    • Solaris and Linux systems: After the line, . ${DOMAIN_HOME}/bin/setDomainEnv.sh $*, add:


      . DeployContainer-base/samples/domains/portal/setAgentEnv_${SERVER_NAME}.sh

      Therefore, the startup script would then contain these two lines:


      . ${DOMAIN_HOME}/bin/setDomainEnv.sh $*
      . DeployContainer-base/samples/domains/portal/setAgentEnv_${SERVER_NAME}.sh
    • Windows systems: After the line, call "%DOMAIN_HOME%\bin\setDomainEnv.cmd" %*, add:

      call DeployContainer-base\wlserver_10.0\samples\domains\portal\setAgentEnv_%SERVER_NAME%.cmd

      Therefore, the startup script would then contain these two lines:

      call "%DOMAIN_HOME%\bin\setDomainEnv.cmd" %*
      call DeployContainer-base\wlserver_10.0\samples\domains\portal\setAgentEnv_%SERVER_NAME%.cmd

    The ${SERVER_NAME} or %SERVER_NAME% variable represents the WebLogic Portal 10 instance that is dynamically replaced.

  3. Restart the WebLogic Portal 10 instance.

WebLogic Portal 10: Configuring the Agent Authentication Provider

This section applies only to WebLogic Portal 10.

ProcedureTo Configure the Agent Authentication Provider for WebLogic Portal 10

  1. Log in to the WebLogic Portal 10 Administration Console.

  2. In the left pane, under Domain Structure and the host name of the server you are configuring, click Security realm.

  3. In the right pane, click the name of the realm you are configuring.

  4. Click Providers.

  5. Click the Authentication tab.

  6. In the left pane, click Lock & Edit.

  7. In the right pane, click New.

  8. Specify Type as AgentAuthenticator.

  9. Specify Name with a name of your choice.

  10. Click OK.

  11. Click the newly created policy agent authentication provider.

  12. Change the control flag value to OPTIONAL.

  13. Click Save.

  14. Click Providers.

    The console displays the Authentication Providers Table .

  15. Click SQLAuthenticator

  16. Change the control flag to OPTIONAL.

  17. Click Save.

  18. Click the Providers tab.

  19. Click SAMLAuthenticator

  20. Change the control flag to OPTIONAL.

  21. Click Save.

  22. In the left pane, click Activate changes.

  23. After you are finished, restart the server for the changes to take effect.

Default Security Realm

If create a new security realm instead of using the default security realm to configure the agent, ensure that the control flag value for the Agent Authenticator and any additional authentication providers are set to OPTIONAL.

WebLogic Portal 10: Configuring the Agent Filter Modes

Configuring the agent filter modes for WebLogic Portal 10 agent is different than for the WebLogic Server 10 agent because the following filter modes do not apply to WebLogic Portal 10:

To set the filter modes for the WebLogic Server/Portal 10 agent, use one of these methods:


Note –

When creating a OpenSSO Enterprise policy to protect the WebLogic Portal 10 instance, define the policy to give permission to only public portal URLs. For example:

http://agent.example.com:7041/groupspace/
http://agent.example.com:7041/groupspace/groupspace.jsp

WebLogic Portal 10: Installing the Agent Filter for the Deployed Application

This section use the sample portal (groupspace) as the application whose deployment descriptor is modified. For example, the web.xml file for the sample portal is in the following location:

/usr/local/bea/wlserver_10.0/samples/portal/portalApp/groupspaceSampleWeb/WEB-INF

ProcedureTo Install the Agent Filter for the Deployed Application for WebLogic Portal 10

  1. Edit the application's web.xml descriptor by adding the <filter> elements.

    Add the <filter>, <filter-mapping>, and <dispatcher> elements as the first filter element in the web.xml descriptor. For example:


    <web-app>
    ...
        <filter>
            <filter-name>Agent</filter-name>
            <filter-class>com.sun.identity.agents.filter.AmAgentFilter</filter-class>
        </filter>
        <filter-mapping>
            <filter-name>Agent</filter-name>
            <url-pattern>/*</url-pattern>
            <dispatcher>REQUEST</dispatcher>
            <dispatcher>INCLUDE</dispatcher>
            <dispatcher>FORWARD</dispatcher>
            <dispatcher>ERROR</dispatcher>
        </filter-mapping>
    ...
    </web-app>

    Important: Make sure that this filter element is the first element in the descriptor.

WebLogic Portal 10: Setting Logout-Related Properties for the Sample Portal

This task involves configuring logout-related properties for the sample portal (groupspace), using either the either in the OpenSSO Enterprise Console or the ssoadm utility.

To set the logout-related properties in the OpenSSO Enterprise Console:

  1. Login to the Console as amadmin.

  2. Under Access Control, realm-name, Agents, and J2EE, click the name of the agent profile you want to update.

    The Console displays the Edit page for the agent profile.

  3. Click Application and then Logout Processing. then set the following fields, depending on your requirements:

    • Logout Application Handler: An application-specific map that identifies a handler to be used for logout processing. The corresponding property is com.sun.identity.agents.config.logout.application.handler.

    • Logout Application URI: An application-specific map that identifies a request URI that indicates a logout event. The corresponding property is com.sun.identity.agents.config.logout.uri.

    • Logout Request Parameter: An application-specific map that identifies a parameter that when present in the HTTP request indicates a logout event. The corresponding property is com.sun.identity.agents.config.logout.request.param.

    • Logout Introspect Enabled: Check Enabled to allow the agent to search an HTTP request body to locate the logout parameter. The corresponding property is com.sun.identity.agents.config.logout.introspect.enabled.

    • Logout Entry URI: An application-specific map that identifies a URI to be used as an entry point after a successful logout and subsequent successful authentication if applicable. The corresponding property is com.sun.identity.agents.config.logout.entry.uri.

  4. Click Save.

To use the ssoadm utility, set the logout-related agent properties. For example:

com.sun.identity.agents.config.logout.application.handler[] = 
com.sun.identity.agents.config.logout.uri[groupspace] = /groupspace/communityFiles/shell/logout.jsp
com.sun.identity.agents.config.logout.request.param[groupspace] = logout
com.sun.identity.agents.config.logout.introspect.enabled = true
com.sun.identity.agents.config.logout.entry.uri[groupspace] = /groupspace/groupspace.jsp

All of these logout-related properties are hot-swappable.