Interface MaintenanceSubscriber

All Superinterfaces:
net.solarnetwork.service.Identifiable

public interface MaintenanceSubscriber extends net.solarnetwork.service.Identifiable
API for a service that needs periodic maintenance performed.

This API is meant to allow a service to subscribe to a periodic task or job in order to maintain implementation specific resources over time. For example a service may wish to purge expired items from a cache periodically.

Since:
1.36
  • Field Summary

    Fields inherited from interface net.solarnetwork.service.Identifiable

    GROUP_UID_PROPERTY, UID_PROPERTY
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Perform any required periodic maintenance.

    Methods inherited from interface net.solarnetwork.service.Identifiable

    getDisplayName, getGroupUid, getUid
  • Method Details

    • performServiceMaintenance

      void performServiceMaintenance(Map<String,?> parameters)
      Perform any required periodic maintenance.
      Parameters:
      parameters - job parameters, never null