#include <RedfishServiceData.h>
#include <Library/JsonLib.h>
#include <Protocol/EdkIIRedfishConfigHandler.h>

Data Structures
struct	_EDKII_REDFISH_HTTP_PROTOCOL

Macros
#define	EDKII_REDFISH_HTTP_PROTOCOL_REVISION 0x00001000

Typedefs
typedef struct _EDKII_REDFISH_HTTP_PROTOCOL	EDKII_REDFISH_HTTP_PROTOCOL

typedef REDFISH_SERVICE(EFIAPI *	REDFISH_HTTP_CREATE_SERVICE) (IN EDKII_REDFISH_HTTP_PROTOCOL This, IN REDFISH_CONFIG_SERVICE_INFORMATION RedfishConfigServiceInfo)

typedef EFI_STATUS(EFIAPI *	REDFISH_HTTP_FREE_SERVICE) (IN EDKII_REDFISH_HTTP_PROTOCOL *This, IN REDFISH_SERVICE RedfishService)

typedef EDKII_JSON_VALUE(EFIAPI *	REDFISH_HTTP_JSON_IN_PAYLOAD) (IN EDKII_REDFISH_HTTP_PROTOCOL *This, IN REDFISH_PAYLOAD RedfishPayload)

typedef EFI_STATUS(EFIAPI *	REDFISH_HTTP_FREE_REQUEST) (IN EDKII_REDFISH_HTTP_PROTOCOL This, IN REDFISH_REQUEST Request)

typedef EFI_STATUS(EFIAPI *	REDFISH_HTTP_FREE_RESPONSE) (IN EDKII_REDFISH_HTTP_PROTOCOL This, IN REDFISH_RESPONSE Response)

typedef EFI_STATUS(EFIAPI *	REDFISH_HTTP_EXPIRE_RESPONSE) (IN EDKII_REDFISH_HTTP_PROTOCOL *This, IN EFI_STRING Uri)

typedef EFI_STATUS(EFIAPI *	REDFISH_HTTP_GET_RESOURCE) (IN EDKII_REDFISH_HTTP_PROTOCOL This, IN REDFISH_SERVICE Service, IN EFI_STRING Uri, IN REDFISH_REQUEST Request OPTIONAL, OUT REDFISH_RESPONSE *Response, IN BOOLEAN UseCache)

typedef EFI_STATUS(EFIAPI *	REDFISH_HTTP_PATCH_RESOURCE) (IN EDKII_REDFISH_HTTP_PROTOCOL This, IN REDFISH_SERVICE Service, IN EFI_STRING Uri, IN CHAR8 Content, IN UINTN ContentSize OPTIONAL, IN CHAR8 ContentType OPTIONAL, OUT REDFISH_RESPONSE Response)

typedef EFI_STATUS(EFIAPI *	REDFISH_HTTP_PUT_RESOURCE) (IN EDKII_REDFISH_HTTP_PROTOCOL This, IN REDFISH_SERVICE Service, IN EFI_STRING Uri, IN CHAR8 Content, IN UINTN ContentSize OPTIONAL, IN CHAR8 ContentType OPTIONAL, OUT REDFISH_RESPONSE Response)

typedef EFI_STATUS(EFIAPI *	REDFISH_HTTP_POST_RESOURCE) (IN EDKII_REDFISH_HTTP_PROTOCOL This, IN REDFISH_SERVICE Service, IN EFI_STRING Uri, IN CHAR8 Content, IN UINTN ContentSize OPTIONAL, IN CHAR8 ContentType OPTIONAL, OUT REDFISH_RESPONSE Response)

typedef EFI_STATUS(EFIAPI *	REDFISH_HTTP_DELETE_RESOURCE) (IN EDKII_REDFISH_HTTP_PROTOCOL This, IN REDFISH_SERVICE Service, IN EFI_STRING Uri, IN CHAR8 Content OPTIONAL, IN UINTN ContentSize OPTIONAL, IN CHAR8 ContentType OPTIONAL, OUT REDFISH_RESPONSE Response)

