12 Managing Portlet Producers

12.2.1 Registering a WSRP Producer Using Fusion Middleware Control

To register a WSRP portlet producer:

1. Login to Fusion Middleware Control and navigate to the home page for your custom WebCenter application (or WebCenter Spaces):

   • Section 6.3, "Navigating to the Home Page for Custom WebCenter Applications".

   • Section 6.2, "Navigating to the Home Page for WebCenter Spaces"

2. Do one of the following:

   • For custom WebCenter applications - From the Application Deployment menu, choose WebCenter > Register Producer

   • For WebCenter Spaces - From the WebCenter menu, choose Register Producer.

3. In the Add Portlet Producer Connection section, enter connection details for the WSRP producer.

   For detailed parameter information, see Table 12-1, "WSRP Producer Connection Parameters".

   Table 12-1 WSRP Producer Connection Parameters

   Field	Description
   Connection Name	Enter a unique name that will identify this portlet producer registration within the WebCenter application. The name must be unique across all WebCenter connection types. The name you specify here will appear in the Oracle Composer (under the Portlets folder).
   Producer Type	Indicate the type of this producer. Choose WSRP Producer.
   WSDL URL	The registration URL for the WSRP producer. The syntax will vary according to your WSRP implementation. For example, possible URL formats for a portlet deployed to the Oracle WSRP container include: http://host_name:port_number/context_root/portlets/wsrp2?WSDL http://host_name:port_number/context_root/portlets/wsrp1?WSDL http://host_name:port_number/context_root/portlets/?WSDL (WSRP 1.0 for backward compatibility) Where: host_name is the server where your producer is deployed port_number is the HTTP listener port number context_root is the Web application's context root portlets wsrp(1|2)?WSDL is static text. All producers deployed to the Oracle WSRP container are exposed as WSRP version 1 and version 2 producers. In WebCenter Spaces, only v2 WSDLs are supported for Oracle WebLogic Portal Producers. For example: http://myhost.com:7778/MyPortletApp/portlets/wsrp2?WSDL For Oracle WSRP producers, this registration URL can be obtained by accessing the producer test page at: http://host_name:port_number/context_root/info
   Use Proxy?	Select if the WebCenter application must use an HTTP proxy when contacting this producer. If selected, enter values for Proxy Host and Proxy Port. A proxy is required when the WebCenter application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed to communicate with the producer.
   Proxy Host	Enter the address for the proxy server. Do not prefix http:// to the proxy server name.
   Proxy Port	Enter the port number on which the proxy server listens. The default port is 80.
   Default Execution Timeout (Seconds)	Enter a suitable timeout for design-time operations. For example, the maximum time the producer may take to register, deregister, or display portlets on WebCenter pages. Individual portlets may define their own timeout period, which takes precedence over the value expressed here. This default is 30 seconds.

   
   

