/usr/include/openwsman/wsman-client-api.h is in libopenwsman-dev 2.6.5-0ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 | /*******************************************************************************
* Copyright (C) 2004-2006 Intel Corp. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* - Neither the name of Intel Corp. nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Intel Corp. OR THE CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/
/**
* @author Anas Nashif
*/
#ifndef WSMANCLIENT_API_H_
#define WSMANCLIENT_API_H_
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
#include "wsman-xml-api.h"
#include "wsman-names.h"
#include "wsman-types.h"
#include "wsman-xml-serializer.h"
#include "wsman-epr.h"
#include "wsman-filter.h"
#include "u/list.h"
/**
* @defgroup Client Client
* @brief WS-Management Client
*
* @{
*/
// Possible authentication methods
typedef enum {
WS_NO_AUTH,
WS_BASIC_AUTH,
WS_DIGEST_AUTH,
WS_PASS_AUTH,
WS_NTLM_AUTH,
WS_GSSNEGOTIATE_AUTH,
WS_MAX_AUTH,
} wsman_auth_type_t;
struct _WsManClient;
typedef struct _WsManClient WsManClient;
typedef void (*wsman_auth_request_func_t)( WsManClient *client, wsman_auth_type_t t,
char **usr,
char **pwd);
typedef enum {
WS_LASTERR_OK = 0,
WS_LASTERR_OTHER_ERROR, // not recognized error
WS_LASTERR_FAILED_INIT,
WS_LASTERR_UNSUPPORTED_PROTOCOL,
WS_LASTERR_URL_MALFORMAT,
WS_LASTERR_COULDNT_RESOLVE_PROXY,
WS_LASTERR_COULDNT_RESOLVE_HOST,
WS_LASTERR_COULDNT_CONNECT,
WS_LASTERR_HTTP_RETURNED_ERROR,
WS_LASTERR_WRITE_ERROR,
WS_LASTERR_READ_ERROR,
WS_LASTERR_OUT_OF_MEMORY,
WS_LASTERR_OPERATION_TIMEOUTED, // the timeout time was reached
WS_LASTERR_HTTP_POST_ERROR,
WS_LASTERR_BAD_DOWNLOAD_RESUME, //couldn't resume download
WS_LASTERR_TOO_MANY_REDIRECTS, // catch endless re-direct loops
WS_LASTERR_SSL_CONNECT_ERROR,
WS_LASTERR_SSL_PEER_CERTIFICATE, // peer's certificate wasn't ok
WS_LASTERR_SSL_ENGINE_NOTFOUND, // SSL crypto engine not found
WS_LASTERR_SSL_ENGINE_SETFAILED, // can't set SSL crypto engine default
WS_LASTERR_SSL_CERTPROBLEM, // problem with the local certificate
WS_LASTERR_SSL_CACERT, // problem with the CA cert (path?)
WS_LASTERR_SSL_ENGINE_INITFAILED, // failed to initialise ENGINE
WS_LASTERR_SEND_ERROR, // failed sending network data
WS_LASTERR_RECV_ERROR, // failure in receiving network data
WS_LASTERR_BAD_CONTENT_ENCODING, // Unrecognized transfer encoding
WS_LASTERR_LOGIN_DENIED, // user, password or similar was not
// accepted and we failed to login
WS_LASTERR_BAD_CRL_FILE, //bad CRL file provided (Format, Path or permission)
WS_LASTERR_CURL_BAD_FUNCTION_ARG, // bad function arg calling curl
WS_LASTERR_LAST // never use!
} WS_LASTERR_Code;
typedef enum {
WSMAN_ACTION_NONE = 0,
WSMAN_ACTION_TRANSFER_GET,
WSMAN_ACTION_TRANSFER_PUT,
WSMAN_ACTION_ENUMERATION,
WSMAN_ACTION_PULL,
WSMAN_ACTION_RELEASE,
WSMAN_ACTION_CUSTOM,
WSMAN_ACTION_TRANSFER_CREATE,
WSMAN_ACTION_TRANSFER_DELETE,
WSMAN_ACTION_IDENTIFY,
WSMAN_ACTION_ANON_IDENTIFY,
WSMAN_ACTION_SUBSCRIBE,
WSMAN_ACTION_UNSUBSCRIBE,
WSMAN_ACTION_RENEW,
WSMAN_ACTION_ASSOCIATORS,
WSMAN_ACTION_REFERENCES,
WSMAN_ACTION_TEST
} WsmanAction;
typedef enum {
WSMAN_DELIVERY_PUSH = 0,
WSMAN_DELIVERY_PUSHWITHACK,
WSMAN_DELIVERY_EVENTS,
WSMAN_DELIVERY_PULL
}WsmanDeliveryMode;
typedef enum {
WSMAN_DELIVERY_SEC_AUTO = 0,
WSMAN_DELIVERY_SEC_HTTP_BASIC,
WSMAN_DELIVERY_SEC_HTTP_DIGEST,
WSMAN_DELIVERY_SEC_HTTPS_BASIC,
WSMAN_DELIVERY_SEC_HTTPS_DIGEST,
WSMAN_DELIVERY_SEC_HTTPS_MUTUAL,
WSMAN_DELIVERY_SEC_HTTPS_MUTUAL_BASIC,
WSMAN_DELIVERY_SEC_HTTPS_MUTUAL_DIGEST,
WSMAN_DELIVERY_SEC_HTTPS_SPNEGO_KERBEROS,
WSMAN_DELIVERY_SEC_HTTPS_MUTUAL_SPNEGO_KERBEROS,
WSMAN_DELIVERY_SEC_HTTP_SPNEGO_KERBEROS
}WsManDeliverySecurityMode;
// options flags values
#define FLAG_NONE 0x0000
#define FLAG_ENUMERATION_COUNT_ESTIMATION 0x0001
#define FLAG_ENUMERATION_OPTIMIZATION 0x0002
#define FLAG_ENUMERATION_ENUM_EPR 0x0004
#define FLAG_ENUMERATION_ENUM_OBJ_AND_EPR 0x0008
#define FLAG_DUMP_REQUEST 0x0010
#define FLAG_IncludeSubClassProperties 0x0020
#define FLAG_INCLUDESUBCLASSPROPERTIES FLAG_IncludeSubClassProperties
#define FLAG_ExcludeSubClassProperties 0x0040
#define FLAG_EXCLUDESUBCLASSPROPERTIES FLAG_ExcludeSubClassProperties
#define FLAG_POLYMORPHISM_NONE 0x0080
#define FLAG_MUND_MAX_ESIZE 0x0100
#define FLAG_MUND_LOCALE 0x0200
#define FLAG_MUND_OPTIONSET 0x0400
#define FLAG_MUND_FRAGMENT 0x0800
#define FLAG_CIM_EXTENSIONS 0x1000
#define FLAG_CIM_REFERENCES 0x2000
#define FLAG_CIM_ASSOCIATORS 0x4000
#define FLAG_EVENT_SENDBOOKMARK 0X8000
#define FLAG_CIM_SCHEMA_OPT 0X10000
#define FLAG_EXCLUDE_NIL_PROPS 0X20000
typedef struct {
unsigned long flags;
char *fragment;
char *cim_ns;
char * delivery_uri;
char * reference;
WsmanDeliveryMode delivery_mode; //eventing delivery mode
WsManDeliverySecurityMode delivery_sec_mode; //security mode of eventing delivery
char *delivery_username; // username for delivery, if it is necessary
char *delivery_password; // password for delivery, if it is necessary
char *delivery_certificatethumbprint; // certificate thumbprint of event sink, if it is necessary
float heartbeat_interval;
float expires;
list_t *selectors;
list_t *properties; /* keep properties sorted */
unsigned int timeout;
unsigned int max_envelope_size;
unsigned int max_elements;
hash_t *options; /* for WSM_OPTION_SET */
char *locale; /* Sect. 6.3: wsman:Locale */
char *__reserved[16]; /* reserved for future extensions */
} client_opt_t;
struct _WsManFault {
const char *code;
const char *subcode;
const char *reason;
const char *fault_detail;
};
typedef struct _WsManFault WsManFault;
/**
* Create a client using an endpoint as the argument
* @param endpoint an URI describing the endpoint, with user/pass, port and path
* @return client handle
*/
WsManClient *wsmc_create_from_uri(const char *endpoint);
/**
* Create client and initialize context
* @param hostname Hostname or IP
* @param port port
* @param path HTTP path, for example /wsman
* @param scheme scheme, HTTP or HTTPS
* @param username User name
* @param password Passwrod
* @return client handle
*/
WsManClient *wsmc_create(const char *hostname,
const int port, const char *path,
const char *scheme,
const char *username,
const char *password);
/**
* Set request/response content encoding type. Default encoding type is "UTF-8"
* @param cl Client handle
* @param encoding type of encoding, for example "UTF-16"
* @ return zero for success, others for an error
*/
int wsmc_set_encoding(WsManClient *cl, const char *encoding);
/**
* Set request CIM namespace
* @param cl Client handle
* @param ns requested CIM class namespace
* @ return zero for success, others for an error
*/
int wsmc_set_namespace(WsManClient *cl, const char *ns);
/**
* Return request CIM namespace
* @param cl Client handle
* @ return requested CIM class namespace
*/
char *wsmc_get_namespace(WsManClient *cl);
/**
* Release client
* @param cl Client handle that was created with wsman_create_client
* @return void
*/
void wsmc_release(WsManClient * cl);
/**
* Reset client connection and prepare handle for a new connection
* @param cl Client handle
* @return void
*/
void wsmc_reinit_conn(WsManClient * cl);
/* WsManClient handling */
/**
* Get serialization context
* @param cl Client handle
* @return Context
*/
WsSerializerContextH wsmc_get_serialization_context(WsManClient * cl);
/**
* Get host name from handle
* @param cl Client handle
* @return host name
*/
char *wsmc_get_hostname(WsManClient * cl);
/**
* Get port from handle
* @param cl Client handle
* @return host name
*/
unsigned int wsmc_get_port(WsManClient * cl);
/**
* Get uri path from handle
* @param cl Client handle
* @return uri path
*/
char *wsmc_get_path(WsManClient * cl);
/**
* Get uri scheme from handle
* @param cl Client handle
* @return scheme
*/
char *wsmc_get_scheme(WsManClient * cl);
/**
* Get username from handle
* @param cl Client handle
* @return username
*/
char *wsmc_get_user(WsManClient * cl);
/**
* Get password from handle
* @param cl Client handle
* @return username
*/
char *wsmc_get_password(WsManClient * cl);
/**
* Get request/response content encoding type. Default encoding type is "UTF-8"
* @param cl Client handle
* @ return request encoding string
*/
char *wsmc_get_encoding(WsManClient *cl);
/**
* Get endpoint from handle
* @param cl Client handle
* @return endpoint
*/
char *wsmc_get_endpoint(WsManClient * cl);
/**
* Get response code from client
* @param cl Client handle
* @return response code
*/
long wsmc_get_response_code(WsManClient * cl);
/**
* Get fault string
* @param cl Client handle
* @return host name
*/
char *wsmc_get_fault_string(WsManClient * cl);
/**
* Get last error code
* @param cl Client handle
* @return last error code
*/
WS_LASTERR_Code wsmc_get_last_error(WsManClient * cl);
/**
* Read XML file
* @param cl Client handle
* @param filename File name
* @param encoding Encoding
* @param XML options
* @return XML document
*/
WsXmlDocH wsmc_read_file( const char *filename,
const char *encoding,
unsigned long options);
/**
* Read buffer into an XML document
* @param cl Client handle
* @param buf Buffer with xml text
* @param size Size of buffer
* @param encoding Encoding
* @param XML options
* @return XML document
*/
WsXmlDocH wsmc_read_memory( char *buf,
size_t size, const char *encoding,
unsigned long options);
/**
* Create runtime context for client
* @param cl Client handle
* @return void
*/
WsContextH wsmc_create_runtime(void);
/**
* Parse response and create a new envelope based on it
* @param cl Client handle
* @return New envelope
*/
WsXmlDocH wsmc_build_envelope_from_response(WsManClient * cl);
/* Wsman actions handling */
/**
* Send an Identify request
* @param cl Client handle
* @param client_opt_t Request options and flags
* @return response document
*/
WsXmlDocH wsmc_action_identify(WsManClient * cl,
client_opt_t * options);
/**
* Send a Transfer Get request
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @return response document
*/
WsXmlDocH wsmc_action_get(WsManClient * cl,
const char *resource_uri,
client_opt_t * options);
WsXmlDocH wsmc_action_get_from_epr(WsManClient *cl, epr_t *epr,
client_opt_t *options);
/**
* Send a Transfer Put request
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @param source_doc A document with the new resource, for example the result of a Get request with modified properties.
* @return response document
*/
WsXmlDocH wsmc_action_put(WsManClient * cl, const char *resource_uri, client_opt_t * options,
WsXmlDocH source_doc);
/**
* Send a Transfer Put request using a text buffer XML representation
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @param data Buffer
* @param size Buffer size
* @param encoding XML encoding
* @return response document
*/
WsXmlDocH wsmc_action_put_fromtext(WsManClient * cl,
const char *resource_uri,
client_opt_t * options,
const char *data, size_t size,
const char *encoding);
/**
* Send a Transfer Put request using serialized data
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @param typeInfo Data type information
* @param data Pointer to data
* @return response document
*/
WsXmlDocH wsmc_action_put_serialized(WsManClient * cl,
const char *resource_uri,
client_opt_t * options,
void *typeInfo, void *data);
/**
* Send a Transfer Get and then Transfer Put modifying properties defined in the options structure
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @return response document
*/
WsXmlDocH wsmc_action_get_and_put(WsManClient * cl,
const char *resource_uri,
client_opt_t * options);
/**
* Send a Transfer Create using existing document with a new resource
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @param source_doc A document with the new resource, for example the result of a
* Get request with modified properties.
* @return response document
*/
WsXmlDocH wsmc_action_create(WsManClient * cl, const char *resource_uri, client_opt_t * options,
WsXmlDocH source_doc);
/**
* Send a Transfer Create request using a text buffer XML representation
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @param data Buffer
* @param size Buffer size
* @param encoding XML encoding
* @return response document
*/
WsXmlDocH wsmc_action_create_fromtext(WsManClient * cl, const char *resource_uri, client_opt_t * options,
const char *data, size_t size, const char *encoding);
/**
* Send a Transfer Create request using serialized data
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @param typeInfo Data type information
* @param data Pointer to data
* @return response document
*/
WsXmlDocH wsmc_action_create_serialized(WsManClient * cl,
const char *resource_uri,
client_opt_t * options,
void *typeInfo,
void *data);
/**
* Send a Transfer Delete
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @return response document
*/
WsXmlDocH wsmc_action_delete(WsManClient * cl,
const char *resource_uri,
client_opt_t * options);
WsXmlDocH wsmc_action_delete_from_epr(WsManClient *cl, epr_t *epr,
client_opt_t *options);
/**
* Send a Enumerate request
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @return response document
*/
WsXmlDocH wsmc_action_enumerate(WsManClient * cl,
const char *resource_uri,
client_opt_t * options,
filter_t *filter
);
/**
* Send a Pull request
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @param enumContext enumeration context
* @return response document
*/
WsXmlDocH wsmc_action_pull(WsManClient * cl, const char *resource_uri,
client_opt_t * options,
filter_t *filter,
const char *enumContext);
/**
* Send a Release request
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @param enumContext enumeration context
* @return response document
*/
WsXmlDocH wsmc_action_release(WsManClient * cl, const char *resource_uri,
client_opt_t * options,
const char *enumContext);
/**
* Send a Release request
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @return response document
*/
WsXmlDocH wsmc_action_subscribe(WsManClient * cl, const char *resource_uri,
client_opt_t * options, filter_t *filter);
/**
* Send a Release request
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @param uuid Subscription reference parameter
* @return response document
*/
WsXmlDocH wsmc_action_unsubscribe(WsManClient * cl, const char *resource_uri,
client_opt_t * options,
const char *subsContext);
/**
* Send a Release request
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @param uuid Subscription reference parameter
* @return response document
*/
WsXmlDocH wsmc_action_renew(WsManClient * cl, const char *resource_uri,
client_opt_t * options,
const char *subsContext);
/**
* Send a custom method request
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @param method Custom method name
* @param source_doc A document with the new resource, for example the result of a Get request with modified properties.
* @return response document
*/
WsXmlDocH wsmc_action_invoke(WsManClient * cl, const char *resource_uri,
client_opt_t * options, const char *method,
WsXmlDocH source_doc);
/**
* Send a custom method request using text input of XML data
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @param method Custom method name
* @param data Buffer
* @param size Buffer size
* @param encoding XML encoding
* @return response document
*/
WsXmlDocH wsmc_action_invoke_fromtext(WsManClient * cl,
const char *resource_uri,
client_opt_t * options,
const char *method,
const char *data, size_t size,
const char *encoding);
/**
* Send a custom method request using serialized data of resource
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @param method Custom method name
* @param typeInfo Data type information
* @param data Pointer to data
* @return response document
*/
WsXmlDocH wsmc_action_invoke_serialized(WsManClient * cl,
const char *resource_uri,
client_opt_t * options,
const char *method,
void *typeInfo, void *data);
typedef int (*SoapResponseCallback) (WsManClient *, WsXmlDocH,
void *);
/**
* Send a Enumerate request and then use callback for subsequent Pull calls
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @param callback Function to handle Pull requests and Responses
* @param callback_data Pointer to callback data
* @return success
*/
int wsmc_action_enumerate_and_pull(WsManClient * cl,
const char *resource_uri,
client_opt_t * options,
filter_t *filter,
SoapResponseCallback callback,
void *callback_data);
/**
* Create a request envelope based on client data
* @param cl Client handle
* @param resource_uri Resource URI
* @param client_opt_t Request options and flags
* @param action Requested Action (e.g., Get, Put, Create)
* @param method custom method ( can be NULL)
* @param data client data
* @return Request document
*/
WsXmlDocH wsmc_create_request(WsManClient * cl,
const char *resource_uri,
client_opt_t * options,
filter_t *filter,
WsmanAction action,
char *method, void *data);
/**
* Get enumeration context from response
* @param doc Response document
* @return enumeration context
*/
char *wsmc_get_enum_context(WsXmlDocH doc);
/**
* Get enumeration context from subscription response
* @param doc Response document
* @return enumeration context
*/
char *wsmc_get_event_enum_context(WsXmlDocH doc);
/**
* Free enumeration context
* @param enumctx Enumeration context
* @return enumeration context
*/
void wsmc_free_enum_context(char * enumctx);
/**
* Add a selector from URI with query string containing selectors
* @param doc request to add selectors to
* @param resource_uri Resource URI
* @return void
*/
void wsmc_add_selector_from_uri(WsXmlDocH doc,
const char *resource_uri);
/**
* Initialize client requeust options
* @return initialized options structure
*/
client_opt_t *wsmc_options_init(void);
/**
* destroy client request options
* @param options structure
* @return void
*/
void wsmc_options_destroy(client_opt_t * op);
void wsmc_add_selectors_from_str(client_opt_t * options,
const char
*query_string);
void wsmc_add_prop_from_str(client_opt_t * options,
const char
*query_string);
void wsmc_add_selector_from_options(WsXmlDocH doc,
client_opt_t * options);
void wsmc_set_action_option(client_opt_t * options,
unsigned int);
unsigned int wsmc_get_action_option(client_opt_t * options);
void wsmc_clear_action_option(client_opt_t * options,
unsigned int);
void wsmc_set_options_from_uri(const char *resource_uri,
client_opt_t * options);
void wsmc_set_filter(filter_t *filter, client_opt_t * options);
void wsmc_add_option(client_opt_t * options,
const char *key, const char *value);
void wsmc_add_selector(client_opt_t * options,
const char *key, const char *value);
void wsmc_add_selector_epr(client_opt_t * options,
const char *key, const epr_t *value);
void wsmc_add_property_array_item(client_opt_t * options,
const char *key,
const char *value);
void wsmc_add_property(client_opt_t * options,
const char *key, const char *value);
void wsmc_add_property_epr(client_opt_t * options,
const char *key, const epr_t *value);
void wsmc_set_cim_ns(const char *delivery_uri, client_opt_t * options);
void wsmc_set_fragment(const char *fragment, client_opt_t * options);
void wsmc_set_reference(const char *reference, client_opt_t * options);
/* getter/setter for request locale, Section 6.3 of DSP0226 */
void wsmc_set_locale(client_opt_t * options, const char *locale);
char *wsmc_get_locale(client_opt_t * options);
/* Misc */
/* Place holder */
void wsmc_remove_query_string(const char *resource_uri,
char **result);
int wsmc_check_for_fault(WsXmlDocH doc);
void wsmc_node_to_buf(WsXmlNodeH node, char **buf);
char *wsmc_node_to_formatbuf(WsXmlNodeH node);
void wsmc_get_fault_data(WsXmlDocH doc,
WsManFault * fault);
WsManFault *wsmc_fault_new(void);
void wsmc_fault_destroy(WsManFault *fault);
void wsmc_set_dumpfile(WsManClient *cl, FILE * f);
FILE *wsmc_get_dumpfile(WsManClient *cl);
#ifndef _WIN32
void wsmc_set_conffile(WsManClient *cl, char * f);
char * wsmc_get_conffile(WsManClient *cl);
#endif
void
wsmc_set_delivery_uri(const char *delivery_uri, client_opt_t * options);
void
wsmc_set_sub_expiry(int event_subscription_expire, client_opt_t * options);
void
wsmc_set_heartbeat_interval(int heartbeat_interval, client_opt_t * options);
void
wsmc_set_delivery_mode(WsmanDeliveryMode delivery_mode, client_opt_t * options);
void
wsmc_set_delivery_security_mode(WsManDeliverySecurityMode delivery_sec_mode, client_opt_t * options);
/** @} */
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* WSMANCLIENT_H_ */
|