Home > Articles > Operating Systems, Server > Solaris

  • Print
  • + Share This
Like this article? We recommend

Adding and Removing Rewriter Rules

This section describes how to add, remove, and view rewriter rules through both the administration interface and the command line interface. Maintaining the rewriter rule set and understanding how the gateway interprets content based on the values contained within the different rewriter attributes in the case of the CLI and fields in the case of the administration console are essential to successfully deploying the gateway in front of complex web applications.

To Access and Modify the Gateway Profile Using the Administrative GUI

  1. Go to http://ips-server.iplanet.com:8080/console, and log in as the administrator.

    This is the superuser UNIX™ login by default. Be sure to specify the port number, hostname, and domain relative to your own Portal Server installation.

  2. Select the Gateway Management Link under the Portal Server Services Heading.

  3. Select the Manage Gateway Profile link.

    After this page comes up, there will be a long list of component attributes. For details about attributes not related directly to the rewriter, refer to the Sun ONE Portal Server Administration Guide.

    All gateway component attributes directly related to the rewriter contain Rewrite as the first word in the field name. Rules can be added by typing the rule information in the text field just below the option list of the field to be changed and selecting the Add button. The new value is not added to the gateway profile until the Submit button at the bottom of the page has been clicked.

    To delete a rule, first select it, then select the Delete button just bellow the text input field. Again, the changes are not actually made to the profile until the Submit button has been clicked.

    Do not mix and match additions and deletions prior to a submittal so that you are sure that the profile is updated correctly. Also, you should verify that your changes have been made by going back to the gateway profile page.

To Access and Modify the Gateway Profile Using the Command Line Interface

The gateway profile can be modified and viewed by importing and exporting the iwtGateway component using the ipsadmin command.

  1. Dump the component for viewing and editing to an XML file by typing the following commands:

    root@ips-server: PATH=$PATH:/opt/SUNWips/bin;export PATH
    root@ips-server: ipsadmin get component iwtGateway > /tmp/iwtGateway.xml

    where /opt is the Portal Server install directory.

    The rewriter-specific gateway attribute fields that correspond to what is seen on the administration GUI can be seen by typing the following command:

    root@ips-server: grep "desc=\"Rewrite" /tmp/iwtGateway.xml
      desc="Rewrite JavaScript Function Parameters In JavaScript"
      desc="Rewrite JavaScript Variables Function"
      desc="Rewrite Form Input Tags List"
      desc="Rewrite JavaScript Function Parameters In HTML"
      desc="Rewrite JavaScript Function Parameters"
      desc="Rewrite JavaScript Function Parameters Function"
      desc="Rewrite HTML Attributes"
      desc="Rewrite Applet/Object Parameter Values List"
      desc="Rewrite JavaScript System Variables Function"
      desc="Rewrite JavaScript Variables In JavaScript"
      desc="Rewrite HTML Attributes Containing JavaScript"
      desc="Rewrite Attribute value of XML document"
      desc="Rewrite JavaScript Variables In URLs"
      desc="Rewrite Text data of XML document"
      desc="Rewrite JavaScript Variables In HTML"
      desc="Rewrite All URLs Enabled"

    Each of these entries is the description field for the actual attribute name, which might be something like iwtGateway-JavaScriptVariables.

  2. To add a value to an attribute, copy everything between the attribute tags including the tags themselves into a new XML file.

    root@ips-server: /usr/bin/cat <<EOF >/tmp/iwtGateway-JavaScriptVariables.xml
    <iwt:Att name="iwtGateway-JavaScriptVariables"
      type="stringlist"
      desc="Rewrite JavaScript Variables In URLs"
      idx="a5"
      userConfigurable="false"
      >
      <Val>g_szBaseURL</Val>
      <Val>g_szVirtualRoot</Val>
      <Val>szViewClassURL</Val>
      <Val>g_szExWebDir</Val>
      <Val>g_szPublicFolderUrl</Val>
      <Val>g_szUserBase</Val>
      <Val>imgsrc</Val>
      <Val>location.href</Val>
      <Val>_fr.location</Val>
      <Val>mf.location</Val>
      <Val>parent.location</Val>
      <Val>self.location</Val>
      <Val>lnk</Val>
      <Val>tabURL</Val>
      <Val>document.location.href</Val>
      <Val>window.status</Val>
      <Val>window.location.href</Val>
      <Wperm>ADMIN</Wperm>
      <Rperm>ADMIN</Rperm>
      <Rperm>OWNER</Rperm>
     </iwt:Att>
    EOF
  3. Edit the XML file, and add the value or values you want.

  4. Type the ipsadmin command to update the gateway profile with the new attribute values.

    root@ips-server: ipsadmin change component iwtGateway
    /tmp/iwtGateway-JavaScriptVariables.xml
    Operation completed successfully.
  5. Verify that the new value was imported successfully by typing the following command:

    root@ips-server: ipsadmin get component iwtGateway | grep
    window.location.href
    <Val>window.location.href</Val>

    NOTE

    Multiple rules with the same name cannot be specified for the same environment and interpretation. For example, a variable called my_URL cannot be present in both the Rewrite JavaScript Variables in URLs section and the Rewrite JavaScript Variables Function section of the gateway profile. Only the first instance of the rule encountered by the gateway will be used.

After updating the gateway profile, it is a good idea to keep a backup of the profile data. You can do this by using the ipsadmin command (as in the following example) to dump the gateway profile and wrap component tags around the result. The component tags are required in the event that the entire component has to be deleted and re-imported.

root@ips-server: cp /etc/opt/SUNWips/xml/iwtGateway.xml
/etc/opt/SUNWips/xml/iwtGateway.xml.bak
root@ips-server: /usr/bin/cat <<EOF >/tmp/iwtGateway.xml
<iwt:Component name="iwtGateway"
  ver="1.0"
  desc="Gateway Profile"
  resB="iwtGateway"
  idx="">
EOF
root@ips-server: ipsadmin get component iwtGateway >> /tmp/iwtGateway.xml
root@ips-server: /usr/bin/sed '$d' /tmp/iwtGateway.xml >
/etc/opt/SUNWips/xml/iwtGateway.xml
root@ips-server: /usr/bin/cat <<EOF >>/etc/opt/SUNWips/xml/iwtGateway.xml
</iwt:Component>
EOF

Follow the same guidelines to remove a value from an attribute list. If the gateway profile becomes corrupted for any reason, you might be able to delete the component entirely and re-import it using one of the backed up iwtGateway.xml files, as in the following example.

root@ips-server: ipsadmin delete component iwtGateway
Operation completed successfully.
root@ips-server: ipsadmin get component iwtGateway.xml
Profile get failed. More info: Unable to get attribute or privilege value from data store 
root@ips-server: ipsadmin -chkxml /etc/opt/SUNWips/xml/iwtGateway.xml
Operation completed successfully.
root@ips-server: ipsadmin -import /etc/opt/SUNWips/xml/iwtGateway.xml
Operation completed successfully.
root@ips-server: ipsadmin get component iwtGateway > /dev/null 2>&1
root@ips-server: if [ $? -eq 0 ]; then { echo "Success"; } else { echo
"Failure"; } fi
Success

NOTE

The gateway component must be restarted after any modifications to its profile data.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020