Web service API

How to use PageSeeder's Web service API

cache summary

/caches [GET]

com.pageseeder.cache.GetCachingOverview

Description

Display a summary of the information about all the caches in the PageSeeder.

As of PageSeeder 5.9, PageSeeder includes the following caches:

  • account-lockout
  • file-inspection
  • group-state
  • reset-password-lockout
  • user-details
  • validation-results
  • xml-documents

Parameters

No parameters required.

Permission

Only system administrators can invoke this service.

Response

Each cache is returned as a <cache> element wrapped in a <cache-manager> element.

The cache name is the same for each PageSeeder instance, but the GUID is specific to each instance.

<cache-manager name="__DEFAULT__">
    <cache disabled="false"
           name="xml-documents"
           status="STATUS_ALIVE"
guid="MY-PC/192.168.200.210-6dab5017-330a-47e5-907f-d65c390c8fe4">
        <info size="7"/>
    </cache>
    <cache disabled="false"
           name="reset-password-lockout"
           status="STATUS_ALIVE"
guid="MY-PC/192.168.200.210-ac76d7ce-03dc-40d1-a76f-13cd1f59a81e">
        <info size="0"/>
    </cache>
    <cache disabled="false"
           name="account-lockout"
           status="STATUS_ALIVE"
guid="MY-PC/192.168.200.210-dd985d3b-b227-4a93-ab2d-51fc6d24780f">
        <info size="0"/>
    </cache>
    <cache disabled="false"
           name="validation-results"
           status="STATUS_ALIVE"
guid="MY-PC/192.168.200.210-dcaa442e-ed17-4c16-bce6-94bc8a54f4a4">
        <info size="0"/>
    </cache>
    <cache disabled="false"
           name="file-inspection"
           status="STATUS_ALIVE"
guid="MY-PC/192.168.200.210-23aa0a59-b932-4614-b47c-b05a9666bc67">
        <info size="0"/>
    </cache>
    <cache disabled="false"
           name="user-details"
           status="STATUS_ALIVE"
guid="MY-PC/192.168.200.210-f5d9a7f3-4996-4cd9-b800-6641983e54e8">
        <info size="1"/>
    </cache>
    <cache disabled="false"
           name="group-state"
           status="STATUS_ALIVE"
guid="MY-PC/192.168.200.210-a10e88c7-bcba-4447-9c24-ed5751296e72">
        <info size="1"/>
    </cache>
</cache-manager>

Error Handling

No specific errors expected for this generator.

Created on , last edited on