Administrative Webjects
The following webjects provide a quick way to perform specific administrative tasks, such as gathering simple statistics or causing service properties to reload at runtime:
• Get-Statistics
• Reload-Properties
All administrative webjects use the ADM type attribute value in the webject tag.
Get-Statistics
DESCRIPTION
Returns a group containing simple statistical information related to the specified process. The returned group contains the following statistical information:
• serviceName — Name of the service
• serviceType — Type of service. Valid service types are task processor or adapter.
• activeThreads — Number of actively running threads, not including the current thread.
• handledRequests — Number of requests handled.
• averageResponse — Average time in milliseconds it has taken to respond to a request.
Requests to execute administrative webjects are not included in the statistics.
 |
This webject is only supported by processes listening on a port, such as an out-of-process adapter or a task processor.
|
SYNTAX
<ie:webject name="Get-Statistics" type="ADM">
<ie:webject name="INSTANCE" data="instance"/>
</ie:webject>
<ie:webject name="INSTANCE" data="instance"/>
</ie:webject>
PARAMETERS
|
Required
|
Select
|
Optional
|
|---|---|---|
|
INSTANCE
|
INSTANCE
Specifies the name of the process in which this webject is to be run. An adapter that is running out-of-process or a task processor are both processes.
This parameter is required.
EXAMPLE
<ie:webject name="Get-Statistics" type="ADM">
<ie:param name="INSTANCE"
data="com.myCompany.myHost.server.taskProcessor"/>
</ie:webject>
<ie:param name="INSTANCE"
data="com.myCompany.myHost.server.taskProcessor"/>
</ie:webject>
Reload-Properties
DESCRIPTION
Reloads properties associated with either the currently running serviceName or a specific serviceName. This webject can be executed in out-of-process adapters, task processors, or JSP pages. If the webject is executed locally in a JSP page, the properties are reloaded by a service running within the servlet JVM, such as IeServlet, SoapRPCRouter, or JSP properties.
SYNTAX
<ie:webject name="Reload-Properties" type="ADM">
<ie:param name="INSTANCE" data="instance"/>
<ie:param name="SERVICE_NAME" data="service_name"/>
</ie:webject>
<ie:param name="INSTANCE" data="instance"/>
<ie:param name="SERVICE_NAME" data="service_name"/>
</ie:webject>
PARAMETERS
|
Required
|
Select
|
Optional
|
|---|---|---|
|
INSTANCE
|
||
|
SERVICE_NAME
|
INSTANCE
Specifies the name of the process in which this webject is to be run. An adapter that is running out-of-process or a task processor are both processes.
This parameter is optional.
SERVICE_NAME
Specifies the name of the service whose properties are to be reloaded. If this parameter is omitted, then the webject reloads the properties of the currently running service. If the value specified for SERVICE_NAME is not a running service, then com.infoengine.au.NoSuchServiceException is thrown.
This parameter is optional.