Package org.gcube.informationsystem.resourceregistry.api.request

Interface RequestInfo

All Known Implementing Classes:
BaseRequestInfo
public interface RequestInfo
Client-side configuration model for Resource Registry request parameters. Provides methods to configure pagination, metadata inclusion, and context behavior for Resource Registry operations.

includeMeta()/allMeta() are a convenience, two-boolean shape for the caller; client implementations combine them into the single wire-level metadataPolicy query parameter (see MetadataPolicy) before issuing the request: includeMeta=false → metadataPolicy=none, includeMeta=true, allMeta=false → metadataPolicy=root, includeMeta=true, allMeta=true → metadataPolicy=all.

Author:
Luca Frosini (ISTI - CNR)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Integer
    DEFAULT_LIMIT
    The Constant DEFAULT_LIMIT.
    static final Integer
    DEFAULT_OFFSET
    The Constant DEFAULT_OFFSET.
    static final Integer
    UNBOUNDED_LIMIT
    The Constant UNBOUNDED_LIMIT.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    allMeta()
    Checks whether to include metadata for all nested instances in the response.
    ContextsPolicy
    getContextsPolicy()
    Returns where the contexts membership map (Context UUID to Context path) appears in the response.
    Integer
    getLimit()
    Gets the maximum number of instances to return in a single response.
    MembershipScope
    getMembershipScope()
    Returns the Context boundary of the memberships listed by every contexts map.
    Integer
    getOffset()
    Gets the number of instances to skip from the beginning of the result set.
    boolean
    includeMeta()
    Checks whether to include metadata in the response instance.
    boolean
    isHierarchicalMode()
    Checks whether to include instances from child contexts of the current context.
    default ResourceRegistryResponses
    serverResponses()
    Returns the opt-in response executor.
    void
    setAllMeta(boolean allMeta)
    Sets whether to include metadata for all nested instances (ConsistsOf relations, Facets, etc.) in the response.
    void
    setContextsPolicy(ContextsPolicy contextsPolicy)
    Sets where the contexts membership map appears in the response.
    void
    setHierarchicalMode(boolean hierarchicalMode)
    Sets whether to include instances from child contexts of the current context.
    void
    setIncludeMeta(boolean includeMeta)
    Sets whether to include metadata in the response instance.
    void
    setLimit(Integer limit)
    Sets the maximum number of instances to return in a single response.
    void
    setMembershipScope(MembershipScope membershipScope)
    Sets the Context boundary of the memberships listed by every contexts map.
    void
    setOffset(Integer offset)
    Sets the number of instances to skip from the beginning of the result set.

  • Field Details

    • DEFAULT_OFFSET

      static final Integer DEFAULT_OFFSET
      The Constant DEFAULT_OFFSET.

    • DEFAULT_LIMIT

      static final Integer DEFAULT_LIMIT
      The Constant DEFAULT_LIMIT.

    • UNBOUNDED_LIMIT

      static final Integer UNBOUNDED_LIMIT
      The Constant UNBOUNDED_LIMIT.

  • Method Details

    • serverResponses

      default ResourceRegistryResponses serverResponses()
      Returns the opt-in response executor. It runs an ordinary client method through the same transport path and associates its value with immutable HTTP metadata. Cache-only calls are explicitly identified and do not fabricate status codes or headers.
      Returns:
      stateless response executor

    • getLimit

      Integer getLimit()
      Gets the maximum number of instances to return in a single response.
      Returns:
      the limit value for pagination, or null if not set (uses server default)

    • setLimit

      void setLimit(Integer limit)
      Sets the maximum number of instances to return in a single response. Used for pagination to control response size and manage memory usage.
      • Default value: Server configuration dependent
      • Example: Set to 50 to get at most 50 instances per request
      • Unlimited results: Set to UNBOUNDED_LIMIT (-1) for unlimited results (may cause timeout if results are too many)
      • Query parameter: limit
      Parameters:
      limit - Maximum number of instances to return, or UNBOUNDED_LIMIT for unlimited results

    • getOffset

      Integer getOffset()
      Gets the number of instances to skip from the beginning of the result set.
      Returns:
      the offset value for pagination, or null if not set (defaults to 0)

    • setOffset

      void setOffset(Integer offset)
      Sets the number of instances to skip from the beginning of the result set. Used for pagination to navigate through large result sets.
      • Default value: 0
      • Example: Set to 10 to skip the first 10 instances (useful for pagination)
      • Query parameter: offset
      Parameters:
      offset - Number of instances to skip from the beginning

    • includeMeta

      boolean includeMeta()
      Checks whether to include metadata in the response instance.
      Returns:
      true if metadata should be included, false for basic information only

    • setIncludeMeta

      void setIncludeMeta(boolean includeMeta)
      Sets whether to include metadata in the response instance. Controls whether to include Metadata in the response.
      • Default value: false (basic information only)
      • Values:
      • true: includes metadata with role-based filtering
      • false: basic information only
      • Wire-level query parameter: combined with allMeta() into metadataPolicy (see the class Javadoc) — there is no standalone includeMeta query parameter on the wire.
      Authorization Restriction:
      • IS-Manager, Infrastructure-Manager, and Context-Manager: See complete metadata including sensitive information (createdBy, lastUpdatedBy)
      • Other users: See filtered metadata with sensitive fields obfuscated
      Parameters:
      includeMeta - Whether to include metadata in the response instance

    • allMeta

      boolean allMeta()
      Checks whether to include metadata for all nested instances in the response.
      Returns:
      true if metadata should be included for all nested elements, false for main instance only

    • setAllMeta

      void setAllMeta(boolean allMeta)
      Sets whether to include metadata for all nested instances (ConsistsOf relations, Facets, etc.) in the response. Controls whether to include Metadata in all IdentifiableElement or just in the root instance. Must be used in conjunction with includeMeta=true.
      • Default value: false (metadata only for main instance, more human-readable)
      • Values:
      • true: complete metadata for all nested IdentifiableElement instances
      • false: metadata only in the root instance, more readable
      • Purpose: When false, produces more human-readable responses with less JSON to process
      • Wire-level query parameter: combined with includeMeta() into metadataPolicy (see the class Javadoc) — there is no standalone allMeta query parameter on the wire.
      Parameters:
      allMeta - Whether to include metadata for all nested instances in the response

    • isHierarchicalMode

      boolean isHierarchicalMode()
      Checks whether to include instances from child contexts of the current context. Restricted to IS-Manager, Infrastructure-Manager, and Context-Manager (see setHierarchicalMode(boolean) for the full per-role breakdown).
      Returns:
      true if hierarchical mode is enabled, false for current context only

    • setHierarchicalMode

      void setHierarchicalMode(boolean hierarchicalMode)
      Sets whether to include instances from child contexts of the current context.
      • Default value: false (child contexts not included)
      • Values:
      • true: includes child contexts
      • false: current context only
      • Query parameter: hierarchical
      Authorization Restriction:
      • IS-Manager and Infrastructure-Manager: Global roles, can use hierarchical mode in any context
      • Context-Manager: Context-specific role, can use hierarchical mode only in contexts where they have this role
      • Other users: Not available
      Parameters:
      hierarchicalMode - Whether to include instances from child contexts of the current context

    • getContextsPolicy

      ContextsPolicy getContextsPolicy()
      Returns where the contexts membership map (Context UUID to Context path) appears in the response.
      Returns:
      the contexts policy, never null

    • setContextsPolicy

      void setContextsPolicy(ContextsPolicy contextsPolicy)
      Sets where the contexts membership map appears in the response. Context Rules:
      • Resources: Present in all contexts that form the union of contexts of all their Facets
      • ConsistsOf relations: Present in all contexts where their target Facets are present
      • Facets: Context availability depends on the Resources that include them via ConsistsOf relations
      Parameters:
      contextsPolicy - the contexts policy; null restores the default

    • getMembershipScope

      MembershipScope getMembershipScope()
      Returns the Context boundary of the memberships listed by every contexts map.
      Returns:
      the membership scope, never null

    • setMembershipScope

      void setMembershipScope(MembershipScope membershipScope)
      Sets the Context boundary of the memberships listed by every contexts map. It does not select instances and does not make the map appear.
      • Default value: MembershipScope.SUBTREE (the token Context and its descendants), for every role
      • Values:
      • MembershipScope.GLOBAL: every membership; restricted to IS-Manager, Infrastructure-Manager and IS-Admin, any other role receives 403 Forbidden
      • Query parameter: membershipScope
      Parameters:
      membershipScope - the membership scope; null restores the default