Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file source file inheritance tree (.pdf) viewVC header viewVC source

Sections: class description function members data members class charts

class TS3HTTPRequest: public TObject


TS3HTTPRequest

An object of this class represents an HTTP request extended to be
compatible with Amazon's S3 protocol.
Specifically, such a request contains an 'Authorization' header with
information used by the S3 server for authenticating this request.
The authentication information is computed based on a pair of access
key and secret key which are both provided to the user by the S3
service provider (e.g. Amazon, Google, etc.).
The secret key is used to compute a signature of selected fields in
the request. The algorithm for computing the signature is documented
in:

Google storage:
 http://code.google.com/apis/storage/docs/reference/v1/developer-guidev1.html#authentication

Amazon:
 http://docs.aws.amazon.com/AmazonS3/latest/dev/S3_Authentication2.html

Function Members (Methods)

public:

virtual	~TS3HTTPRequest()
void	TObject::AbstractMethod(const char* method) const
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	TObject::Browse(TBrowser* b)
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TObject::Clear(Option_t* = "")
virtual TObject*	TObject::Clone(const char* newname = "") const
virtual Int_t	TObject::Compare(const TObject* obj) const
virtual void	TObject::Copy(TObject& object) const
virtual void	TObject::Delete(Option_t* option = "")MENU
virtual Int_t	TObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual void	TObject::Draw(Option_t* option = "")
virtual void	TObject::DrawClass() constMENU
virtual TObject*	TObject::DrawClone(Option_t* option = "") constMENU
virtual void	TObject::Dump() constMENU
virtual void	TObject::Error(const char* method, const char* msgfmt) const
virtual void	TObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual void	TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual void	TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual void	TObject::Fatal(const char* method, const char* msgfmt) const
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
const TString&	GetAccessKey() const
TString	GetAuthType() const
const TString&	GetBucket() const
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
const TString&	GetHost() const
TS3HTTPRequest::EHTTPVerb	GetHTTPVerb() const
virtual const char*	TObject::GetIconName() const
virtual const char*	TObject::GetName() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
const TString&	GetObjectKey() const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
TString	GetRequest(TS3HTTPRequest::EHTTPVerb httpVerb, Bool_t appendCRLF = kTRUE)
const TString&	GetSecretKey() const
const TString&	GetTimeStamp() const
virtual const char*	TObject::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TObject::Hash() const
virtual void	TObject::Info(const char* method, const char* msgfmt) const
virtual Bool_t	TObject::InheritsFrom(const char* classname) const
virtual Bool_t	TObject::InheritsFrom(const TClass* cl) const
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TObject::IsFolder() const
Bool_t	TObject::IsOnHeap() const
virtual Bool_t	TObject::IsSortable() const
Bool_t	TObject::IsZombie() const
virtual void	TObject::ls(Option_t* option = "") const
void	TObject::MayNotUse(const char* method) const
virtual Bool_t	TObject::Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
void	TObject::operator delete(void* ptr)
void	TObject::operator delete(void* ptr, void* vp)
void	TObject::operator delete[](void* ptr)
void	TObject::operator delete[](void* ptr, void* vp)
void*	TObject::operator new(size_t sz)
void*	TObject::operator new(size_t sz, void* vp)
void*	TObject::operator new[](size_t sz)
void*	TObject::operator new[](size_t sz, void* vp)
TS3HTTPRequest&	operator=(const TS3HTTPRequest&)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
virtual void	TObject::Print(Option_t* option = "") const
virtual Int_t	TObject::Read(const char* name)
virtual void	TObject::RecursiveRemove(TObject* obj)
void	TObject::ResetBit(UInt_t f)
virtual void	TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual void	TObject::SavePrimitive(ostream& out, Option_t* option = "")
TS3HTTPRequest&	SetAccessKey(const TString& accessKey)
TS3HTTPRequest&	SetAuthKeys(const TString& accessKey, const TString& secretKey)
TS3HTTPRequest&	SetAuthType(TS3HTTPRequest::EAuthType authType)
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
TS3HTTPRequest&	SetBucket(const TString& bucket)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
TS3HTTPRequest&	SetHost(const TString& host)
TS3HTTPRequest&	SetObjectKey(const TString& objectKey)
static void	TObject::SetObjectStat(Bool_t stat)
TS3HTTPRequest&	SetSecretKey(const TString& secretKey)
virtual void	TObject::SetUniqueID(UInt_t uid)
virtual void	ShowMembers(TMemberInspector& insp) const
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
Bool_t	TObject::TestBit(UInt_t f) const
Int_t	TObject::TestBits(UInt_t f) const
	TS3HTTPRequest()
	TS3HTTPRequest(const TS3HTTPRequest& m)
	TS3HTTPRequest(TS3HTTPRequest::EHTTPVerb httpVerb, const TString& host, const TString& bucket, const TString& objectKey, TS3HTTPRequest::EAuthType authType, const TString& accessKey, const TString& secretKey)
virtual void	TObject::UseCurrentStyle()
virtual void	TObject::Warning(const char* method, const char* msgfmt) const
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const

protected:

