Logo ROOT  
Reference Guide
TS3HTTPRequest Class Reference

Definition at line 45 of file TS3HTTPRequest.h.

Public Types

enum  EAuthType { kNoAuth, kAmazon, kGoogle }
 
enum  EHTTPVerb {
  kGET, kPOST, kPUT, kDELETE,
  kHEAD, kCOPY
}
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 

Public Member Functions

 TS3HTTPRequest ()
 
 TS3HTTPRequest (const TS3HTTPRequest &m)
 Copy constructor. More...
 
 TS3HTTPRequest (EHTTPVerb httpVerb, const TString &host, const TString &bucket, const TString &objectKey, EAuthType authType, const TString &accessKey, const TString &secretKey)
 Default constructor. More...
 
virtual ~TS3HTTPRequest ()
 
const TStringGetAccessKey () const
 
TString GetAuthType () const
 
const TStringGetBucket () const
 
const TStringGetHost () const
 
EHTTPVerb GetHTTPVerb () const
 
const TStringGetObjectKey () const
 
TString GetRequest (TS3HTTPRequest::EHTTPVerb httpVerb, Bool_t appendCRLF=kTRUE)
 Returns the HTTP request ready to be sent to the server. More...
 
const TStringGetSecretKey () const
 
const TStringGetTimeStamp () const
 
TS3HTTPRequestSetAccessKey (const TString &accessKey)
 
TS3HTTPRequestSetAuthKeys (const TString &accessKey, const TString &secretKey)
 
TS3HTTPRequestSetAuthType (TS3HTTPRequest::EAuthType authType)
 
TS3HTTPRequestSetBucket (const TString &bucket)
 
TS3HTTPRequestSetHost (const TString &host)
 
TS3HTTPRequestSetObjectKey (const TString &objectKey)
 
TS3HTTPRequestSetSecretKey (const TString &secretKey)
 
TS3HTTPRequestSetSessionToken (const TString &token)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Protected Member Functions

TString ComputeSignature (TS3HTTPRequest::EHTTPVerb httpVerb) const
 Returns this request's signature. More...
 
TString HTTPVerbToTString (EHTTPVerb httpVerb) const
 
TString MakeAuthHeader (TS3HTTPRequest::EHTTPVerb httpVerb) const
 Returns the authentication header for this HTTP request. More...
 
TString MakeAuthPrefix () const
 Returns the authentication prefix. More...
 
TString MakeDateHeader () const
 Returns the date header for this HTTP request. More...
 
TString MakeHostHeader () const
 Returns the 'Host' header to include in the HTTP request. More...
 
TString MakeRequestLine (TS3HTTPRequest::EHTTPVerb httpVerb) const
 Returns the first line of a HTTP request for this object. More...
 
TString MakeTokenHeader () const
 Returns the session security token header for this HTTP request. More...
 
TS3HTTPRequestSetTimeStamp ()
 Sets this request's time stamp according to: http://code.google.com/apis/storage/docs/reference-headers.html#date. More...
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

Private Attributes

TString fAccessKey
 
EAuthType fAuthType
 
TString fBucket
 
TString fHost
 
TString fObjectKey
 
TString fSecretKey
 
TString fSessionToken
 
TString fTimeStamp
 
EHTTPVerb fVerb
 

Additional Inherited Members

- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <TS3HTTPRequest.h>

Inheritance diagram for TS3HTTPRequest:
[legend]

Member Enumeration Documentation

◆ EAuthType

Enumerator
kNoAuth 
kAmazon 
kGoogle 

Definition at line 56 of file TS3HTTPRequest.h.

◆ EHTTPVerb

Enumerator
kGET 
kPOST 
kPUT 
kDELETE 
kHEAD 
kCOPY 

Definition at line 55 of file TS3HTTPRequest.h.

Constructor & Destructor Documentation

◆ TS3HTTPRequest() [1/3]

TS3HTTPRequest::TS3HTTPRequest ( )

Definition at line 57 of file TS3HTTPRequest.cxx.

◆ TS3HTTPRequest() [2/3]

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

Default constructor.

Definition at line 65 of file TS3HTTPRequest.cxx.

◆ TS3HTTPRequest() [3/3]

TS3HTTPRequest::TS3HTTPRequest ( const TS3HTTPRequest m)

Copy constructor.

Definition at line 81 of file TS3HTTPRequest.cxx.

◆ ~TS3HTTPRequest()

virtual TS3HTTPRequest::~TS3HTTPRequest ( )
inlinevirtual

Definition at line 89 of file TS3HTTPRequest.h.

Member Function Documentation

◆ ComputeSignature()

TString TS3HTTPRequest::ComputeSignature ( TS3HTTPRequest::EHTTPVerb  httpVerb) const
protected

Returns this request's signature.

Definition at line 97 of file TS3HTTPRequest.cxx.

◆ GetAccessKey()

const TString& TS3HTTPRequest::GetAccessKey ( ) const
inline

Definition at line 96 of file TS3HTTPRequest.h.

◆ GetAuthType()

TString TS3HTTPRequest::GetAuthType ( ) const
inline

Definition at line 98 of file TS3HTTPRequest.h.

◆ GetBucket()

const TString& TS3HTTPRequest::GetBucket ( ) const
inline

Definition at line 93 of file TS3HTTPRequest.h.

◆ GetHost()

const TString& TS3HTTPRequest::GetHost ( ) const
inline

Definition at line 92 of file TS3HTTPRequest.h.

