Class Poco::Net::HTTPAuthenticationParams

Library: Net
Package: HTTP
Header: Poco/Net/HTTPAuthenticationParams.h

Description

Collection of name-value pairs of HTTP authentication header (i.e. "realm", "qop", "nonce" in case of digest authentication header).

For NTLM, the base64-encoded NTLM message is available from the "NTLM" property.

Direct Base Classes: NameValueCollection

All Base Classes: NameValueCollection

Member Functions: fromAuthInfo, fromRequest, fromResponse, getRealm, operator =, setRealm, toString

Inherited Functions: add, begin, clear, empty, end, erase, find, get, has, operator =, operator [], set, size, swap

Creates an empty authentication parameters collection.

explicit HTTPAuthenticationParams(
const std::string & authInfo
);

See fromAuthInfo() documentation.

See fromRequest() documentation.

HTTPAuthenticationParams(
const HTTPResponse & response,
const std::string & header = WWW_AUTHENTICATE
);

See fromResponse() documentation.

void fromAuthInfo(
const std::string & authInfo
);

Creates an HTTPAuthenticationParams by parsing authentication information.

void fromRequest(
const HTTPRequest & request
);

Extracts authentication information from the request and creates HTTPAuthenticationParams by parsing it.

Throws a NotAuthenticatedException if no authentication information is contained in request. Throws a InvalidArgumentException if authentication scheme is unknown or invalid.

void fromResponse(
const HTTPResponse & response,
const std::string & header = WWW_AUTHENTICATE
);

Extracts authentication information from the response and creates HTTPAuthenticationParams by parsing it.

Throws a NotAuthenticatedException if no authentication information is contained in response. Throws a InvalidArgumentException if authentication scheme is unknown or invalid.