Methods for the Dynamic Service Activator Web Service Interface

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
  • extensionName—String that contains the name of the servlet that the gateway client invokes
  • extensionArguments—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—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
  • 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
• Expected output—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
  • 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/techpubs/software/management/sdx/api-index.html (the sae.Select structure).

• Expected output—Multidimensional 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
  • 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/techpubs/software/management/sdx/api-index.html (the sae.Select structure).

• Expected output—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
  • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)
  • subscriptionName—String that contains the name of the subscription
  • sessionName—String that contains the name of the service session; default string is default
  • activationAttributes—Array of one or more of the following attributes that can be specified for the subscription:
    • sessionTimeout
    • downStreamBandwidth
    • upStreamBandwidth
    • sessionTag
    • subscriptionUsername
    • subscriptionPassword
    • substitutions

    For information about these attributes, see Subscription Attributes.

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

Subscriber_deactivateService

• Deactivates subscribers’ subscriptions to services.
• Arguments
  • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)
  • subscriptionName—String that contains the name of the subscription
  • sessionName—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
  • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)
  • subscriptionName—String that contains the name of the subscription
  • sessionName—String that contains the name of the service session; default string is default
  • optionalAttributes—Array of one or more of the following attributes that can be modified for the subscription:
    • sessionTimeout
    • downStreamBandwidth
    • upStreamBandwidth
    • sessionTag
    • substitutions

    For information about these attributes, see Subscription Attributes.

• 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
  • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)
• Expected output—Boolean operator that indicates success
• SOAP fault codes—See SOAP Fault Codes for Dynamic Service Activator

Subscriber_logout

• Logs out subscribers. This method supports only subscribers who are identified by their IP addresses or the names they use to log in. This method does not support subscribers who are identified by their DNs.
• Arguments
  • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)
• Expected output—None
• SOAP fault codes—See SOAP Fault Codes for Dynamic Service Activator

Subscribers_activateService

• Activates subscribers’ subscriptions to services. Manages service activations by inserting a session record in the Session State Registrar (SSR) that contains information from arguments supplied by the gateway client in addition to the subscriber’s IP address, VPN ID, and session start time.
• Arguments
  • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)
  • subscriptionName—String that contains the name of the subscription
  • sessionName—String that contains the name of the service session; default string is default
  • activationAttributes—Array of one or more of the following attributes that can be specified for the subscription:
    • sessionTimeout
    • downStreamBandwidth
    • upStreamBandwidth
    • sessionTag
    • subscriptionUsername
    • subscriptionPassword
    • substitutions

    For information about these attributes, see Subscription Attributes.

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

Subscribers_deactivateService

• Deactivates subscribers’ subscriptions to services. Manages service deactivations by deleting the session record from the Session State Registrar (SSR).
• Arguments
  • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)
  • subscriptionName—String that contains the name of the subscription
  • sessionName—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

Subscribers_modifyService

• Modifies subscriptions. Manages service modifications by updating the session record in the Session State Registrar (SSR).
• Arguments
  • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)
  • subscriptionName—String that contains the name of the subscription
  • sessionName—String that contains the name of the service session; default string is default
  • optionalAttributes—Array of one or more of the following attributes that can be modified for the subscription:
    • sessionTimeout
    • downStreamBandwidth
    • upStreamBandwidth
    • sessionTag
    • substitutions

    For information about these attributes, see Subscription Attributes.

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

Subscribers_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
  • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)
  • rollback—When this argument is set to true and a failure occurs, the gateway logs out previous successful logins.
• Expected output—Boolean operator that indicates success
• SOAP fault codes—See SOAP Fault Codes for Dynamic Service Activator

Subscribers_logout

• Logs out subscribers. This method supports only subscribers who are identified by their IP addresses or the names they use to log in. This method does not support subscribers who are identified by their DNs.
• Arguments
  • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)
• Expected output—None
• SOAP fault codes—See SOAP Fault Codes for Dynamic Service Activator

Subscribers_read

• Obtains attributes of subscriber sessions for services, service sessions, and subscriber sessions; returns the result in a two-dimensional array.
• Arguments
  • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)
  • subscription—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/techpubs/software/management/sdx/api-index.html (the sae.Select structure).

  • service—Similar to a SQL select statement. Use a filter string for the first field of the select to indicate the services. Use a list of attribute names for the second field to indicate the service 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/techpubs/software/management/sdx/api-index.html (the sae.Select structure).

  • subscriberAttrs—List of subscriber attributes.
• Expected output—Multidimensional array of Attr objects that contain the subscriptions for each identified subscriber
• SOAP fault codes—See SOAP Fault Codes for Dynamic Service Activator

Subscribers_readSubscriber

• Obtains attributes of subscriber sessions; returns the result in a one-dimensional array for SOAP clients that do not support two-dimensional arrays.
• Arguments
  • subURI—String that contains the subscriber’s URI (see Format of the Subscriber’s URI)
  • attrs—List of attributes.
• Expected output—One-dimensional array of AttrSeq objects that contain the subscriber session attributes as a list of attribute-value pairs for one subscriber
• SOAP fault codes—See SOAP Fault Codes for Dynamic Service Activator

Subscribers_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
  • 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/techpubs/software/management/sdx/api-index.html (the sae.Select structure).

• Expected output—Multidimensional array of Attr objects that contain the subscriptions for the subscriber
• SOAP fault codes—See SOAP Fault Codes for Dynamic Service Activator