4. Use the Security section to specify the type of security token to use for the identity propagation/assertion.

   The security token with the propagated or asserted user information is represented as an XML element in the SOAP header. The security token and the SOAP message body are then digitally signed to prove the authenticity of the SOAP message origin from the WebCenter application. WebCenter Spaces supports three types of security tokens: Username Tokens Without Password, Username Tokens With Password, and SAML Tokens.

   Note:

   PeopleSoft WSRP producers support two profiles: Username Token With Password and SAML Token With Message Integrity. Oracle Portal (as a consumer) support three profiles: Username Token Without Password, Username Token With Password, SAML Token With Message Integrity. Other Oracle WSRP producers support all four profiles. For other WSRP containers, check with the specific vendor to determine the token formats they support.

   For detailed parameter information, see Table 12-2, "WSRP Producer Security Connection Parameters".

   Table 12-2 WSRP Producer Security Connection Parameters

   Field	Description
   Token Profile	Select the type of token profile to use for authentication with this WSRP producer. Choose from: Username Without Password(oracle/wss10_username_id_propagation_with_msg_protection_client_policy)—Enforces message level protection (integrity and confidentiality) and identity propagation for inbound SOAP requests using mechanisms described in WS-Security 1.0. Message protection is provided using WS-Security 1.0's Basic128 suite of asymmetric key technologies. Specifically RSA key mechanisms for confidentiality, SHA-1 hashing algorithm for integrity and AES-128 bit encryption. Identity is set using a username provided through the UsernameToken WS-Security SOAP header. The subject is established against the currently configured identity store. When this policy is selected, the Recipient Alias must be specified. Username With Password(oracle/wss10_username_token_with_message_protection_client_policy)—Enforces message-level protection (message integrity and confidentiality) and authentication for inbound SOAP requests in accordance with the WS-Security v1.0 standard. It uses WS-Security's Basic 128 suite of asymmetric key technologies, specifically RSA key mechanism for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption. Authentication is enforced using credentials in the WS-Security UsernameToken SOAP header. The subject is established against the currently configured identity store. Use this token profile if the WSRP producer has a different identity store. You will need to define an external application pertaining to the producer and associate the external application with this producer. External application defined here is used to retrieve and propagate the user credentials to the producer. The producer verifies this against the identity store configured for the external application. When this policy is selected, the Recipient Alias must be specified. SAML Token With Message Integrity(wss10_saml_token_with_message_integrity_client_policy)—Enforces message-level integrity protection and SAML-based authentication for inbound SOAP requests in accordance with the WS-Security 1.0 standard. It uses WS-Security's Basic 128 suite of asymmetric key technologies, specifically RSA key mechanisms for message confidentiality, SHA-1 hashing algorithm for message integrity. SAML Token With Message Protection(oracle/wss10_saml_token_with_message_protection_client_policy)—Enforces message-level protection and SAML-based authentication for inbound SOAP requests in accordance with the WS-Security 1.0 standard. It uses WS-Security's Basic 128 suite of asymmetric key technologies, specifically RSA key mechanisms for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption. When this policy is selected, the Recipient Alias must be specified. None—No security on this connection. If None is selected, no WS-Security header is attached to the SOAP message.
   Issuer Name	Enter the name of the issuer of the SAML Token. For example: www.example.com The issuer name is the attesting entity that vouches for the verification of the subject, and it must be a trusted SAML issuer on the producer end. Valid for: SAML Token With Message Integrity and SAML Token With Message Protection
   Default User	Enter a user name to assert to the remote producer when the user is not authenticated with the WebCenter application. When unauthenticated, the identity anonymous is associated with the application user. The value anonymous may be inappropriate for the remote producer, so you may need to specify an alternative identity here. Keep in mind though, that in this case, the WebCenter application has not authenticated the user so the default user you specify should be a low privileged user in the remote producer. If the user has authenticated to the application, the user's identity is asserted rather than the default user. The WSRP producer must be configured with strict-authentication to support anonymous to a default user mapping. The strict-authentication flag is defined in producer's oracle-portlet.xml file. For more information, see the appendix "oracle-portlet.xml Syntax" in Oracle Fusion Middleware Developer's Guide for Oracle WebCenter. Valid for: SAML Token With Message Integrity, SAML Token With Message Protection, and Username Without Password.
   Associated External Application (Username With Password)	If this producer uses an external application for authentication, use the Associated External Application drop down list to identify the application. If application you want is not listed, select Create New to define the external application now. An external application is required to support producers using the security option Username Token With Password. The external application stores and supplies the user credentials. See also Section 13.2, "Registering External Applications." Valid for: Username With Password only.

   
   

5. Use the Keystore section to specify the location of the key store that contains the certificate and private key that is used for signing some parts (security token and SOAP message body) of the SOAP message.

   For detailed parameter information, see Table 12-3, "WSRP Producer Key Store Connection Parameters".

   Table 12-3 WSRP Producer Key Store Connection Parameters

   Field	Description
   Store Type	The keystore type for this producer—always Java Key Store (jks).
   Store Path	Enter the absolute path to the keystore that contains the certificate and the private key that is used for signing or encrypting the soap message (security token and message body). The signature, encryption, and recipient keys described in this table must be available in this keystore. The keystore should be created usingJDK's keytool utility.
   Password	Provide the password to the keystore that was set when the keystore was created. The producer will not be available if a password is not specified or incorrect.
   Signature Key Alias	Enter the signature key alias. The Signature Key Alias is the identifier for the certificate associated with the private key that is used for signing.
   Signature Key Password	Enter the password for accessing the key identified by the alias specified in Signature Key Alias.
   Encryption Key Alias	Enter the key alias to be used for encryption.
   Encryption Key Password	Enter the password for accessing the encryption key.
   Recipient Alias	Specify the key store alias that is associated with the producer's certificate. This certificate is used to encrypt the message to the producer.

   
   

