Sun OpenSSO Enterprise 8.0 C API Reference for Application and Web Policy Agent Developers

am_log_set_remote_info()

Initializes the remote log service.

Details

This must be called before am_log_log() with AM_LOG_REMOTE_MODULE as the log module. Initialization is done only once. Subsequently, only remote logging calls are done.

Syntax

#include "am_log.h"
AM_EXPORT am_status_t
am_log_set_remote_info(const char *rem_log_url,
                       const char *sso_token_id,
                       const char *rem_log_name,
                       const am_properties_t log_props);

Parameters

This function takes the following parameters:

rem_log_url

Pointer to the URL of the OpenSSO Enterprise Logging Service being used for the remote logging.

sso_token_id

Pointer to a valid SSOTokenID identifying the user to whom the log record applies.

rem_log_name

Pointer to the logging module (file) to which log records are written.

log_props

Pointer to the properties that contain the information to initialize the OpenSSO Enterprise Logging Service.


Note –

log_props is expected to have the information formatted as a properties map in key/value pairs. Delete the am_properties_t pointer only when finished with the SDK. See am_properties_t for more information.


Returns

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