◆ GetHTTPVerb()

EHTTPVerb TS3HTTPRequest::GetHTTPVerb ( ) const
inline

Definition at line 91 of file TS3HTTPRequest.h.

◆ GetObjectKey()

const TString& TS3HTTPRequest::GetObjectKey ( ) const
inline

Definition at line 94 of file TS3HTTPRequest.h.

◆ GetRequest()

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

Returns the HTTP request ready to be sent to the server.

Definition at line 253 of file TS3HTTPRequest.cxx.

◆ GetSecretKey()

const TString& TS3HTTPRequest::GetSecretKey ( ) const
inline

Definition at line 97 of file TS3HTTPRequest.h.

◆ GetTimeStamp()

const TString& TS3HTTPRequest::GetTimeStamp ( ) const
inline

Definition at line 95 of file TS3HTTPRequest.h.

◆ HTTPVerbToTString()

TString TS3HTTPRequest::HTTPVerbToTString ( TS3HTTPRequest::EHTTPVerb  httpVerb) const
protected

Definition at line 141 of file TS3HTTPRequest.cxx.

◆ MakeAuthHeader()

TString TS3HTTPRequest::MakeAuthHeader ( TS3HTTPRequest::EHTTPVerb  httpVerb) const
protected

Returns the authentication header for this HTTP request.

Definition at line 238 of file TS3HTTPRequest.cxx.

◆ MakeAuthPrefix()

TString TS3HTTPRequest::MakeAuthPrefix ( ) const
protected

Returns the authentication prefix.

Definition at line 225 of file TS3HTTPRequest.cxx.

◆ MakeDateHeader()

TString TS3HTTPRequest::MakeDateHeader ( ) const
protected

Returns the date header for this HTTP request.

Definition at line 202 of file TS3HTTPRequest.cxx.

◆ MakeHostHeader()

TString TS3HTTPRequest::MakeHostHeader ( ) const
protected

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

Definition at line 194 of file TS3HTTPRequest.cxx.

◆ MakeRequestLine()

TString TS3HTTPRequest::MakeRequestLine ( TS3HTTPRequest::EHTTPVerb  httpVerb) const
protected

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 '/'.

Definition at line 183 of file TS3HTTPRequest.cxx.

◆ MakeTokenHeader()

TString TS3HTTPRequest::MakeTokenHeader ( ) const
protected

Returns the session security token header for this HTTP request.

Definition at line 210 of file TS3HTTPRequest.cxx.

◆ SetAccessKey()

TS3HTTPRequest & TS3HTTPRequest::SetAccessKey ( const TString accessKey)
inline

Definition at line 145 of file TS3HTTPRequest.h.

◆ SetAuthKeys()

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

Definition at line 132 of file TS3HTTPRequest.h.

◆ SetAuthType()

TS3HTTPRequest & TS3HTTPRequest::SetAuthType ( TS3HTTPRequest::EAuthType  authType)
inline

Definition at line 139 of file TS3HTTPRequest.h.

◆ SetBucket()

TS3HTTPRequest & TS3HTTPRequest::SetBucket ( const TString bucket)
inline

Definition at line 120 of file TS3HTTPRequest.h.

◆ SetHost()

TS3HTTPRequest & TS3HTTPRequest::SetHost ( const TString host)
inline

Definition at line 114 of file TS3HTTPRequest.h.

◆ SetObjectKey()

TS3HTTPRequest & TS3HTTPRequest::SetObjectKey ( const TString objectKey)
inline

Definition at line 126 of file TS3HTTPRequest.h.

◆ SetSecretKey()

TS3HTTPRequest & TS3HTTPRequest::SetSecretKey ( const TString secretKey)
inline

Definition at line 151 of file TS3HTTPRequest.h.

◆ SetSessionToken()

TS3HTTPRequest & TS3HTTPRequest::SetSessionToken ( const TString token)
inline

Definition at line 157 of file TS3HTTPRequest.h.

◆ SetTimeStamp()

TS3HTTPRequest & TS3HTTPRequest::SetTimeStamp ( )
protected

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

Definition at line 158 of file TS3HTTPRequest.cxx.

Member Data Documentation

◆ fAccessKey

TString TS3HTTPRequest::fAccessKey
private

Definition at line 65 of file TS3HTTPRequest.h.

◆ fAuthType

EAuthType TS3HTTPRequest::fAuthType
private

Definition at line 60 of file TS3HTTPRequest.h.

◆ fBucket

TString TS3HTTPRequest::fBucket
private

Definition at line 62 of file TS3HTTPRequest.h.

◆ fHost

TString TS3HTTPRequest::fHost
private

Definition at line 61 of file TS3HTTPRequest.h.

◆ fObjectKey

TString TS3HTTPRequest::fObjectKey
private

Definition at line 63 of file TS3HTTPRequest.h.

◆ fSecretKey

TString TS3HTTPRequest::fSecretKey
private

Definition at line 66 of file TS3HTTPRequest.h.

◆ fSessionToken

TString TS3HTTPRequest::fSessionToken
private

Definition at line 67 of file TS3HTTPRequest.h.

◆ fTimeStamp

TString TS3HTTPRequest::fTimeStamp
private

Definition at line 64 of file TS3HTTPRequest.h.

◆ fVerb

EHTTPVerb TS3HTTPRequest::fVerb
private

Definition at line 59 of file TS3HTTPRequest.h.

Libraries for TS3HTTPRequest:
[legend]

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