Open SCAP Library
ds_rds_session.h
1 /*
2  * Copyright 2014 Red Hat Inc., Durham, North Carolina.
3  * All Rights Reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  *
19  * Author:
20  * Šimon Lukašík
21  */
22 #ifndef DS_RDS_SESSION_H
23 #define DS_RDS_SESSION_H
24 
25 #ifdef HAVE_CONFIG_H
26 #include <config.h>
27 #endif
28 
29 #include "oscap.h"
30 #include "oscap_source.h"
31 #include "scap_ds.h"
32 #include "oscap_export.h"
33 
41 struct ds_rds_session;
42 
52 
58 OSCAP_API void ds_rds_session_free(struct ds_rds_session *rds_session);
59 
66 OSCAP_API struct rds_index *ds_rds_session_get_rds_idx(struct ds_rds_session *session);
67 
75 OSCAP_API int ds_rds_session_set_target_dir(struct ds_rds_session *session, const char *target_dir);
76 
83 OSCAP_API int ds_rds_session_dump_component_files(struct ds_rds_session *session);
84 
93 OSCAP_API struct oscap_source *ds_rds_session_select_report(struct ds_rds_session *session, const char *report_id);
94 
104 OSCAP_API struct oscap_source *ds_rds_session_select_report_request(struct ds_rds_session *session, const char *report_request_id);
105 
115 OSCAP_API int ds_rds_session_replace_report_with_source(struct ds_rds_session *session, struct oscap_source *source);
116 
123 OSCAP_API char *ds_rds_session_get_html_report(struct ds_rds_session *rds_session);
124 
125 #endif
OSCAP_API int ds_rds_session_dump_component_files(struct ds_rds_session *session)
Store cached component files to the hard drive.
Definition: ds_rds_session.c:117
OSCAP_API void ds_rds_session_free(struct ds_rds_session *rds_session)
Dispose ds_rds_session structure.
Definition: ds_rds_session.c:62
OSCAP_API struct oscap_source * ds_rds_session_select_report_request(struct ds_rds_session *session, const char *report_request_id)
Select arf:report-request from result DataStream and return it in form of oscap_source.
Definition: ds_rds_session.c:138
General OpenScap functions and types.
struct oscap_source * source
Result DataStream raw representation.
Definition: ds_rds_session.c:42
OSCAP_API struct rds_index * ds_rds_session_get_rds_idx(struct ds_rds_session *session)
Get Result DataStream index.
Definition: ds_rds_session.c:71
OSCAP_API struct oscap_source * ds_rds_session_select_report(struct ds_rds_session *session, const char *report_id)
Select arf:report from result DataStream and return it in form of oscap_source.
Definition: ds_rds_session.c:122
Definition: ds_rds_session.c:41
OSCAP_API int ds_rds_session_replace_report_with_source(struct ds_rds_session *session, struct oscap_source *source)
Replace currently selected report with the content of the source.
Definition: ds_rds_session.c:159
Represents <asset-report-collection> element - the root element of each result datastream in Asset Re...
Definition: rds_index.c:40
Definition: oscap_source.c:66
OSCAP_API int ds_rds_session_set_target_dir(struct ds_rds_session *session, const char *target_dir)
Set target directory for the component files.
Definition: ds_rds_session.c:94
OSCAP_API char * ds_rds_session_get_html_report(struct ds_rds_session *rds_session)
Returns HTML representation of the given result datastream.
Definition: ds_rds_session.c:177
OSCAP_API struct ds_rds_session * ds_rds_session_new_from_source(struct oscap_source *source)
Create new ds_rds_session from existing oscap_source.
Definition: ds_rds_session.c:49
Open-scap Data Stream interface.