TString	ComputeSignature(TS3HTTPRequest::EHTTPVerb httpVerb) const
virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
TString	HTTPVerbToTString(TS3HTTPRequest::EHTTPVerb httpVerb) const
TString	MakeAuthHeader(TS3HTTPRequest::EHTTPVerb httpVerb) const
TString	MakeAuthPrefix() const
TString	MakeDateHeader() const
TString	MakeHostHeader() const
TString	MakeRequestLine(TS3HTTPRequest::EHTTPVerb httpVerb) const
void	TObject::MakeZombie()
TS3HTTPRequest&	SetTimeStamp()

Data Members

public:

static TS3HTTPRequest::EAuthType	kAmazon
static TObject::(anonymous)	TObject::kBitMask
static TS3HTTPRequest::EHTTPVerb	kCOPY
static TObject::EStatusBits	TObject::kCanDelete
static TObject::EStatusBits	TObject::kCannotPick
static TS3HTTPRequest::EHTTPVerb	kDELETE
static TS3HTTPRequest::EHTTPVerb	kGET
static TS3HTTPRequest::EAuthType	kGoogle
static TS3HTTPRequest::EHTTPVerb	kHEAD
static TObject::EStatusBits	TObject::kHasUUID
static TObject::EStatusBits	TObject::kInvalidObject
static TObject::(anonymous)	TObject::kIsOnHeap
static TObject::EStatusBits	TObject::kIsReferenced
static TObject::EStatusBits	TObject::kMustCleanup
static TS3HTTPRequest::EAuthType	kNoAuth
static TObject::EStatusBits	TObject::kNoContextMenu
static TObject::(anonymous)	TObject::kNotDeleted
static TObject::EStatusBits	TObject::kObjInCanvas
static TObject::(anonymous)	TObject::kOverwrite
static TS3HTTPRequest::EHTTPVerb	kPOST
static TS3HTTPRequest::EHTTPVerb	kPUT
static TObject::(anonymous)	TObject::kSingleKey
static TObject::(anonymous)	TObject::kWriteDelete
static TObject::(anonymous)	TObject::kZombie

private:

TString	fAccessKey	Access key (for authentication)
TS3HTTPRequest::EAuthType	fAuthType	Authentication type
TString	fBucket	Bucket name
TString	fHost	Host name
TString	fObjectKey	Object key
TString	fSecretKey	Secret key (for authentication)
TString	fTimeStamp	Request time stamp
TS3HTTPRequest::EHTTPVerb	fVerb	HTTP Verb

Class Charts

Inheritance Chart:

TObject

←

TS3HTTPRequest

Function documentation

TS3HTTPRequest()

TS3HTTPRequest(TS3HTTPRequest::EHTTPVerb httpVerb, const TString& host, const TString& bucket, const TString& objectKey, TS3HTTPRequest::EAuthType authType, const TString& accessKey, const TString& secretKey)

 Default constructor

TS3HTTPRequest(const TS3HTTPRequest& m)

 Copy constructor

TString ComputeSignature(TS3HTTPRequest::EHTTPVerb httpVerb) const

 Returns this request's signature

TString HTTPVerbToTString(TS3HTTPRequest::EHTTPVerb httpVerb) const

TS3HTTPRequest& SetTimeStamp()

 Sets this request's time stamp according to:
   http://code.google.com/apis/storage/docs/reference-headers.html#date

TString MakeRequestLine(TS3HTTPRequest::EHTTPVerb httpVerb) const

 Returns the first line of a HTTP request for this object. Note that since
 we don't use the virtual host syntax which is supported by Amazon, we
 must include the bucket name in thr resource. For example, we don't use
 http://mybucket.s3.amazonaws.com/path/to/my/file but instead
 http://s3.amazonaws.com/mybucket/path/to/my/file so the HTTP request
 will be of the form "GET /mybucket/path/to/my/file HTTP/1.1"
 Also note that the path must include the leading '/'.

TString MakeHostHeader() const

 Returns the 'Host' header to include in the HTTP request.

TString MakeDateHeader() const

 Returns the date header for this HTTP request

TString MakeAuthPrefix() const

 Returns the authentication prefix

TString MakeAuthHeader(TS3HTTPRequest::EHTTPVerb httpVerb) const

 Returns the authentication header for this HTTP request

TString GetRequest(TS3HTTPRequest::EHTTPVerb httpVerb, Bool_t appendCRLF = kTRUE)

 Returns the HTTP request ready to be sent to the server

TS3HTTPRequest& SetHost(const TString& host)

TS3HTTPRequest& SetBucket(const TString& bucket)

TS3HTTPRequest& SetObjectKey(const TString& objectKey)

TS3HTTPRequest& SetAuthKeys(const TString& accessKey, const TString& secretKey)

TS3HTTPRequest& SetAuthType(TS3HTTPRequest::EAuthType authType)

TS3HTTPRequest& SetAccessKey(const TString& accessKey)

TS3HTTPRequest& SetSecretKey(const TString& secretKey)

virtual ~TS3HTTPRequest()

{ }

EHTTPVerb GetHTTPVerb() const

{ return fVerb; }

const TString& GetHost() const

{ return fHost; }

const TString& GetBucket() const

{ return fBucket; }

const TString& GetObjectKey() const

{ return fObjectKey; }

const TString& GetTimeStamp() const

{ return fTimeStamp; }

const TString& GetAccessKey() const

{ return fAccessKey; }

const TString& GetSecretKey() const

{ return fSecretKey; }

TString GetAuthType() const

{ return fAuthType; }