am_web_do_cookies_reset()

Resets the cookies in a response before redirecting it for authentication to the Access Manager login page.

Details

This function resets the cookies specified in AMAgent.properties and invokes the set action that the agent passes in for each of them. It is enabled by setting the following properties:

• com.sun.am.policy.agents.config.cookie.reset.enable: This property must be set to true if the web agent needs to reset cookies in the response before redirecting them to Access Manager for Authentication. By default it is set to false.

• com.sun.am.policy.agents.config.cookie.reset.list: This property (used only if com.sun.am.policy.agents.config.cookie.reset.enable is enabled) contains a comma-separated list of cookies that need to be included in the response redirected to Access Manager.

See the AMAgent.properties file for more information.

Syntax

#include "am_web.h"
AM_WEB_EXPORT am_status_t
am_web_do_cookies_reset(am_status_t (*setFunc)(
                                     const char *,
                                     void **),
                                     void **args);

Parameters

This function takes the following parameters:

setFunc

Function pointer with which the user can define their own function for setting the cookie in the foreign domain. The implementation defines the parameters.

args

Pointer to a pointer to agent defined parameters.

Returns

This function returns a value of the am_status_t enumeration (defined in the <am_types.h> header file).