ca.uhn.fhir.rest.server.interceptor

Class IServerInterceptor.ActionRequestDetails

java.lang.Object

ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Enclosing interface:

IServerInterceptor

public static class IServerInterceptor.ActionRequestDetails
extends Object

Constructor Summary

Constructors

Constructor and Description
ActionRequestDetails(RequestDetails theRequestDetails)
ActionRequestDetails(RequestDetails theRequestDetails, FhirContext theContext, IBaseResource theResource)
ActionRequestDetails(RequestDetails theRequestDetails, FhirContext theContext, String theResourceType, IIdType theId)
ActionRequestDetails(RequestDetails theRequestDetails, IBaseResource theResource)
ActionRequestDetails(RequestDetails theRequestDetails, IBaseResource theResource, String theResourceType, IIdType theId)
ActionRequestDetails(RequestDetails theRequestDetails, IIdType theId) Constructor
ActionRequestDetails(RequestDetails theRequestDetails, String theResourceType, IIdType theId)

Method Summary

Modifier and Type	Method and Description
FhirContext	getContext()
IIdType	getId() Returns the ID of the incoming request (typically this is from the request URL)
RequestDetails	getRequestDetails() Returns the request details associated with this request
IBaseResource	getResource() For requests where a resource is passed from the client to the server (e.g.
String	getResourceType() Returns the resource type this request pertains to, or null if this request is not type specific (e.g.
Map<Object,Object>	getUserData() Returns the same map which was
void	notifyIncomingRequestPreHandled(RestOperationTypeEnum theOperationType) This method may be invoked by user code to notify interceptors that a nested operation is being invoked which is denoted by this request details.
void	setResource(IBaseResource theObject) This method should not be called by client code

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActionRequestDetails

public ActionRequestDetails(RequestDetails theRequestDetails)

ActionRequestDetails

public ActionRequestDetails(RequestDetails theRequestDetails,
                            FhirContext theContext,
                            IBaseResource theResource)

ActionRequestDetails

public ActionRequestDetails(RequestDetails theRequestDetails,
                            FhirContext theContext,
                            String theResourceType,
                            IIdType theId)

ActionRequestDetails

public ActionRequestDetails(RequestDetails theRequestDetails,
                            IBaseResource theResource)

ActionRequestDetails

public ActionRequestDetails(RequestDetails theRequestDetails,
                            IBaseResource theResource,
                            String theResourceType,
                            IIdType theId)

ActionRequestDetails

public ActionRequestDetails(RequestDetails theRequestDetails,
                            IIdType theId)

Constructor

Parameters:

theRequestDetails - The request details to wrap

theId - The ID of the resource being created (note that the ID should have the resource type populated)

ActionRequestDetails

public ActionRequestDetails(RequestDetails theRequestDetails,
                            String theResourceType,
                            IIdType theId)

Method Detail

getContext

public FhirContext getContext()

getId

public IIdType getId()

Returns the ID of the incoming request (typically this is from the request URL)

getRequestDetails

public RequestDetails getRequestDetails()

Returns the request details associated with this request

getResource

public IBaseResource getResource()

For requests where a resource is passed from the client to the server (e.g. create, update, etc.) this method will return the resource which was provided by the client. Otherwise, this method will return null .

Note that this method is currently only populated if the handling method has a parameter annotated with the ResourceParam annotation.

getResourceType

public String getResourceType()

Returns the resource type this request pertains to, or null if this request is not type specific (e.g. server-history)

getUserData

public Map<Object,Object> getUserData()

Returns the same map which was

notifyIncomingRequestPreHandled

public void notifyIncomingRequestPreHandled(RestOperationTypeEnum theOperationType)

This method may be invoked by user code to notify interceptors that a nested operation is being invoked which is denoted by this request details.

setResource

public void setResource(IBaseResource theObject)

This method should not be called by client code