Accessing WinGate objects
Registered WinGate objects are only made accessible within certain configurations, and WinGate scripting. Within the appropriate configuration or script, there are several ways that you can access objects and their methods registered by WinGate components:
-
Symbol Browser
The Symbol Browser is a user interface provided by WinGate, which lists all of the component data objects that are available. You can use the Symbol Browser to insert object symbols (a reference to the object data variable or method) into the configuration so they can provide data or perform a function. The Symbol Browser can be accessed from any user interface that provides an Insert symbol button
.
Note
Object availability
The availability of objects (and their data or methods) in the Symbol Browser, is dependent on the context of the script or configuration you are editing, and what data is available at the time. As such, the Symbol Browser can appear differently depending on which configuration or user interface it is opened in.
-
Direct reference
You can also manually enter the required the object method by directly writing the object.property or object.functionname(parameters if required) into the script or configuration that has access to registered objects.
In the example below, a Run Javascript policy item is configured to check the value of client IP address and the port that they made the request to, as part of a policy being processed. The policy is based on the WWWProxyService:Proxy Request event.
Here two pieces of component data have been referenced and used in the script:
-
Session.ClientIp
The Session object provides the Client IP address where the proxy request came from. In this instance this is registered by the WWW Proxy Service responsible for the event.
-
Request.Port
The Request object provides the port the request made to.
Note
When direct referencing objects and their methods in a configuration or script, you must ensure that they will be available for WinGate to use from that configuration.
We recommend that if you are unsure of what WinGate objects are available, then use the Symbol Browser to input the object symbols you require.
WinGate DOM syntax
Whether using a Symbol Browser or writing an object directly into a configuration or script, there are several syntax rules for using object symbols.
Read more