Package org.forgerock.json.resource

Interface SingletonResourceProvider

All Known Implementing Classes:
ServerInfoSingletonProvider
public interface SingletonResourceProvider
An implementation interface for resource providers which exposes a single permanent resource instance. A singleton resource may support the following operations:
  • action
  • patch
  • read
  • update
More specifically, a singleton resource cannot be created, deleted, or queried and may only support a limited sub-set of actions.

NOTE: field filtering alters the structure of a JSON resource and MUST only be performed once while processing a request. It is therefore the responsibility of front-end implementations (e.g. HTTP listeners, Servlets, etc) to perform field filtering. Request handler and resource provider implementations SHOULD NOT filter fields, but MAY choose to optimise their processing in order to return a resource containing only the fields targeted by the field filters.