ROOT
6.06/09
Reference Guide
|
Definition at line 49 of file TS3HTTPRequest.h.
Public Types | |
enum | EHTTPVerb { kGET, kPOST, kPUT, kDELETE, kHEAD, kCOPY } |
enum | EAuthType { kNoAuth, kAmazon, kGoogle } |
Public Types inherited from TObject | |
enum | EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) } |
enum | { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff } |
enum | { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) } |
Public Member Functions | |
TS3HTTPRequest () | |
TS3HTTPRequest (EHTTPVerb httpVerb, const TString &host, const TString &bucket, const TString &objectKey, EAuthType authType, const TString &accessKey, const TString &secretKey) | |
Default constructor. More... | |
TS3HTTPRequest (const TS3HTTPRequest &m) | |
Copy constructor. More... | |
virtual | ~TS3HTTPRequest () |
EHTTPVerb | GetHTTPVerb () const |
const TString & | GetHost () const |
const TString & | GetBucket () const |
const TString & | GetObjectKey () const |
const TString & | GetTimeStamp () const |
const TString & | GetAccessKey () const |
const TString & | GetSecretKey () const |
TString | GetAuthType () const |
TString | GetRequest (TS3HTTPRequest::EHTTPVerb httpVerb, Bool_t appendCRLF=kTRUE) |
Returns the HTTP request ready to be sent to the server. More... | |
TS3HTTPRequest & | SetHost (const TString &host) |
TS3HTTPRequest & | SetBucket (const TString &bucket) |
TS3HTTPRequest & | SetObjectKey (const TString &objectKey) |
TS3HTTPRequest & | SetAccessKey (const TString &accessKey) |
TS3HTTPRequest & | SetSecretKey (const TString &secretKey) |
TS3HTTPRequest & | SetAuthKeys (const TString &accessKey, const TString &secretKey) |
TS3HTTPRequest & | SetAuthType (TS3HTTPRequest::EAuthType authType) |
Public Member Functions inherited from TObject | |
TObject () | |
TObject (const TObject &object) | |
TObject copy ctor. More... | |
TObject & | operator= (const TObject &rhs) |
TObject assignment operator. More... | |
virtual | ~TObject () |
TObject destructor. 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... | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. More... | |
virtual void | Clear (Option_t *="") |
virtual TObject * | Clone (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 TObject * | DrawClone (Option_t *option="") const |
Draw a clone of this object in the current pad. More... | |
virtual void | Dump () const |
Dump contents of object on stdout. 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 TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. More... | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. More... | |
virtual Option_t * | GetDrawOption () const |
Get option used by the graphics system to draw this object. More... | |
virtual UInt_t | GetUniqueID () const |
Return the unique object id. More... | |
virtual const char * | GetName () const |
Returns name of object. More... | |
virtual const char * | GetIconName () const |
Returns mime type name of object. More... | |
virtual Option_t * | GetOption () const |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
Returns string containing info about the object at position (px,py). More... | |
virtual const char * | GetTitle () const |
Returns title of object. 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... | |
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... | |
virtual Bool_t | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More... | |
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 | IsSortable () const |
Bool_t | IsOnHeap () const |
Bool_t | IsZombie () const |
virtual Bool_t | Notify () |
This method must be overridden to handle object notification. More... | |
virtual void | ls (Option_t *option="") const |
The ls function lists the contents of a class on stdout. 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... | |
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... | |
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 | UseCurrentStyle () |
Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. 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... | |
void * | operator new (size_t sz) |
void * | operator new[] (size_t sz) |
void * | operator new (size_t sz, void *vp) |
void * | operator new[] (size_t sz, void *vp) |
void | operator delete (void *ptr) |
Operator delete. More... | |
void | operator delete[] (void *ptr) |
Operator delete []. More... | |
void | SetBit (UInt_t f, Bool_t set) |
Set or unset the user status bits as specified in f. More... | |
void | SetBit (UInt_t f) |
void | ResetBit (UInt_t f) |
Bool_t | TestBit (UInt_t f) const |
Int_t | TestBits (UInt_t f) const |
void | InvertBit (UInt_t f) |
virtual void | Info (const char *method, const char *msgfmt,...) const |
Issue info message. More... | |
virtual void | Warning (const char *method, const char *msgfmt,...) const |
Issue warning message. More... | |
virtual void | Error (const char *method, const char *msgfmt,...) const |
Issue error message. More... | |
virtual void | SysError (const char *method, const char *msgfmt,...) const |
Issue system error message. More... | |
virtual void | Fatal (const char *method, const char *msgfmt,...) const |
Issue fatal error message. 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... | |
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... | |
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
Use this method to declare a method obsolete. More... | |
Protected Member Functions | |
TString | HTTPVerbToTString (EHTTPVerb httpVerb) const |
TString | MakeRequestLine (TS3HTTPRequest::EHTTPVerb httpVerb) const |
Returns the first line of a HTTP request for this object. More... | |
TString | MakeAuthHeader (TS3HTTPRequest::EHTTPVerb httpVerb) const |
Returns the authentication header for this HTTP request. More... | |
TString | ComputeSignature (TS3HTTPRequest::EHTTPVerb httpVerb) const |
Returns this request's signature. More... | |
TString | MakeAuthPrefix () const |
Returns the authentication prefix. More... | |
TString | MakeHostHeader () const |
Returns the 'Host' header to include in the HTTP request. More... | |
TString | MakeDateHeader () const |
Returns the date header for this HTTP request. More... | |
TS3HTTPRequest & | SetTimeStamp () |
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 | |
void | MakeZombie () |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). More... | |
Private Attributes | |
EHTTPVerb | fVerb |
EAuthType | fAuthType |
TString | fHost |
TString | fBucket |
TString | fObjectKey |
TString | fTimeStamp |
TString | fAccessKey |
TString | fSecretKey |
Additional Inherited Members | |
Static Public Member Functions inherited from TObject | |
static Long_t | GetDtorOnly () |
Return destructor only flag. More... | |
static void | SetDtorOnly (void *obj) |
Set destructor only flag. More... | |
static Bool_t | GetObjectStat () |
Get status of object stat flag. More... | |
static void | SetObjectStat (Bool_t stat) |
Turn on/off tracking of objects in the TObjectTable. More... | |
#include <TS3HTTPRequest.h>
Enumerator | |
---|---|
kNoAuth | |
kAmazon | |
kGoogle |
Definition at line 54 of file TS3HTTPRequest.h.
Enumerator | |
---|---|
kGET | |
kPOST | |
kPUT | |
kDELETE | |
kHEAD | |
kCOPY |
Definition at line 53 of file TS3HTTPRequest.h.
TS3HTTPRequest::TS3HTTPRequest | ( | ) |
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::TS3HTTPRequest | ( | const TS3HTTPRequest & | m | ) |
Copy constructor.
Definition at line 81 of file TS3HTTPRequest.cxx.
|
inlinevirtual |
Definition at line 85 of file TS3HTTPRequest.h.
|
protected |
Returns this request's signature.
Definition at line 97 of file TS3HTTPRequest.cxx.
Referenced by MakeAuthHeader().
|
inline |
Definition at line 92 of file TS3HTTPRequest.h.
Referenced by TS3WebFile::GetAccessKey().
|
inline |
Definition at line 94 of file TS3HTTPRequest.h.
|
inline |
Definition at line 89 of file TS3HTTPRequest.h.
Referenced by TS3WebFile::GetBucket().
|
inline |
Definition at line 88 of file TS3HTTPRequest.h.
|
inline |
Definition at line 87 of file TS3HTTPRequest.h.
|
inline |
Definition at line 90 of file TS3HTTPRequest.h.
Referenced by TS3WebFile::GetObjectKey().
TString TS3HTTPRequest::GetRequest | ( | TS3HTTPRequest::EHTTPVerb | httpVerb, |
Bool_t | appendCRLF = kTRUE |
||
) |
Returns the HTTP request ready to be sent to the server.
Definition at line 232 of file TS3HTTPRequest.cxx.
Referenced by TS3WebFile::GetHead(), TS3WebFile::ReadBuffers(), and TS3WebFile::SetMsgReadBuffer10().
|
inline |
Definition at line 93 of file TS3HTTPRequest.h.
Referenced by TS3WebFile::GetSecretKey().
|
inline |
Definition at line 91 of file TS3HTTPRequest.h.
|
protected |
Definition at line 135 of file TS3HTTPRequest.cxx.
Referenced by ComputeSignature(), and MakeRequestLine().
|
protected |
Returns the authentication header for this HTTP request.
Definition at line 217 of file TS3HTTPRequest.cxx.
Referenced by GetRequest().
|
protected |
Returns the authentication prefix.
Definition at line 204 of file TS3HTTPRequest.cxx.
Referenced by MakeAuthHeader().
|
protected |
Returns the date header for this HTTP request.
Definition at line 196 of file TS3HTTPRequest.cxx.
Referenced by GetRequest().
|
protected |
Returns the 'Host' header to include in the HTTP request.
Definition at line 188 of file TS3HTTPRequest.cxx.
Referenced by GetRequest().
|
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 177 of file TS3HTTPRequest.cxx.
Referenced by GetRequest().
|
inline |
Definition at line 146 of file TS3HTTPRequest.h.
Referenced by TS3WebFile::SetAccessKey().
|
inline |
Definition at line 133 of file TS3HTTPRequest.h.
|
inline |
Definition at line 140 of file TS3HTTPRequest.h.
|
inline |
Definition at line 121 of file TS3HTTPRequest.h.
|
inline |
Definition at line 115 of file TS3HTTPRequest.h.
|
inline |
Definition at line 127 of file TS3HTTPRequest.h.
|
inline |
Definition at line 152 of file TS3HTTPRequest.h.
Referenced by TS3WebFile::SetSecretKey().
|
protected |
Sets this request's time stamp according to: http://code.google.com/apis/storage/docs/reference-headers.html#date.
Definition at line 152 of file TS3HTTPRequest.cxx.
Referenced by GetRequest().
|
private |
Definition at line 63 of file TS3HTTPRequest.h.
Referenced by GetAccessKey(), MakeAuthHeader(), SetAccessKey(), SetAuthKeys(), and TS3HTTPRequest().
|
private |
Definition at line 58 of file TS3HTTPRequest.h.
Referenced by ComputeSignature(), GetAuthType(), MakeAuthHeader(), MakeAuthPrefix(), SetAuthType(), and TS3HTTPRequest().
|
private |
Definition at line 60 of file TS3HTTPRequest.h.
Referenced by ComputeSignature(), GetBucket(), MakeRequestLine(), SetBucket(), and TS3HTTPRequest().
|
private |
Definition at line 59 of file TS3HTTPRequest.h.
Referenced by GetHost(), MakeHostHeader(), SetHost(), and TS3HTTPRequest().
|
private |
Definition at line 61 of file TS3HTTPRequest.h.
Referenced by ComputeSignature(), GetObjectKey(), MakeRequestLine(), SetObjectKey(), and TS3HTTPRequest().
|
private |
Definition at line 64 of file TS3HTTPRequest.h.
Referenced by ComputeSignature(), GetSecretKey(), SetAuthKeys(), SetSecretKey(), and TS3HTTPRequest().
|
private |
Definition at line 62 of file TS3HTTPRequest.h.
Referenced by ComputeSignature(), GetTimeStamp(), MakeDateHeader(), SetTimeStamp(), and TS3HTTPRequest().
|
private |
Definition at line 57 of file TS3HTTPRequest.h.
Referenced by GetHTTPVerb(), and TS3HTTPRequest().