Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?


Writing Scripts for Script Services


The ScriptService service provider interface (SPI) provides a Java interface that a script service implements. For information about the ScriptService interface and the ServiceSessionInfo interface, see the script service documentation in the SAE core API documentation on the Juniper Networks Web site at

The implementation of the ScriptService interface activates the service. The SAE sends authentication and tracking events when it activates, modifies, or deactivates a script service session.

The SAE supports script services written in Java or Jython. For scripts written in Java, you must compile and package the implemented ScriptService to make it available for use by the SAE. A Java implementation can include more than one Java archive (JAR) file.

The SAE synchronizes methods used by the same instance of the ScriptService class. You do not need to provide synchronized implementation of the methods.


The script service implementation can be called by different threads at the same time. If your script uses resources that are shared between different service instances, you are responsible for synchronizing access to those resources.

To write a script to be used by a script service:

  1. Create a class that provides a default constructor and that implements the ScriptService interface.

  2. Manage activation and manipulation of the service session by implementing the following ScriptService methods:

    • activateSession()—Activates the script service session.

    • deactivateSession()—Deactivates the script service session and returns any final accounting data for the script service session.

    • modifySession()—If the counters were reset during the modification, modifies the script service session and returns any accounting data.

    These methods are implemented by the script service. They perform the associated action (activate, deactivate, modify) when the SAE calls the method.

  3. (Optional) Get information about service sessions by using methods on the ServiceSessionInfo interface.

  4. (Optional) Provide accounting data, if used, by using the following ScriptService method:

    getAccountingData()—Polls for current accounting data and returns any current accounting data.

  5. (Optional) Provide service status information by using the following ScriptService method:

    getState()—Returns session data to be stored persistently on the router. The SAE does not use this data but provides it to the script when a service session is restored after failover.

  6. Manage the script service by using the following ScriptService methods:

    • initState() —Initializes a recovered script service session after a state synchronization.

    • discarded()—Provides notification that the service session has been discarded. Service sessions are discarded when the SAE loses connection to a router. A discarded service session continues to exist on the router and is restored after the connection to the router is reestablished by an SAE.

      The script service session releases any resources associated with a discarded session, but must not take any action to disrupt the service session.

You can also use the stopService() method on the ServiceSessionInfo object to stop a service and remove the service from the SAE. For example, consider a script service that monitors a state that it creates outside the SAE. If the script detects that the service is not active, it can stop the service and remove it from the SAE. You could use this type of script service to start a daemon process and monitor the process to make sure that it is alive.


The ScriptService SPI does not provide access to a router driver.

Example: Using the ScriptService SPI in Jython

The following example implements the ScriptService SPI in Jython.

Example: Using the ScriptService SPI in Java

The following example implements the ScriptService SPI in Java.