Package com.inteliqua.rest.common
Class APIRequestContext
- java.lang.Object
-
- com.inteliqua.rest.common.APIRequestContext
-
public class APIRequestContext extends Object
Context object representing the request information for an API operation.This class stores details related to the resource being requested, the type of the request, and the level of detail required in the API response.
It is annotated withRequestScopedto ensure it is scoped to a single HTTP request lifecycle in a Jersey-based application.- Author:
- nikritikos
-
-
Constructor Summary
Constructors Constructor Description APIRequestContext()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.qivos.util.rest.common.APIResponseLevelgetDetailLevel()Gets the level of detail for the API response.APIRequestTypegetRequestType()Gets the request type for the API operation.APIResourcegetResourceType()Gets the resource type for the API request.voidsetDetailLevel(com.qivos.util.rest.common.APIResponseLevel detailLevel)Sets the level of detail for the API response.voidsetRequestType(APIRequestType requestType)Sets the request type for the API operation.voidsetResourceType(APIResource resourceType)Sets the resource type for the API request.
-
-
-
Method Detail
-
getResourceType
public APIResource getResourceType()
Gets the resource type for the API request.- Returns:
- The resource type.
-
setResourceType
public void setResourceType(APIResource resourceType)
Sets the resource type for the API request.- Parameters:
resourceType- The type of resource being requested.
-
getRequestType
public APIRequestType getRequestType()
Gets the request type for the API operation.- Returns:
- The request type (e.g., GET, POST).
-
setRequestType
public void setRequestType(APIRequestType requestType)
Sets the request type for the API operation.- Parameters:
requestType- The type of the request (e.g., GET, POST).
-
getDetailLevel
public com.qivos.util.rest.common.APIResponseLevel getDetailLevel()
Gets the level of detail for the API response.- Returns:
- The level of detail required in the response.
-
setDetailLevel
public void setDetailLevel(com.qivos.util.rest.common.APIResponseLevel detailLevel)
Sets the level of detail for the API response.- Parameters:
detailLevel- The level of detail required in the response.
-
-