Variables
EFI_GUID	gEdkIIRedfishHttpProtocolGuid

Detailed Description

This file defines the EDKII_REDFISH_HTTP_PROTOCOL interface.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file EdkIIRedfishHttpProtocol.h.

Macro Definition Documentation

◆ EDKII_REDFISH_HTTP_PROTOCOL_REVISION

#define EDKII_REDFISH_HTTP_PROTOCOL_REVISION 0x00001000

Definition at line 304 of file EdkIIRedfishHttpProtocol.h.

Typedef Documentation

◆ EDKII_REDFISH_HTTP_PROTOCOL

typedef struct _EDKII_REDFISH_HTTP_PROTOCOL EDKII_REDFISH_HTTP_PROTOCOL

Definition at line 17 of file EdkIIRedfishHttpProtocol.h.

◆ REDFISH_HTTP_CREATE_SERVICE

typedef REDFISH_SERVICE(EFIAPI * REDFISH_HTTP_CREATE_SERVICE) (IN EDKII_REDFISH_HTTP_PROTOCOL *This, IN REDFISH_CONFIG_SERVICE_INFORMATION *RedfishConfigServiceInfo)

This function create Redfish service. It's caller's responsibility to free returned Redfish service by calling FreeService ().

Parameters

[in]	This	Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
[in]	RedfishConfigServiceInfo	Redfish config service information.

Return values

REDFISH_SERVICE	Redfish service is created.
NULL	Errors occur.

Definition at line 31 of file EdkIIRedfishHttpProtocol.h.

◆ REDFISH_HTTP_DELETE_RESOURCE

typedef EFI_STATUS(EFIAPI * REDFISH_HTTP_DELETE_RESOURCE) (IN EDKII_REDFISH_HTTP_PROTOCOL *This, IN REDFISH_SERVICE Service, IN EFI_STRING Uri, IN CHAR8 *Content OPTIONAL, IN UINTN ContentSize OPTIONAL, IN CHAR8 *ContentType OPTIONAL, OUT REDFISH_RESPONSE *Response)

Perform HTTP DELETE to delete redfish resource on given resource URI. It's caller's responsibility to free Response by calling FreeResponse ().

Parameters

[in]	This	Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
[in]	Service	Redfish service instance to perform HTTP DELETE.
[in]	Uri	Target resource URI.
[in]	Content	JSON represented properties to be deleted. This is optional.
[in]	ContentSize	Size of the Content to be send to Redfish service. This is optional. When ContentSize is 0, ContentSize is the size of Content if Content is not NULL.
[in]	ContentType	Type of the Content to be send to Redfish service. This is optional. When Content is not NULL and ContentType is NULL, content type HTTP_CONTENT_TYPE_APP_JSON will be used.
[out]	Response	HTTP response from redfish service.

Return values

EFI_SUCCESS	Resource is returned successfully.
Others	Errors occur.

Definition at line 275 of file EdkIIRedfishHttpProtocol.h.

◆ REDFISH_HTTP_EXPIRE_RESPONSE

typedef EFI_STATUS(EFIAPI * REDFISH_HTTP_EXPIRE_RESPONSE) (IN EDKII_REDFISH_HTTP_PROTOCOL *This, IN EFI_STRING Uri)

This function expire the cached response of given URI.

Parameters

[in]	This	Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
[in]	Uri	Target response of URI.

Return values

EFI_SUCCESS	Target response is expired successfully.
Others	Errors occur.

Definition at line 121 of file EdkIIRedfishHttpProtocol.h.

◆ REDFISH_HTTP_FREE_REQUEST

typedef EFI_STATUS(EFIAPI * REDFISH_HTTP_FREE_REQUEST) (IN EDKII_REDFISH_HTTP_PROTOCOL *This, IN REDFISH_REQUEST *Request)

This function free resources in Request. Request is no longer available after this function returns successfully.

Parameters

[in]	This	Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
[in]	Request	HTTP request to be released.

Return values

EFI_SUCCESS	Resource is released successfully.
Others	Errors occur.

