WebSphere brand IBM WebSphere Presence Server, Version 7.0

Configuring the REST interface to Presence Server

Use the WebSphere Integrated Solutions Console to configure the Presence HTTP gateway, on which the REST interface to Presence Server is defined.

About this task

Note that these configuration attributes, unlike other configuration options for your Presence Server deployment, are not stored in the XML configuration file (SystemConfiguration.xml).

The configuration attributes for the Presence Servlet are added as context parameters of the Servlet's web.xml file. To set the attributes, follow these steps.

  1. Log in to the Integrated Solutions Console:
    1. Open a browser and navigate to the following URL: https://host_name:port/ibm/console.
      Where:
      • host_name is the fully qualified host name of the server where the application or the network deployment manager is deployed.
      • port is the secured port used to access the console. The default port is 9043.
      Note: The default unsecured port is 9060. If you use 9060, you must have "http" instead of "https" in the URL.
    2. Enter an administrator user ID and password.
    3. Click Log in.
  2. Click Applications > Application types > WebSphere Enterprise Applications.
    Note: If you are using WebSphere® Application Server version 6.1.0.x, reach this window by clicking Applications > Enterprise Applications.
  3. In the list of applications, click the name of the Presence Server application.
  4. In the Enterprise Applications page for Presence Server, under Environment entries for Web modules, assign values to the following parameters:
    PresenceServerAddress
    The SIP address of the Presence Server. The HTTP gateway will use this address to send the SIP requests after translating them from HTTP requests. In most cases, the value for this parameter will be the address of the SIP proxy that you are using. The default value is sip:localhost:5060;transport=TCP.
    NotifyTimeout
    The maximum time, in seconds, to wait for a NOTIFY message from the Presence Server before sending an HTTP error response (408 Request timeout) to the client. The default value is 40 seconds.
    CacheHeader
    The Cache-Control header value to include in responses to HTTP requests. The header is used to disable caching in the HTTP client and in proxy servers along the way to the client. The default value is as follows: private, no-cache, max-age=0, must-revalidate.
  5. Optionally, change the REST application prefix–the context root–from its default value of presence:
    1. In the Enterprise Applications page for Presence Server, under Context root for Web modules, change the context root for the presence.rest.web module.
    2. Open a command prompt and navigate to the was_root/plugins directory.
    3. Open the config.xml in IBMWebSpherePresenceServerRESTPlugin.jar and update the contextRoot element.
    4. Save your changes.
  6. Restart the application:
    1. Click Applications > Application types > WebSphere Enterprise Applications.
      Note: If you are using WebSphere Application Server version 6.1.0.x, reach this window by clicking Applications > Enterprise Applications.
    2. Select the check box associated with the Presence Server.
    3. Click Stop. The Application Status column should indicate a Stopped status.
    4. Click Start. The Application Status column should indicate a Started status.



Terms of use
(C) Copyright IBM Corporation 2009. All Rights Reserved.