6. Click OK to save WSRP producer details.

   The new producer appears in the connection table.

The producer is now ready for consumption.

12.2.2 Registering a WSRP Producer Using WLST

Use the WLST command registerWSRPProducer to create a connection to a WSRP portlet producer and register the producer with your WebCenter application. For command syntax and examples, see "registerWSRPProducer" in the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

For information on how to run WLST commands, see Section 1.12.3.1, "Running Oracle WebLogic Scripting Tool (WLST) Commands."

12.4.1 Registering an Oracle PDK-Java Producer Using Fusion Middleware Control

To register an Oracle PDK-Java portlet producer:

1. Login to Fusion Middleware Control and navigate to the home page for your custom WebCenter application (or WebCenter Spaces):

   • Section 6.3, "Navigating to the Home Page for Custom WebCenter Applications"

   • Section 6.2, "Navigating to the Home Page for WebCenter Spaces"

2. Do one of the following:

   • For custom WebCenter applications - From the Application Deployment menu, choose WebCenter > Register Producer.

   • For WebCenter Spaces - From the WebCenter menu, choose Register Producer.

3. In the Add Portlet Producer Connection section, enter connection details for the Oracle PDK-Java producer.

   For detailed parameter information, see Table 12-4, "Oracle PDK-Java Producer Connection Parameters".

   Table 12-4 Oracle PDK-Java Producer Connection Parameters

   Field	Description
   Connection Name	Enter a unique name that will identify this portlet producer registration within the WebCenter application. The name must be unique across all WebCenter connection types. The name you specify here will appear in the Oracle Composer (under the Portlets folder).
   Producer Type	Indicate the type of this producer. Choose Oracle PDK-Java Producer.
   URL End Point	Enter the Oracle PDK-Java producer's URL using the following syntax: http://host_name:port_number/context_root/providers Where: host_name is the server where the producer is deployed port_number is the HTTP Listener port number context_root is the Web application's context root. providers is static text. For example: http://myHost.com:7778/myEnterprisePortlets/providers
   Service ID	Enter a unique identifier for this producer. PDK-Java enables you to deploy multiple producers under a single adapter servlet. Producers are identified by their unique service ID. A service ID is required only if the service ID is not appended to the URL end point. For example, the following URL endpoint requires sample as the service ID: http://domain.us.oracle.com:7778/axyz/providers However, the following URL endpoint, does not require a service ID: http://domain.us.oracle.com:7778/axyz/providers/sample The service ID is used to look up a file called <service_id>.properties, which defines the characteristics of the producer, such as whether to display its test page. Use any value to create the service ID. When no Service ID is specified, _default is used.
   Use Proxy?	Select this check box if the WebCenter application must use an HTTP proxy when contacting this producer. If selected, enter values for Proxy Host and Proxy Port. A proxy is required if the WebCenter application and the remote portlet producer are separated by a firewall and an HTTP proxy is needed for communication with the producer.
   Proxy Host	Enter the host name for the proxy server. Do not prefix http:// to the proxy server name.
   Proxy Port	Enter the port number on which the proxy server listens. This argument defaults to 80.
   Associated External Application	If one of this producer's portlets requires authentication, select Associate Producer with an External Application, and then select the relevant external application from the drop-down list. See also Section 13.2, "Registering External Applications."
   Establish Session?	Select to enable a user session when executing portlets from this producer. When sessions are enabled, they are maintained on the producer server. This allows the portlet code to maintain information in the session. Message authentication uses sessions, so if a shared key is specified, this option should also be selected. For sessionless communication between the producer and the server, do not select this option.
   Default Execution Timeout (Seconds)	Enter a suitable timeout for design-time operations. For example, the maximum time the producer may take to register, deregister, or display portlets on WebCenter pages. This defaults to 30 seconds. Individual portlets may define their own timeout period, which takes precedence over the value expressed here.
   Subscriber ID	Enter a string to identify the consumer of the producer being registered. When a producer is registered with an application, a call is made to the producer. During the call, the consumer (WebCenter application in this instance) passes the value for Subscriber ID to the producer. If the producer does not see the expected value for Subscriber ID, it might reject the registration call.
   Shared Key	Enter a shared key to use for producers that are set up to handle encryption. The shared key is used by the encryption algorithm to generate a message signature for message authentication. Note that producer registration will fail if the producer is set up with a shared key and you enter an incorrect shared key here. The shared key can contain between 10 and 20 alphanumeric characters. This key is also used when registering a producer using Federated Portal Adapter (FPA). The Shared Key is also known as the HMAC key.

   
   

4. Click OK to save Oracle PDK-Java producer details.

   The new producer appears in the connection table.

12.4.2 Registering an Oracle PDK-Java Producer Using WLST

Use the WLST command registerPDKJavaProducer to create a connection to a PDK-Java portlet producer and register the producer with your WebCenter application. For command syntax and examples, see "registerPDKJavaProducer" in the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

For information on how to run WLST commands, see Section 1.12.3.1, "Running Oracle WebLogic Scripting Tool (WLST) Commands."

12.6.1 Editing Producer Registration Details Using Fusion Middleware Control

To update connection details for a portlet producer:

1. Login to Fusion Middleware Control and navigate to the home page for your custom WebCenter application (or WebCenter Spaces):

   • Section 6.3, "Navigating to the Home Page for Custom WebCenter Applications"

   • Section 6.2, "Navigating to the Home Page for WebCenter Spaces"

2. Do one of the following:

   • For custom WebCenter applications - From the Application Deployment menu, choose WebCenter > Service Configuration.

   • For WebCenter Spaces - From the WebCenter menu, choose Settings > Service Configuration.

3. From the list of services on the WebCenter Service Configuration page, choose Portlet Producers.

4. In the Manage Portlet Producer Connections section, select the producer you wish to modify, and click Edit.

5. In the Edit Portlet Producer Connection section, modify connection details, as required. For more information, see:

   • Table 12-1, "WSRP Producer Connection Parameters"

   • Table 12-4, "Oracle PDK-Java Producer Connection Parameters"

6. Click OK to save your changes.

12.6.2 Editing Producer Registration Details Using WLST

Use the following WLST commands to edit portlet producer connections:

• WSRP producers - setWSRPProducer

• PDK-Java producers - setPDKJavaProducer

For command syntax and examples, see the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

For information on how to run WLST commands, see Section 1.12.3.1, "Running Oracle WebLogic Scripting Tool (WLST) Commands."

12.7.1 Deregistering Producers Using Fusion Middleware Control

To deregister a portlet producer:

1. Login to Fusion Middleware Control and navigate to the home page for your custom WebCenter application (or WebCenter Spaces):

   • Section 6.3, "Navigating to the Home Page for Custom WebCenter Applications"

   • Section 6.2, "Navigating to the Home Page for WebCenter Spaces"

2. Do one of the following:

   • For custom WebCenter applications - From the Application Deployment menu, choose WebCenter > Service Configuration.

   • For WebCenter Spaces - From the WebCenter menu, choose Settings > Service Configuration.

3. From the list of services on the WebCenter Service Configuration page, choose Portlet Producers.

4. Select the name of the producer you wish to remove, and click Delete.

The connection details are removed. Portlets associated with this producer are no longer accessible within the WebCenter application.

12.7.2 Deregister Producers Using WLST

Use the following WLST commands to deregister portlet producer connections:

• WSRP producers - deregisterWSRPProducer

• PDK-Java producers - deregisterPDKJavaProducer

Use the following WLST commands to deregister out-of-the-box or sample producers provided with Oracle WebCenter:

• Out-of-the-box producers - deregisterOOTBProducers

• Sample producers - deregisterSampleProducers

For command syntax and examples, see the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