Definition at line 86 of file EdkIIRedfishHttpProtocol.h.

◆ REDFISH_HTTP_FREE_RESPONSE

typedef EFI_STATUS(EFIAPI * REDFISH_HTTP_FREE_RESPONSE) (IN EDKII_REDFISH_HTTP_PROTOCOL *This, IN REDFISH_RESPONSE *Response)

This function free resources in Response. Response is no longer available after this function returns successfully.

Parameters

[in]	This	Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
[in]	Response	HTTP response to be released.

Return values

EFI_SUCCESS	Resource is released successfully.
Others	Errors occur.

Definition at line 104 of file EdkIIRedfishHttpProtocol.h.

◆ REDFISH_HTTP_FREE_SERVICE

typedef EFI_STATUS(EFIAPI * REDFISH_HTTP_FREE_SERVICE) (IN EDKII_REDFISH_HTTP_PROTOCOL *This, IN REDFISH_SERVICE RedfishService)

This function free resources in Redfish service. RedfishService is no longer available after this function returns successfully.

Parameters

[in]	This	Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
[in]	RedfishService	Pointer to Redfish service to be released.

Return values

EFI_SUCCESS	Resource is released successfully.
Others	Errors occur.

Definition at line 49 of file EdkIIRedfishHttpProtocol.h.

◆ REDFISH_HTTP_GET_RESOURCE

typedef EFI_STATUS(EFIAPI * REDFISH_HTTP_GET_RESOURCE) (IN EDKII_REDFISH_HTTP_PROTOCOL *This, IN REDFISH_SERVICE Service, IN EFI_STRING Uri, IN REDFISH_REQUEST *Request OPTIONAL, OUT REDFISH_RESPONSE *Response, IN BOOLEAN UseCache)

Perform HTTP GET to Get redfish resource from given resource URI with cache mechanism supported. It's caller's responsibility to free Response by calling FreeResponse ().

Parameters

[in]	This	Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
[in]	Service	Redfish service instance to perform HTTP GET.
[in]	Uri	Target resource URI.
[in]	Request	Additional request context. This is optional.
[out]	Response	HTTP response from redfish service.
[in]	UseCache	If it is TRUE, this function will search for cache first. If it is FALSE, this function will query Redfish URI directly.

Return values

EFI_SUCCESS	Resource is returned successfully.
Others	Errors occur.

Definition at line 146 of file EdkIIRedfishHttpProtocol.h.

◆ REDFISH_HTTP_JSON_IN_PAYLOAD

typedef EDKII_JSON_VALUE(EFIAPI * REDFISH_HTTP_JSON_IN_PAYLOAD) (IN EDKII_REDFISH_HTTP_PROTOCOL *This, IN REDFISH_PAYLOAD RedfishPayload)

This function returns JSON value in given RedfishPayload. Returned JSON value is a reference to the JSON value in RedfishPayload. Any modification to returned JSON value will change JSON value in RedfishPayload.

Parameters

[in]	This	Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
[in]	RedfishPayload	Pointer to Redfish payload.

Return values

EDKII_JSON_VALUE	JSON value is returned.
NULL	Errors occur.

Definition at line 68 of file EdkIIRedfishHttpProtocol.h.

◆ REDFISH_HTTP_PATCH_RESOURCE

typedef EFI_STATUS(EFIAPI * REDFISH_HTTP_PATCH_RESOURCE) (IN EDKII_REDFISH_HTTP_PROTOCOL *This, IN REDFISH_SERVICE Service, IN EFI_STRING Uri, IN CHAR8 *Content, IN UINTN ContentSize OPTIONAL, IN CHAR8 *ContentType OPTIONAL, OUT REDFISH_RESPONSE *Response)

Perform HTTP PATCH to send redfish resource to given resource URI. It's caller's responsibility to free Response by calling FreeResponse ().

Parameters

