WebSphere brand IBM WebSphere Telecom Web Services Server, Version 7.1

Policy Retrieval

Fetches policy information from the Service Policy Management system and populates SOAP headers with policy information.

Description

The Policy Retrieval mediation primitive fetches policy information from the Service Policy Management system and populates SOAP headers with policy information. This policy information is then passed along with the request to downstream mediation primitives and backend service implementations for policy-based personalization of service execution. This mediation primitive uses the access Web service interface to communicate with the Service Policy Management system.

The requester, service, and operation for the Web service request are used to retrieve policy information from the Service Policy Management system.

Policy configuration

This mediation primitive uses the following policies for runtime configuration:

None

Mediation primitive properties

This mediation primitive uses the following configuration properties. These properties can be modified using WebSphere Integration Developer (WID) tooling. Properties that are promoted can be configured using the Integrated Solutions Console.
Table 1. Mediation primitive properties
Property Type Promoted? Description
servicePolicyManagerEndpoint string yes The endpoint used to call the Service Policy Manager access interface.

Default: http://localhost:9080/SPM/Access/services/PolicyAccess

serviceIdentificationMethod string yes The method used for identifying the unique service name from a Web service request. Two values/methods are supported:
MESSAGE_NAMESPACE
(Default) The XML namespace used for the SOAP message contents.
REQUEST_URI
Gets the full request URI from the HTTP request. This allows for differentiating between different service endpoints.
policyCacheInterval long yes Time in milliseconds to cache of policy values for a given requester, service, and operation. A value of zero disables caching. Values must be > = 0.

Default: Zero by default (caching disabled)

Note: If the user promotes a property, the WID tooling or the Administration Console can be used to change the property value.

Upstream SOAP headers

The following SOAP header elements are expected from upstream mediation primitives:
<twss:twssHeaders>
  ...
  <twss:requesterID>
    <!-- Used for the lookup of the requester's policies. If this
         header is missing, "unauthenticated" is assumed. -->
  </twss:requesterID>
  ...
</twss:twssHeaders>

Added SOAP headers

The following SOAP header elements are added or modified for downstream mediation primitives. A policy header element shows for each policy retrieved from the Service Policy Manager system.
<twss:twssHeaders>
  ...
<serviceID>
  <!--service identification value, based on service identification method used-->
</serviceID>
  ...
  <twss:policies>
    <twss:policy attribute="" value=""/>
    <twss:policy attribute="" value=""/>
    ...
  </twss:policies>
  ...
</twss:twssHeaders>

Message handling

Messages that are successfully processed by the Policy Retrieval mediation primitive are passed to the output terminal of the mediation primitive. If an error occurs while processing the message, the message is redirected to the fault terminal:
  • The service message object (SMO) data object transient context (“context/transient/exceptionType”) indicates whether a service-related or policy-related exception occurred.
  • Fault information is set in the SMO headers as indicated in the following table:
    SMO header (represented by XPath) Contents
    ServiceMessageObject/context/failInfo/failureString The full message text that represents the fault situation with substituted variables. For example, SOAC4025E: Error occurred.
    ServiceMessageObject/context/failInfo/origin The name of the mediation primitive class that originated the fault.
    ServiceMessageObject/SOAPFaultInfo/faultcode The TWSS message code that represents the fault situation. For example, SOAC4025E.
    ServiceMessageObject/SOAPFaultInfo/faultstring The full message text that represents the fault situation with substituted variables. For example, SOAC4025E: Error occurred.



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