Obligation Handler (OH)

PEP client Obligation handler function prototypes and type. More...

Data Structures
struct	pep_obligationhandler
	Obligation Handler type. More...
Typedefs
typedef int	oh_destroy_func (void)
	Obligation handler destroy function prototype.
typedef int	oh_init_func (void)
	Obligation handler init function prototype.
typedef int	oh_process_func (xacml_request_t **, xacml_response_t **)
	Obligation handler process function prototype.
typedef struct pep_obligationhandler	pep_obligationhandler_t
	Obligation Handler type.

---

Detailed Description

PEP client Obligation handler function prototypes and type.

The OH function prototypes allow to implement a Obligation Handler (OH). The Obligation Handler does the post-processing of the PEP request and response, after the PEP client have send the request and receive the response.

The OH functions must return 0 on success or an error code.

OH must be added to the PEP client before sending the request.

---

Typedef Documentation

typedef int oh_destroy_func(void)

Obligation handler destroy function prototype.

The destroy() function is called when the PEP client is destroyed.

Returns:

0 on success or an error code.

See also:

pep_destroy()

typedef int oh_init_func(void)

Obligation handler init function prototype.

The init() function is called when the OH is added to the PEP client.

Returns:

0 on success or an error code.

See also:

pep_addobligationhandler(pep_obligationhandler_t * oh)

typedef int oh_process_func(xacml_request_t **, xacml_response_t **)

Obligation handler process function prototype.

The process(&request,&response) function will be called by the pep_authorize(...) function, just after the XACML response is received back from PEP daemon.

Parameters:

	xacml_request_t	** address of the pointer to the PEP request
	xacml_response_t	** address of the pointer to the PEP response

Returns:

0 on success or an error code.

See also:

pep_authorize(xacml_request_t **, xacml_response_t **)

typedef struct pep_obligationhandler pep_obligationhandler_t

Obligation Handler type.