Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Methods for the Dynamic Service Activator Web Service Interface

 

This topic describes the methods associated with Dynamic Service Activator, and provides information additional to that in the WSDL file.

invokeGwExtension

  • Invokes a servlet that has been created and deployed in the Web Services Gateway Web application server. The servlet can be a standalone application, or it can be part of a WAR or EAR file.

    When deployed, servlets invoked with invokeGwExtension should be accessible only from the local host.

  • Arguments for DSA:

    • extensionName—String that contains the name of the servlet that the gateway client invokes

    • extensionArgs—String array of arguments that the gateway client passes to the servlet

  • Arguments for DSA2:

    • invokeGwExtension.setArgs0—String that contains the name of the servlet that the gateway client invokes

    • invokeGwExtension.setArgs1—String array of arguments that the gateway client passes to the servlet

  • Guidelines—The names in the following components and properties must be the same as the name of the extensionName argument:

    • The name of the WAR file that is the gateway extension servlet

    • In the WEB-INF/web.xml file in the servlet section, the servlet name

    • In the WEB-INF/web.xml file in the servlet-mapping section, the URL pattern in the format /servlet/<extensionName>

  • Expected output for DSA—String returned by the extension

    Expected output for DSA2:

    InvokeGwExtensionResult

    InvokeGwExtensionResult.getInvokeGwExtensionResult()—String returned by the extension

  • SOAP fault codes—See SOAP Fault Codes for Dynamic Service Activator

invokeScript

  • Manages all operations involved with invoking scripts: retrieves requests to invoke scripts from the gateway client, authenticates the gateway client, verifies the arguments supplied by the gateway client, communicates with other SRC components, and returns values to the gateway client. For a complete description of Dynamic Service Activator’s interactions with the gateway client and other components, see Dynamic Service Activator Overview.

  • Arguments for DSA:

    • scriptName—String that contains the name of the script that the gateway client wants to invoke

    • scriptArgs—String array of arguments that the gateway client passes to the script

  • Arguments for DSA2:

    • invokeScript.setArgs0—String that contains the name of the script that the gateway client wants to invoke

    • invokeScript.setArgs1—String array of arguments that the gateway client passes to the script

  • Expected output for DSA2—String returned by the script

    InvokeScriptResult

    InvokeScriptResult.getInvokeScriptResult()—String returned by the script

  • SOAP fault codes—See SOAP Fault Codes for Dynamic Service Activator

Subscriber_readSubscription

  • Determines whether a subscriber accesses services through the SRC owner’s network and obtains all of that subscriber’s subscriptions; returns the result in a two-dimensional array.

  • Arguments for DSA:

    • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)

    • selection—Similar to a SQL select statement. Use a filter string for the first field of the select to indicate the subscriptions. Use a list of attribute names for the second field to indicate the subscription attributes.

      For more information about how to specify the filter and attributes in a select argument, see the SAE CORBA Remote API documentation on the Juniper Networks website at https://www.juniper.net/documentation/software/management/sdx/api-index.html (the sae.Select structure).

  • Arguments for DSA2:

    • Subscriber_readSubscription.setArgs0—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)

    • Subscriber_readSubscription.setArgs1—Similar to a SQL select statement. Use a filter string for the first field of the select to indicate the subscriptions. Use a list of attribute names for the second field to indicate the subscription attributes.

      For more information about how to specify the filter and attributes in a select argument, see the SAE CORBA Remote API documentation on the Juniper Networks website at https://www.juniper.net/documentation/software/management/sdx/api-index.html (the sae.Select structure).

  • Expected output for DSA—One-dimensional array of Attr objects that contain the subscriptions for the subscriber

    Expected output for DSA2:

    Subscriber_readSubscriptionResult

    Subscriber_readSubscriptionResult.getSubscriber_readSubscriptionResult()—One-dimensional array of Attr objects that contain the subscriptions for the subscriber

  • SOAP fault codes—See SOAP Fault Codes for Dynamic Service Activator

