Package org.glassfish.jersey.server.monitoring

Interface RequestEvent

All Known Implementing Classes:
RequestEventImpl
public interface RequestEvent
An event informing about details of a request processing. The event is created by a Jersey runtime and handled by RequestEventListener (javadoc of listener describes how to register the listener for particular request).

The event contains the RequestEvent.Type which distinguishes between types of event. There are various properties in the event (accessible by getters) and some of them might be relevant only to specific event types.

Note that internal state of the event must be modified. Even the event is immutable it exposes objects which might be mutable and the code of event listener must not change state of these objects.

Author:
Miroslav Fuksa

  • Method Details

    • getType

      RequestEvent.Type getType()
      Returns the type of this event.
      Returns:
      Request event type.

    • getContainerRequest

      ContainerRequest getContainerRequest()
      Get the container request. The container request is available for all event types. Returned request must not be modified by the request event listener.
      Returns:
      The non-null container request.

    • getContainerResponse

      ContainerResponse getContainerResponse()
      Get the container response. The response is available only for certain event types. The returned response might vary also on the event type. The getter returns always the latest response being processed. So, for example for event RequestEvent.Type.EXCEPTION_MAPPING_FINISHED event type the method returns mapped response and not the original response created from execution of the resource method.
      Returns:
      Latest response being processed or null if no response has been produced yet.

    • getException

      Throwable getException()
      Get the latest exception, if any, thrown by the request and response processing. When this method returns not null value, the method getExceptionCause() returns the origin of the exception.
      Returns:
      Exception thrown or null if no exception has been thrown.

    • getUriInfo

      ExtendedUriInfo getUriInfo()
      Get the extended uri info associated with this request. This method returns null for RequestEvent.Type.START event. The returned ExtendedUriInfo can be used to retrieve information relevant to many event types (especially event types describing the matching process).
      Returns:
      Extended uri info or null if it is not available yet.

    • getExceptionMapper

      ExceptionMapper<?> getExceptionMapper()
      Get the ExceptionMapper that was found and used during the exception mapping phase.
      Returns:
      Exception mapper or null if no exception mapper was found or even needed.

    • getContainerRequestFilters

      Iterable<ContainerRequestFilter> getContainerRequestFilters()
      Get container request filters used during the request filtering phase.
      Returns:
      Container request filters or null if no filters were used yet.

    • getContainerResponseFilters

      Iterable<ContainerResponseFilter> getContainerResponseFilters()
      Get container response filters used during the response filtering phase.
      Returns:
      Container response filter or null if no filters were used yet.

    • isSuccess

      boolean isSuccess()
      Return true if the request and response has been successfully processed. Response is successfully processed when the response code is smaller than 400 and response was successfully written. If the exception occurred but was mapped into a response with successful response code and written, this method returns true.
      Returns:
      True if the response was successfully processed.

    • isResponseSuccessfullyMapped

      boolean isResponseSuccessfullyMapped()
      Returns true if the response was successfully mapped from an exception by exception mappers. When exception mapping phase failed or when no exception was thrown at all the, the method returns false. This method is convenient when handling the RequestEvent.Type.EXCEPTION_MAPPING_FINISHED event type.
      Returns:
      True if the exception occurred and it was successfully mapped into a response.

    • getExceptionCause

      RequestEvent.ExceptionCause getExceptionCause()
      Get the exception cause. This method is relevant only in cases when getException() returns non-null value (for example when handling RequestEvent.Type.ON_EXCEPTION) event type.
      Returns:
      Exception cause of the latest exception or null if no exception has occurred.

    • isResponseWritten

      boolean isResponseWritten()
      Returns true if the response has been successfully written. true is returned even for cases when the written response contains error response code.
      Returns:
      true if the response was successfully written;false when the response has not been written yet or when writing of response failed.