[in]	This	Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
[in]	Service	Redfish service instance to perform HTTP PATCH.
[in]	Uri	Target resource URI.
[in]	Content	Data to patch.
[in]	ContentSize	Size of the Content to be send to Redfish service. This is optional. When ContentSize is 0, ContentSize is the size of Content.
[in]	ContentType	Type of the Content to be send to Redfish service. This is optional. When ContentType is NULL, content type HTTP_CONTENT_TYPE_APP_JSON will be used.
[out]	Response	HTTP response from redfish service.

Return values

EFI_SUCCESS	Resource is returned successfully.
Others	Errors occur.

Definition at line 177 of file EdkIIRedfishHttpProtocol.h.

◆ REDFISH_HTTP_POST_RESOURCE

typedef EFI_STATUS(EFIAPI * REDFISH_HTTP_POST_RESOURCE) (IN EDKII_REDFISH_HTTP_PROTOCOL *This, IN REDFISH_SERVICE Service, IN EFI_STRING Uri, IN CHAR8 *Content, IN UINTN ContentSize OPTIONAL, IN CHAR8 *ContentType OPTIONAL, OUT REDFISH_RESPONSE *Response)

Perform HTTP POST to send redfish resource to given resource URI. It's caller's responsibility to free Response by calling FreeResponse ().

Parameters

[in]	This	Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
[in]	Service	Redfish service instance to perform HTTP POST.
[in]	Uri	Target resource URI.
[in]	Content	Data to post.
[in]	ContentSize	Size of the Content to be send to Redfish service. This is optional. When ContentSize is 0, ContentSize is the size of Content.
[in]	ContentType	Type of the Content to be send to Redfish service. This is optional. When ContentType is NULL, content type HTTP_CONTENT_TYPE_APP_JSON will be used.
[out]	Response	HTTP response from redfish service.

Return values

EFI_SUCCESS	Resource is returned successfully.
Others	Errors occur.

Definition at line 241 of file EdkIIRedfishHttpProtocol.h.

◆ REDFISH_HTTP_PUT_RESOURCE

typedef EFI_STATUS(EFIAPI * REDFISH_HTTP_PUT_RESOURCE) (IN EDKII_REDFISH_HTTP_PROTOCOL *This, IN REDFISH_SERVICE Service, IN EFI_STRING Uri, IN CHAR8 *Content, IN UINTN ContentSize OPTIONAL, IN CHAR8 *ContentType OPTIONAL, OUT REDFISH_RESPONSE *Response)

Perform HTTP PUT to send redfish resource to given resource URI. It's caller's responsibility to free Response by calling FreeResponse ().

Parameters

[in]	This	Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
[in]	Service	Redfish service instance to perform HTTP PUT.
[in]	Uri	Target resource URI.
[in]	Content	Data to put.
[in]	ContentSize	Size of the Content to be send to Redfish service. This is optional. When ContentSize is 0, ContentSize is the size of Content.
[in]	ContentType	Type of the Content to be send to Redfish service. This is optional. When ContentType is NULL, content type HTTP_CONTENT_TYPE_APP_JSON will be used.
[out]	Response	HTTP response from redfish service.

Return values

EFI_SUCCESS	Resource is returned successfully.
Others	Errors occur.

Definition at line 209 of file EdkIIRedfishHttpProtocol.h.

Data Structures

Macros

Typedefs

Variables

Detailed Description

Macro Definition Documentation

◆ EDKII_REDFISH_HTTP_PROTOCOL_REVISION

Typedef Documentation

◆ EDKII_REDFISH_HTTP_PROTOCOL

◆ REDFISH_HTTP_CREATE_SERVICE

◆ REDFISH_HTTP_DELETE_RESOURCE

◆ REDFISH_HTTP_EXPIRE_RESPONSE

◆ REDFISH_HTTP_FREE_REQUEST

◆ REDFISH_HTTP_FREE_RESPONSE

◆ REDFISH_HTTP_FREE_SERVICE

◆ REDFISH_HTTP_GET_RESOURCE

◆ REDFISH_HTTP_JSON_IN_PAYLOAD

◆ REDFISH_HTTP_PATCH_RESOURCE

◆ REDFISH_HTTP_POST_RESOURCE

◆ REDFISH_HTTP_PUT_RESOURCE