Package org.apache.juneau.rest

Class RestSession.Builder

java.lang.Object
org.apache.juneau.ContextSession.Builder
org.apache.juneau.rest.RestSession.Builder
Enclosing class:
RestSession
public static class RestSession.Builder extends ContextSession.Builder
Builder class.

  • Constructor Details

    • Builder

      protected Builder(RestContext ctx)
      Constructor.
      Parameters:
      ctx - The context creating this session.
      Cannot be null.

  • Method Details

    • build

      public RestSession build()
      Description copied from class: ContextSession.Builder
      Build the object.
      Specified by:
      build in class ContextSession.Builder
      Returns:
      The built object.

    • getPathInfoUndecoded

      public String getPathInfoUndecoded()
      Returns the request path info as a UrlPath bean.
      Returns:
      The request path info as a UrlPath bean.

    • getUrlPath

      public UrlPath getUrlPath()
      Returns the request path info as a UrlPath bean.
      Returns:
      The request path info as a UrlPath bean.

    • logger

      public RestSession.Builder logger(CallLogger value)
      Specifies the logger to use for this session.
      Parameters:
      value - The value for this setting.
      Can be null (will use the default logger from the context if available).
      Returns:
      This object.

    • pathVars

      public RestSession.Builder pathVars(Map<String,String> value)
      Adds resolved @Resource(path) variable values to this call.
      Parameters:
      value - The variables to add to this call.
      Can be null (ignored).
      Returns:
      This object.

    • req

      public jakarta.servlet.http.HttpServletRequest req()
      Returns the HTTP servlet request object on this call.
      Returns:
      The HTTP servlet request object on this call.

    • req

      public RestSession.Builder req(jakarta.servlet.http.HttpServletRequest value)
      Specifies the HTTP servlet request object on this call.
      Parameters:
      value - The value for this setting.
      Cannot be null.
      Returns:
      This object.

    • res

      public jakarta.servlet.http.HttpServletResponse res()
      Returns the HTTP servlet response object on this call.
      Returns:
      The HTTP servlet response object on this call.

    • res

      public RestSession.Builder res(jakarta.servlet.http.HttpServletResponse value)
      Specifies the HTTP servlet response object on this call.
      Parameters:
      value - The value for this setting.
      Cannot be null.
      Returns:
      This object.

    • resource

      public RestSession.Builder resource(Object value)
      Specifies the servlet implementation bean.
      Parameters:
      value - The value for this setting.
      Can be null (no outer bean will be used for instantiating inner classes).
      Returns:
      This object.