AWS SDK for C++  1.7.207
AWS SDK for C++
Public Member Functions | Static Public Member Functions | List of all members
Aws::Http::URI Class Reference

#include <URI.h>

Public Member Functions

 URI ()
 
 URI (const Aws::String &)
 
 URI (const char *)
 
URIoperator= (const Aws::String &)
 
URIoperator= (const char *)
 
bool operator== (const URI &) const
 
bool operator== (const Aws::String &) const
 
bool operator== (const char *) const
 
bool operator!= (const URI &) const
 
bool operator!= (const Aws::String &) const
 
bool operator!= (const char *) const
 
Scheme GetScheme () const
 
void SetScheme (Scheme value)
 
const Aws::StringGetAuthority () const
 
void SetAuthority (const Aws::String &value)
 
uint16_t GetPort () const
 
void SetPort (uint16_t value)
 
const Aws::StringGetPath () const
 
Aws::String GetURLEncodedPath () const
 
void SetPath (const Aws::String &value)
 
const Aws::StringGetQueryString () const
 
void SetQueryString (const Aws::String &str)
 
Aws::String GetFormParameters () const
 
void CanonicalizeQueryString ()
 
QueryStringParameterCollection GetQueryStringParameters (bool decode=true) const
 
void AddQueryStringParameter (const char *key, const Aws::String &value)
 
void AddQueryStringParameter (const Aws::Map< Aws::String, Aws::String > &queryStringPairs)
 
Aws::String GetURIString (bool includeQueryString=true) const
 

Static Public Member Functions

static Aws::String URLEncodePath (const Aws::String &path)
 
static Aws::String URLEncodePathRFC3986 (const Aws::String &path)
 

Detailed Description

class modeling universal resource identifier, but implemented for http

Definition at line 41 of file URI.h.

Constructor & Destructor Documentation

◆ URI() [1/3]

Aws::Http::URI::URI ( )

Defaults to http and port 80

◆ URI() [2/3]

Aws::Http::URI::URI ( const Aws::String )

Parses string and sets uri fields

◆ URI() [3/3]

Aws::Http::URI::URI ( const char *  )

Parses string and sets uri fields

Member Function Documentation

◆ AddQueryStringParameter() [1/2]

void Aws::Http::URI::AddQueryStringParameter ( const char *  key,
const Aws::String value 
)

Adds query string parameter to underlying query string.

◆ AddQueryStringParameter() [2/2]

void Aws::Http::URI::AddQueryStringParameter ( const Aws::Map< Aws::String, Aws::String > &  queryStringPairs)

Adds multiple query string parameters to underlying query string.

◆ CanonicalizeQueryString()

void Aws::Http::URI::CanonicalizeQueryString ( )

Cannonicalizes the query string.

◆ GetAuthority()

const Aws::String& Aws::Http::URI::GetAuthority ( ) const
inline

Gets the domain portion of the uri

Definition at line 80 of file URI.h.

◆ GetFormParameters()

Aws::String Aws::Http::URI::GetFormParameters ( ) const

◆ GetPath()

const Aws::String& Aws::Http::URI::GetPath ( ) const
inline

Gets the path portion of the uri e.g. the portion after the first slash after the authority and prior to the query string. This is not url encoded.

Definition at line 102 of file URI.h.

◆ GetPort()

uint16_t Aws::Http::URI::GetPort ( ) const
inline

Gets the port portion of the uri, defaults to 22 for ftp, 80 for http and 443 for https

Definition at line 90 of file URI.h.

◆ GetQueryString()

const Aws::String& Aws::Http::URI::GetQueryString ( ) const
inline

Gets the raw query string including the ?

Definition at line 117 of file URI.h.

◆ GetQueryStringParameters()

QueryStringParameterCollection Aws::Http::URI::GetQueryStringParameters ( bool  decode = true) const

parses query string and returns url decoded key/value mappings from it. Spaces and all url encoded values will not be encoded.

◆ GetScheme()

Scheme Aws::Http::URI::GetScheme ( ) const
inline

scheme or protocol e.g. http, https, ftp

Definition at line 70 of file URI.h.

◆ GetURIString()

Aws::String Aws::Http::URI::GetURIString ( bool  includeQueryString = true) const

Converts the URI to a String usable for its context. e.g. an http request.

◆ GetURLEncodedPath()

Aws::String Aws::Http::URI::GetURLEncodedPath ( ) const
inline

Gets the path portion of the uri, url encodes it and returns it

Definition at line 107 of file URI.h.

◆ operator!=() [1/3]

bool Aws::Http::URI::operator!= ( const URI ) const

◆ operator!=() [2/3]

bool Aws::Http::URI::operator!= ( const Aws::String ) const

◆ operator!=() [3/3]

bool Aws::Http::URI::operator!= ( const char *  ) const

◆ operator=() [1/2]

URI& Aws::Http::URI::operator= ( const Aws::String )

◆ operator=() [2/2]

URI& Aws::Http::URI::operator= ( const char *  )

◆ operator==() [1/3]

bool Aws::Http::URI::operator== ( const URI ) const

◆ operator==() [2/3]

bool Aws::Http::URI::operator== ( const Aws::String ) const

◆ operator==() [3/3]

bool Aws::Http::URI::operator== ( const char *  ) const

◆ SetAuthority()

void Aws::Http::URI::SetAuthority ( const Aws::String value)
inline

Sets the domain portion of the uri

Definition at line 85 of file URI.h.

◆ SetPath()

void Aws::Http::URI::SetPath ( const Aws::String value)

Sets the path portion of the uri. URL encodes it if needed

◆ SetPort()

void Aws::Http::URI::SetPort ( uint16_t  value)
inline

Sets the port portion of the uri, normally you will not have to do this. If the scheme is set to ftp, http or https then the default ports will be set.

Definition at line 96 of file URI.h.

◆ SetQueryString()

void Aws::Http::URI::SetQueryString ( const Aws::String str)

Resets the query string to the raw string. all query string manipulations made before this call will be lost

◆ SetScheme()

void Aws::Http::URI::SetScheme ( Scheme  value)

Sets scheme, if the port is incompaitible with this scheme, the port will automatically be set as well.

◆ URLEncodePath()

static Aws::String Aws::Http::URI::URLEncodePath ( const Aws::String path)
static

URLEncodes the path portions of path (doesn't encode the "/" portion)

◆ URLEncodePathRFC3986()

static Aws::String Aws::Http::URI::URLEncodePathRFC3986 ( const Aws::String path)
static

URLEncodes the path portion of the URI according to RFC3986


The documentation for this class was generated from the following file: