Use xmlaccess.sh to provide or withdraw a portlet

A producer can provide or withdraw portlets using xmlaccess.sh.

To provide or withdraw the portlet using the XML configuration interface, specify the provided attribute to the portlet tag:

provided = "true | false"

Use this attribute with the portlet tag to specify providing or withdrawing a portlet:

true

To provide the portlet as a WSRP service, set the provided attribute to true. When you run the XML script, the portlet is provided through WSRP. The portlet can now be consumed as a remote portlet by Consumer portals.

false

To withdraw the portlet, set the provided attribute to false. The portlet is withdrawn. It is no longer available for Consumer portals to consume.

Example

XML script examples:

The following two XML samples show you how to use the XML configuration interface to provide a portlet that complies with the standard portlet API. The examples show the provided attribute highlighted. To withdraw a portlet using the XML configuration interface, specify false instead of true for the provided tag.

Provide a standard API portlet:

The following XML sample shows you how to provide a portlet that complies with the standard portlet API:

<?xml version="1.0" encoding="UTF-8" ?>
<request type="update" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:noNamespaceSchemaLocation="PortalConfig_1.4.xsd">
      <!-- 
          Sample for providing a standard API compliant portlet as a WSRP producer. 
          Be aware that this sample is provided as a sample only.
    It might or might not work, depending on the configuration of the portal. 
      --> 
   <portal action="locate">
      <!-- 
          uid must match the uid of the portlet application appended with .webmod 
      --> 
      <web-app action="locate" active="true" 
         uid="stdTestsuite.war.webmod">
            <!-- 
                uid must match the optional portlet-app id attribute from the portlet.xml. 
                If this is not set, the .war file name must be supplied here. 
            --> 
         <portlet-app action="update" uid="stdTestsuite.war">
            <!--
                Name must match the portlet-name tag portlet.xml. 
            --> 
            <portlet action="update" name="TestPortlet1" provided="true" /> 
         </portlet-app>
      </web-app>
   </portal>
</request>

Parent topic: Provide WSRP services as a Producer

Related concepts:
xmlaccess.sh
Work with xmlaccess.sh