Class AgentRequestContext

java.lang.Object
org.opensaml.messaging.context.BaseContext
net.shibboleth.sp.context.AgentRequestContext
All Implemented Interfaces:
Iterable<BaseContext>

public class AgentRequestContext extends BaseContext
General context for an agent request tracking basic information about the request, the messages from and back to the agent, and wrapped servlet interfaces.

This context leaves the real input and output message trees free for use by existing classes.

  • Field Details

    • agent

      @Nullable private Agent agent
      Agent making the request.
    • application

      @Nullable private Application application
      Application for which the request was made.
    • input

      @Nullable private DDF input
      Input message.
    • output

      @Nullable private DDF output
      Output message.
    • wrappedHttpServletRequest

      @Nullable private RemotedHttpServletRequest wrappedHttpServletRequest
      Wrapped servlet request backed by input.
    • wrappedHttpServletResponse

      @Nullable private RemotedHttpServletResponse wrappedHttpServletResponse
      Wrapped servlet response backed by output.
  • Constructor Details

    • AgentRequestContext

      public AgentRequestContext()
  • Method Details

    • getAgent

      @Nullable public Agent getAgent()
      Get the agent making the request.
      Returns:
      the agent
    • setAgent

      @Nonnull public AgentRequestContext setAgent(Agent a)
      Set the agent making the request.
      Parameters:
      a - agent to set
      Returns:
      this context
    • getApplication

      @Nullable public Application getApplication()
      Get the application for which the request was made.
      Returns:
      the application
    • setApplication

      @Nonnull public AgentRequestContext setApplication(Application app)
      Set the application for which the request was made.
      Parameters:
      app - application to set
      Returns:
      this context
    • getInput

      @Nullable public DDF getInput()
      Get the input message from the agent.
      Returns:
      input message
    • setInput

      @Nonnull public AgentRequestContext setInput(@Nullable DDF ddf)
      Set the input message from the agent.
      Parameters:
      ddf - input message
      Returns:
      this context
    • getOutput

      @Nullable public DDF getOutput()
      Get the output message for the agent.
      Returns:
      output message
    • setOutput

      @Nonnull public AgentRequestContext setOutput(@Nullable DDF ddf)
      Set the output message for the agent.
      Parameters:
      ddf - output message
      Returns:
      this context
    • getRemotedHttpServletRequest

      @Nullable public RemotedHttpServletRequest getRemotedHttpServletRequest()
      Get the wrapped servlet request backed by the input message.
      Returns:
      wrapped servlet request
    • setRemotedHttpServletRequest

      @Nonnull public AgentRequestContext setRemotedHttpServletRequest(@Nullable RemotedHttpServletRequest wrapped)
      Set the wrapped servlet request backed by the input message.
      Parameters:
      wrapped - wrapped servlet request
      Returns:
      this context
    • getRemotedHttpServletResponse

      @Nullable public RemotedHttpServletResponse getRemotedHttpServletResponse()
      Get the wrapped servlet response backed by the output message.
      Returns:
      wrapped servlet response
    • setRemotedHttpServletResponse

      @Nonnull public AgentRequestContext setRemotedHttpServletResponse(@Nullable RemotedHttpServletResponse wrapped)
      Set the wrapped servlet response backed by the output message.
      Parameters:
      wrapped - wrapped servlet response
      Returns:
      this context