Siebel Portal Framework Guide > Web Engine HTTP TXN Business Service >

Web Engine HTTP TXN Business Service API


Table 29 lists the methods exposed by the Web Engine HTTP TXN Business Service.

Table 29. Web Engine HTTP TXN Business Service API
Method
Description
Parameters

GetAllRequestCookies

Retrieves all request cookies sent from the client to the server.

InputArguments: Ignored.
OutputArguments: Property Set hierarchy. Each cookie is a child Property Set with the TYPE property set to the cookie name.

GetAllRequestHeaders

Retrieves all request headers sent from the client to the server.

InputArguments: Ignored.
OutputArguments: Property Set containing the HTTP Parameter name-value pairs.

GetAllRequestParameters

Retrieves all request parameters sent from the client to the server.

InputArguments: Ignored.
OutputArguments: Property Set containing the HTTP Parameter name-value pairs.

GetAllResponseCookies

Retrieves all response cookies sent from the server to the client.

InputArguments: Ignored.
OutputArguments: Property Set hierarchy. Each cookie is a child Property Set with the TYPE property set to the cookie name.

GetAllResponseHeaders

Retrieves all response headers sent from the server to the client.

InputArguments: Ignored.
OutputArguments: Property Set containing the HTTP Header name-value pairs.

GetAllServerVariables

Retrieves all server variables.

InputArguments: Ignored.
OutputArguments: Property Set containing the Server Variable name-value pairs.

GetClientCertificate

Retrieves the client certificate info.

InputArguments: Ignored.
OutputArguments: Property Set containing certificate name-value pairs. Currently only returns Common Name (CN) property of the certificate.

GetRequestCookies

Retrieves the request cookies named in InputArguments.

InputArguments: Property Set containing the cookie names to retrieve.
OutputArguments: Property Set hierarchy. Each cookie is a child Property Set with the TYPE property set to the cookie name.

GetRequestHeaders

Retrieves the request headers named in InputArguments.

InputArguments: Property Set containing the header names to retrieve.
OutputArguments: Property Set containing the HTTP Header name-value pairs.

GetRequestInfo

Retrieves the request Web Session, Headers, Cookies, Parameters and Client Certificate information in one call.

InputArguments: Ignored
OutputArguments: Property Set hierarchy. Each section is a child Property Set with the TYPE property set to 'Headers', 'Cookies', 'Parameters' or 'ClientCertificate'. The Web Session information is simply stored as properties of OutputArguments.

GetRequestParameters

Retrieves the request parameters named in InputArguments.

InputArguments: Property Set containing the parameter names to retrieve.
OutputArguments: Property Set containing the HTTP Parameter name-value pairs.

GetResponseCookies

Retrieves the response cookies named in InputArguments.

InputArguments: Property Set containing the cookie names to retrieve.
OutputArguments: Property Set hierarchy. Each cookie is a child Property Set with the TYPE property set to the cookie name.

GetResponseHeaders

Retrieves the response headers named in InputArguments.

InputArguments: Property Set containing the header names to retrieve.
OutputArguments: Property Set containing the HTTP Header name-value pairs.

GetResponseInfo

Retrieves the response Headers and Cookies in one call.

InputArguments: Ignored.
OutputArguments: Property Set hierarchy. Each section is a child Property Set with the TYPE property set to 'Headers' or 'Cookies'. Content Type and Status are simply stored as properties of OutputArguments.

GetServerVariables

Retrieves the server variables named in InputArguments.

InputArguments: Property Set containing the server variable names to retrieve.
OutputArguments: Property Set containing the Server Variable name-value pairs.

GetWebSessionInfo

Retrieves the client's Web session information.

InputArguments: Ignored.
OutputArguments: Property Set containing the Web session name-value pairs—SessionName;
Cookie Name;
SessionId;
Web Session ID;
SessionFrom (Value is 'URL' or 'COOKIE').

SetResponseCookies

Sets the response cookies to the values in InputArguments.

InputArguments: Property Set hierarchy. Each cookie is a child Property Set with the TYPE property set to the cookie name. The PERSISTENT property determines whether the cookie persists between sessions. If the value is Y, then the cookie persists between browser sessions. Otherwise, the cookie exists for one session at a time.

OutputArguments: Ignored.

SetResponseHeaders

Sets the response headers to the values in InputArguments.

InputArguments: Property Set containing the HTTP Header name-value pairs.
OutputArguments: Ignored.

SetResponseInfo

Sets the response Headers and Cookies in one call.

InputArguments: Property Set hierarchy. Each section is a child Property Set with the TYPE property set to 'Headers' or 'Cookies'. Content Type and Status are simply stored as properties of InputArguments.
OutputArguments: Ignored.

Siebel Portal Framework Guide Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.