Subscriber_readSubscription_retAttrSeq

  • Determines whether a subscriber accesses services through the SRC owner’s network and obtains all of that subscriber’s subscriptions; returns the result in a one-dimensional array for SOAP clients that do not support two-dimensional arrays.

  • Arguments for DSA:

    • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)

    • select—Similar to a SQL select statement. Use a filter string for the first field of the select to indicate the subscriptions. Use a list of attribute names for the second field to indicate the subscription attributes.

      For more information about how to specify the filter and attributes in a select argument, see the SAE CORBA Remote API documentation on the Juniper Networks website at https://www.juniper.net/documentation/software/management/sdx/api-index.html (the sae.Select structure).

  • Expected output for DSA—One-dimensional array of AttrSeq objects that contain the subscriptions for the subscriber

  • SOAP fault codes—See SOAP Fault Codes for Dynamic Service Activator

Subscriber_activateService

  • Activates subscribers’ subscriptions to services.

  • Arguments for DSA:

    • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)

    • serviceId—String that contains the service ID

    • sessionName—String that contains the name of the service session; default string is default

    • activationAttrs—Array of one or more of the following attributes that can be specified for the subscription:

      • sessionTimeout

      • downStreamBandwidth

      • upStreamBandwidth

      • sessionTag

      • subscriptionUsername

      • subscriptionPassword

      • substitutions

      • serviceIdentifier

      • ratingGroup

      • grantTotalOctets

      • grantOutOctets

      • grantInOctets

      Note

      The serviceIdentifier, ratingGroup, grantTotalOctets, grantOutOctets, and grantInOctets attributes are specific for Gx services.

      For information about these attributes, see Subscription Attributes.

  • Arguments for DSA2:

    • Subscriber_activateService.setArgs0—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)

    • Subscriber_activateService.setArgs1—String that contains the service ID

    • Subscriber_activateService.setArgs2—String that contains the name of the service session; default string is default

    • Subscriber_activateService.setArgs3—Array of one or more of the preceding attributes that can be specified for the subscription

  • Expected output—None

  • SOAP fault codes—See SOAP Fault Codes for Dynamic Service Activator

Subscriber_deactivateService

  • Deactivates subscribers’ subscriptions to services.

  • Arguments for DSA:

    • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)

    • serviceId—String that contains the service ID

    • sessionName—String that contains the name of the service session; default string is default

  • Arguments for DSA2:

    • Subscriber_deactivateService.setArgs0—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)

    •  Subscriber_deactivateService.setArgs1—String that contains the service ID

    •  Subscriber_deactivateService.setArgs2—String that contains the name of the service session; default string is default

  • Expected output—None

  • SOAP fault codes—See SOAP Fault Codes for Dynamic Service Activator

Subscriber_modifyService

  • Modifies subscriptions.

  • Arguments for DSA:

    • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)

    • serviceId—String that contains the service ID

    • sessionName—String that contains the name of the service session; default string is default

    • activationAttrs—Array of one or more of the following attributes that can be modified for the subscription:

      • sessionTimeout

      • downStreamBandwidth

      • upStreamBandwidth

      • sessionTag

      • substitutions

      • serviceIdentifier

      • ratingGroup

      • grantTotalOctets

      • grantOutOctets

      • grantInOctets

      Note

      The serviceIdentifier, ratingGroup, grantTotalOctets, grantOutOctets, and grantInOctets attributes are specific for Gx services.

      For information about these attributes, see Subscription Attributes.

  • Arguments for DSA2:

    • Subscriber_modifyService.setArgs0—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)

    • Subscriber_modifyService.setArgs1—String that contains the service ID

    • Subscriber_modifyService.setArgs2—String that contains the name of the service session; default string is default

    • Subscriber_modifyService.setArgs3—Array of one or more of the preceding attributes that can be modified for the subscription:

  • Expected output—None

  • SOAP fault codes—See SOAP Fault Codes for Dynamic Service Activator

Subscriber_login

  • Logs in subscribers

    Note

    This method supports only subscribers who are identified by their IP addresses. This method does not support subscribers who are identified by the names they use to log in or by their DNs.

  • Arguments for DSA:

    • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)

    • userName—String that contains the subscriber’s username

    • userPassword—String that contains the subscriber’s password

  • Arguments for DSA2:

    • Subscriber_login.setArgs0—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)

    • Subscriber_login.setArgs1—String that contains the subscriber’s username

    • Subscriber_login.setArgs2—String that contains the subscriber’s password

  • Expected output for DSA2—Boolean operator that indicates success

    Expected output for DSA2:

    Subscriber_loginResult

    Subscriber_loginResult.getSubscriber_loginResult()—Boolean operator that indicates success

  • SOAP fault codes—See SOAP Fault Codes for Dynamic Service Activator

Subscriber_logout