Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%SOAP] >  [Configuration]
Private  Storage   

abstract class %SOAP.Configuration extends %RegisteredObject

Abstract super class of class to contain configuration of a SOAP web service or web client. %SOAP.Configuration should be subclassed to specify the configuration. No methods or properties of %SOAP.Configuration should be directly accessed.

The configuration is specified as XML content in an XData member of a subclass. Each XData member may contain one configuration. However, only one configuration may be specified for each web service or web client class across all %SOAP.Configuration subclasses in a namespace. The format of the configuration as follows:

<configuration name="xs:NCNAME"? xmlns="http://www.intersystems.com/configuration">
   <service classname="xs:NCNAME">
      ( (<wsp:Policy cfg:wsdlElement="s:string"? ...> ... </wsp:Policy>) 
       |(<wsp:PolicyReference URI="#policyId cfg:wsdlElement="s:string"?>)) *
      <method name="xs:NCNAME">
         ( (<wsp:Policy cfg:wsdlElement="s:string"? ...> ... </wsp:Policy>) 
          |(<wsp:PolicyReference URI="#policyId cfg:wsdlElement="s:string"?>)) *
         <request>
            ( (<wsp:Policy cfg:wsdlElement="s:string"? ...> ... </wsp:Policy>) 
             |(<wsp:PolicyReference URI="#policyId cfg:wsdlElement="s:string"?>)) *
         </request> ?
         <response>
            ( (<wsp:Policy cfg:wsdlElement="s:string"? ...> ... </wsp:Policy>) 
             |(<wsp:PolicyReference URI="#policyId cfg:wsdlElement="s:string"?>)) *
         </response> ?
      </method> *
   </service> +
<configuration>
Cardinality is indicated by ? (0 or 1), * (0 or more) and + (1 or more).

The following describes the elements and attributes:
/configuration
    Identifies a configuration
/configuration/@name
    Optional name of the configuration.  
    If specified this name must match the name of the XData block.
/configuration/service
    Identifies the service that is being configured
/configuration/service/@classname
    The name of the web service or web client class that is being configured.
/configuration/service/wsp:Policy
    The optional WS-Policy 1.2 or WS-Policy 1.5 to be applied to the endpoint or service subject for
    this web service or client.
/configuration/service/wsp:Policy/@cfg:wsdlElement
    Specifies WSDL attachment elements: service, port, binding, portType
/configuration/service/wsp:PolicyReference
    The optional WS-Policy 1.2 or WS-Policy 1.5 to be applied to the endpoint or service subject for
    to this method in the SOAP binding for this web service or client.
    The policyId is a reference to a local policy defined in a different XData section.
/configuration/service/wsp:PolicyReference/@cfg:wsdlElement
    Specifies WSDL attachment elements: service, port, binding, portType

/configuration/service/method
    The configuration for the operation corresponding to this method in the SOAP binding 
    for this web service or client.
/configuration/service/method/@name
    The name of the method
/configuration/service/method/wsp:Policy
    The optional WS-Policy 1.2 or WS-Policy 1.5 to be applied to the operation corresponding
    to this method in the SOAP binding for this web service or client.
/configuration/service/method/wsp:Policy/@cfg:wsdlElement
    Specifies WSDL attachment elements: binding, portType
/configuration/service/method/wsp:PolicyReference
    The optional reference WS-Policy 1.2 or WS-Policy 1.5 to be applied to the operation corresponding
    to this method in the SOAP binding for this web service or client.
    The policyId is a reference to a local policy defined in a different XData section.
/configuration/service/method/wsp:PolicyReference/@cfg:wsdlElement
    Specifies WSDL attachment elements: binding, portType

/configuration/service/method/request
    The configuration for the request message corresponding to this method for 
    this web service or client.
/configuration/service/method/request/wsp:Policy
    The optional WS-Policy 1.2 or WS-Policy 1.5 to be applied to the request message corresponding
    to this method for this web service or client.
/configuration/service/method/request/wsp:Policy/@cfg:wsdlElement
    Specifies WSDL attachment elements: binding, portType, message
/configuration/service/method/request/wsp:PolicyReference
    The optional WS-Policy 1.2 or WS-Policy 1.5 to be applied to the request message corresponding
    to this method for this web service or client.
    The policyId is a reference to a local policy defined in a different XData section.
/configuration/service/method/request/wsp:PolicyReference/@cfg:wsdlElement
    Specifies WSDL attachment elements: binding, portType, message

/configuration/service/method/response
    The configuration for the response message corresponding to this method for 
    this web service or client.
/configuration/service/method/response/wsp:Policy
    The optional WS-Policy 1.2 or WS-Policy 1.5 to be applied to the response message corresponding
    to this method for this web service or client.
/configuration/service/method/response/wsp:Policy/@cfg:wsdlElement
    Specifies WSDL attachment elements: binding, portType, message
/configuration/service/method/response/wsp:PolicyReference
    The optional WS-Policy 1.2 or WS-Policy 1.5 to be applied to the response message corresponding
    to this method for this web service or client.
    The policyId is a reference to a local policy defined in a different XData section.
/configuration/service/method/response/wsp:PolicyReference/@cfg:wsdlElement
    Specifies WSDL attachment elements: binding, portType, message

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1


Summary

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject


Parameters

• parameter REPORTANYERROR = 1;
If REPORTANYERROR is true (1), Report error when compiling policy if any alternative is invalid. Otherwise only report an error if all aternatives are invalid. In this latter case, we are looking for any alternative to use in a policy supplied by a thrid party.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.