For information on how to run WLST commands, see Section 1.12.3.1, "Running Oracle WebLogic Scripting Tool (WLST) Commands."

12.8.1 Understanding Portlet Producer Application Deployment

You can deploy your portlet producer application to any Oracle WebLogic Managed Server instance, which is configured to support WebCenter portlet producers. To deploy an application to a managed server, you can use Oracle Enterprise Manager Fusion Middleware Control, Oracle WebLogic Administration Console, and WLST. For more information about these administration tools, see Section 1.12, "Oracle WebCenter Administration Tools."

12.8.2 Converting a JSR 168 Portlet Producer EAR File into a WSRP EAR File

To deploy JSR 168 portlets to the WSRP Oracle Portlet Container, the portlet application EAR files must be converted into a WSRP application, which contains the necessary WSDL documents. To convert the JSR 168 portlet producer EAR file into a WSRP EAR file, run the WSRP producer predeployment tool located in the Middleware directory at MW_HOME/WC_HOME/webcenter/modules/oracle.portlet.server_11.1.1, as follows:

java -jar wsrp-predeploy.jar source EAR target EAR

For JPS-compliant portlets developed with servlet version 2.3, you must specify Web proxies using the following command:

java -Dhttp.proxyHost=proxy host -Dhttp.proxyPort=proxy port -jar
wsrp-predeploy.jar source EAR target EAR 

where:

proxy host is the server to which your producer has been deployed.

proxy port is the HTTP Listener port.

wsrp-predeploy.jar is located in the MW_HOME/webcenter_home/modules/oracle.portlet.server_11.1.1 directory.

source EAR is the name of the JSR 168 EAR file.

target EAR file is the name of the new EAR file to be created. If the file name for the targeted EAR file is not specified, then a new EAR file called WSRP-source EAR is produced.

In the following example Web proxy is specified:

java -Dhttp.proxyHost=myhttpproxy.com -Dhttp.proxyPort=80 -jar wsrp-predeploy.jar wsrp-samples.ear

This example produces WSRP-wsrp-samples.ear.

The wsrp-predeploy.jar predeployment tool makes all the necessary changes to a JSR-168 portlet to be able to deploy it to the Oracle portlet container and expose it as a WSRP producer. Here are some examples of what the predeployment tool does:

• Creates the wsdldeploy directory in the java.io.tmpdir folder.

  • On UNIX, the default value of this property is /tmp or /var/tmp

  • on Microsoft Windows, the default value of this property is c:\temp.

• Unpacks the EAR file into wsdldeploy/EAR.

• Unpacks the WAR files into wsdldeploy/[warfilename.war]/.

• Inserts WEB-INF/WSDLs into the unpacked application.

• Modifies WEB-INF/web.xml in the unpackaged WAR files.

• Inserts or modifies WEB-INF/webservices.xml in the WAR files.

• Inserts or modifies WEB-INF/oracle-webservices.xml in the WAR files.

• Repackages the WARs and builds a new EAR file.

12.8.3 Deploying Portlet Producer Applications Using Oracle JDeveloper

You can deploy portlet applications to an Oracle WebLogic Managed Server instance directly from the development environment using Oracle JDeveloper, provided that you have the necessary credentials to access the WebLogic server. For more information, see the section "Deploying a Portlet Application to an Oracle WebLogic Managed Server Instance" in Oracle Fusion Middleware Developer's Guide for Oracle WebCenter.

12.8.4 Deploying Portlet Producer Applications Using Fusion Middleware Control

For information about deploying a portlet producer application using Fusion Middleware Control, see Section 7.1.5.2, "Deploying Custom WebCenter Applications Using Fusion Middleware Control."

12.8.5 Deploying Portlet Producer Applications Using Oracle WebLogic Server Administration Console

For information about deploying a portlet producer application using Oracle WebLogic Server Administration Console, see Section 7.1.5.4, "Deploying WebCenter Applications Using the WLS Administration Console."

12.8.6 Deploying Portlet Applications Using WLST

For information on deploying a portlet application using the WLST command, see Section 7.1.5.3, "Deploying Custom WebCenter Applications Using WLST."