Class RequestContext

java.lang.Object
is.galia.resource.RequestContext
public final class RequestContext extends Object

Contains information about a client request.

A single instance may be consulted from several different delegate methods over the course of a request. Some delegate methods will be invoked earlier in the request lifecycle before all information is available to be filled in in the instance. It is normal for little information to be available in the earliest-invoked delegate methods, and more or all information to be available later.

Developer note: adding, removing, or changing any of the properties also requires updating RequestContextMap.

See Also:
  • RequestContextMap

  • Constructor Details

    • RequestContext

      public RequestContext()

  • Method Details

    • getClientIP

      public String getClientIP()

    • getCookies

      public Map<String,String> getCookies()

    • getFullSize

      public Size getFullSize()

    • getIdentifier

      public Identifier getIdentifier()

    • getLocalURI

      public Reference getLocalURI()

    • getMetadata

      public Metadata getMetadata()

    • getOperationList

      public OperationList getOperationList()

    • getOutputFormat

      public Format getOutputFormat()

    • getPageCount

      public Integer getPageCount()

    • getPageNumber

      public Integer getPageNumber()

    • getRequestHeaders

      public Map<String,String> getRequestHeaders()

    • getRequestURI

      public Reference getRequestURI()

    • getResourceClass

      public String getResourceClass()

    • getResultingSize

      public Size getResultingSize()

    • getScaleConstraint

      public ScaleConstraint getScaleConstraint()

    • setClientIP

      public void setClientIP(String clientIP)
      Parameters:
      clientIP - May be null.

    • setCookies

      public void setCookies(Map<String,String> cookies)
      Parameters:
      cookies - May be null.

    • setFullSize

      public void setFullSize(Size fullSize)
      Parameters:
      fullSize - May be null.

    • setIdentifier

      public void setIdentifier(Identifier identifier)
      Parameters:
      identifier - May be null.

    • setLocalURI

      public void setLocalURI(Reference uri)
      Parameters:
      uri - URI seen by the application. May be null.
      See Also:

    • setMetadata

      public void setMetadata(Metadata metadata)
      Parameters:
      metadata - May be null.

    • setOperationList

      public void setOperationList(OperationList opList)
      Parameters:
      opList - May be null.

    • setOutputFormat

      public void setOutputFormat(Format outputFormat)
      Parameters:
      outputFormat - May be null.

    • setPageCount

      public void setPageCount(Integer pageCount)
      Parameters:
      pageCount - May be null.

    • setPageNumber

      public void setPageNumber(Integer pageNumber)
      Parameters:
      pageNumber - May be null.

    • setRequestHeaders

      public void setRequestHeaders(Map<String,String> requestHeaders)
      Parameters:
      requestHeaders - May be null.

    • setRequestURI

      public void setRequestURI(Reference uri)
      Parameters:
      uri - URI requested by the client. May be null.
      See Also:

    • setResourceClass

      public void setResourceClass(String resourceClass)
      Parameters:
      resourceClass - Resource implementation handling the request.

    • setResultingSize

      public void setResultingSize(Size resultingSize)
      Parameters:
      resultingSize - May be null.

    • setScaleConstraint

      public void setScaleConstraint(ScaleConstraint scaleConstraint)
      Parameters:
      scaleConstraint - May be null.

    • toMap

      public Map<String,Object> toMap()
      Returns:
      "Live view" map representation of the instance.
      See Also:
      • for available keys.