Zend_Service_WindowsAzure_Blob.xml 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 19991 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.service.windowsazure.storage.blob">
  5. <title>Zend_Service_WindowsAzure_Storage_Blob</title>
  6. <para>
  7. Blob Speicher speichert ein Set von Binären Daten. Blog Speicher bietet die folgenden drei
  8. Ressourcen an: den Speicher Account, Container und Blobs. Im eigenen Speicher Account bieten
  9. Container einen Weg um Sets von Blobs im Speicher Account zu organisieren.
  10. </para>
  11. <para>
  12. Blog Speicher wird von Windows Azure als <acronym>REST</acronym> API angeboten welcher von
  13. der Klasse <classname>Zend_Service_WindowsAzure_Storage_Blob</classname> umhüllt ist um ein
  14. natives PHP Interface zum Speicher Account zu bieten.
  15. </para>
  16. <sect2 id="zend.service.windowsazure.storage.blob.api">
  17. <title>API Beispiele</title>
  18. <para>
  19. Dieser Abschnitt zeigt einige Beispiele der Verwendung der Klasse
  20. <classname>Zend_Service_WindowsAzure_Storage_Blob</classname>. Andere Features sind im
  21. Download Paket vorhanden sowie in der detailierten API Dokumentation dieser Features.
  22. </para>
  23. <sect3 id="zend.service.windowsazure.storage.blob.api.create-container">
  24. <title>Erstellung einer Speicher Containers</title>
  25. <para>
  26. Bei Verwendung des folgenden Codes kann ein Speicher Container auf dem Development
  27. Speicher erstellt werden.
  28. </para>
  29. <example id="zend.service.windowsazure.storage.blob.api.create-container">
  30. <title>Erstellung eines Speicher Containers</title>
  31. <programlisting language="php"><![CDATA[
  32. $storageClient = new Zend_Service_WindowsAzure_Storage_Blob();
  33. $result = $storageClient->createContainer('testcontainer');
  34. echo 'Der Name des Containers ist: ' . $result->Name;
  35. ]]></programlisting>
  36. </example>
  37. </sect3>
  38. <sect3 id="zend.service.windowsazure.storage.blob.api.delete-container">
  39. <title>Löschen eines Speicher Containers</title>
  40. <para>
  41. Bei Verwendung des folgenden Codes kann ein Blob Speicher Container vom Development
  42. Speicher entfernt werden.
  43. </para>
  44. <example id="zend.service.windowsazure.storage.blob.api.delete-container">
  45. <title>Löschen eines Speicher Containers</title>
  46. <programlisting role="php"><![CDATA[
  47. $storageClient = new Zend_Service_WindowsAzure_Storage_Blob();
  48. $storageClient->deleteContainer('testcontainer');
  49. ]]></programlisting>
  50. </example>
  51. </sect3>
  52. <sect3 id="zend.service.windowsazure.storage.blob.api.storing-blob">
  53. <title>Speichern eines Blobs</title>
  54. <para>
  55. Bei Verwendung des folgenden Codes kann ein Blob zu einem Blog Speicher Container
  56. auf dem Development Speichers hochgeladen werden. Es ist zu beachten das der
  57. Container hierfür bereits vorher erstellt worden sein muss.
  58. </para>
  59. <example id="zend.service.windowsazure.storage.blob.api.storing-blob">
  60. <title>Speichern eines Blobs</title>
  61. <programlisting language="php"><![CDATA[
  62. $storageClient = new Zend_Service_WindowsAzure_Storage_Blob();
  63. // /home/maarten/example.txt auf Azure hochladen
  64. $result = $storageClient->putBlob(
  65. 'testcontainer', 'example.txt', '/home/maarten/example.txt'
  66. );
  67. echo 'Der Name des Blobs ist: ' . $result->Name;
  68. ]]></programlisting>
  69. </example>
  70. </sect3>
  71. <sect3 id="zend.service.windowsazure.storage.blob.api.copy-blob">
  72. <title>Kopieren eines Blobs</title>
  73. <para>
  74. Bei Verwendung des folgenden Codes kann ein Blob von innerhalb des Speicher Accounts
  75. kopiert werden. Der Vorteil der Verwendung dieser Methode besteht darin das die
  76. Kopieroperation in der Azure Wolke stattfindet und kein Downloaden vom Blob
  77. stattfinden muss. Es ist zu beachten das in diesem Fall der Container bereits vorher
  78. erstellt worden sein muss.
  79. </para>
  80. <example id="zend.service.windowsazure.storage.blob.api.copy-blob">
  81. <title>Kopieren eines Blobs</title>
  82. <programlisting language="php"><![CDATA[
  83. $storageClient = new Zend_Service_WindowsAzure_Storage_Blob();
  84. // Kopiert example.txt auf example2.txt
  85. $result = $storageClient->copyBlob(
  86. 'testcontainer', 'example.txt', 'testcontainer', 'example2.txt'
  87. );
  88. echo 'Der Name des kopierten Blobs ist: ' . $result->Name;
  89. ]]></programlisting>
  90. </example>
  91. </sect3>
  92. <sect3 id="zend.service.windowsazure.storage.blob.api.download-blob">
  93. <title>Herunterladen eines Blobs</title>
  94. <para>
  95. Bei Verwendung des folgenden Codes kann ein Blob von einem Blob Speicher Container
  96. auf den Development Speicher heruntergeladen werden. Es ist zu beachten das der
  97. Container hierfür bereits vorher erstellt wurden sein und ein Blob darauf
  98. hochgeladen sein muss.
  99. </para>
  100. <example id="zend.service.windowsazure.storage.blob.api.download-blob">
  101. <title>Herunterladen eines Blobs</title>
  102. <programlisting language="php"><![CDATA[
  103. $storageClient = new Zend_Service_WindowsAzure_Storage_Blob();
  104. // Lädt die Datei /home/maarten/example.txt herunter
  105. $storageClient->getBlob(
  106. 'testcontainer', 'example.txt', '/home/maarten/example.txt'
  107. );
  108. ]]></programlisting>
  109. </example>
  110. </sect3>
  111. <sect3 id="zend.service.windowsazure.storage.blob.api.public-blob">
  112. <title>Einen Blob öffentlich verfügbar machen</title>
  113. <para>
  114. Standardmäßig sind Blob Speicher Container in Windows Azure geschützt vor
  115. öffentlichem Zugriff. Wenn ein Benutzer im Internet Zugriff auf einen Blob Container
  116. haben soll, kann seine ACL auf öffentlich (public) gesetzt werden. Es ist zu
  117. beachten dass das auf den kompletten Container angewendet wird, und nicht auf einen
  118. einzelnen Blob!
  119. </para>
  120. <para>
  121. Bei Verwendung des folgenden Codes kann die ACL eines Blob Speicher Containers auf
  122. den Development Speicher gesetzt werden. Es ist zu beachten das der Container
  123. hierfür bereits vorher erstellt worden sein muss.
  124. </para>
  125. <example id="zend.service.windowsazure.storage.blob.api.public-blob">
  126. <title>Einen Blob öffentlich zugänglich machen</title>
  127. <programlisting language="php"><![CDATA[
  128. $storageClient = new Zend_Service_WindowsAzure_Storage_Blob();
  129. // Den Container öffentlich zugänglich machen
  130. $storageClient->setContainerAcl('testcontainer', Zend_Service_WindowsAzure_Storage_Blob::ACL_PUBLIC);
  131. ]]></programlisting>
  132. </example>
  133. </sect3>
  134. </sect2>
  135. <sect2 id="zend.service.windowsazure.storage.blob.root">
  136. <title>Stamm Container</title>
  137. <para>
  138. Der Windows Azure Blob Speicher bietet Unterstützung für die Arbeit mit einem "Stamm
  139. Container" (root). Das bedeutet das ein Blob im Stamm des Speicher Containers
  140. gespeichert werden kann, z.B.
  141. <code>http://myaccount.blob.core.windows.net/somefile.txt</code>.
  142. </para>
  143. <para>
  144. Um mit dem Stamm Container zu arbieten sollte er zuerst durch Verwendung der
  145. <methodname>createContainer()</methodname> Methode erstellt worden sein, und der
  146. Container sollte <varname>$root</varname> heißen. Alle anderen Operationen auf dem
  147. Stamm Container sollten ausgeführt werden indem der Containernamen auf
  148. <varname>$root</varname> gesetzt wird.
  149. </para>
  150. </sect2>
  151. <sect2 id="zend.service.windowsazure.storage.blob.wrapper">
  152. <title>Blob Speicher Stream Wrapper</title>
  153. <para>
  154. Die Windows Azure SDK für PHP bietet Unterstützung für die Registrierung eines Blob
  155. Speicher Clients als PHP File Stream Wrapper. Der Blob Speicher Stream Wrapper bietet
  156. Unterstützung für die Verwendung von regulären Datei Operationen auf dem Windows Azure
  157. Blob Speicher. Zum Beispiel kan eine Datei vom Windows Azure Blob Speicher aus mit der
  158. Funktion <functionname>fopen()</functionname> geöffnet werden:
  159. </para>
  160. <example id="zend.service.windowsazure.storage.blob.wrapper.sample">
  161. <title>Beispiel der Verwendung des Blob Speicher Stream Wrappers</title>
  162. <programlisting language="php"><![CDATA[
  163. $fileHandle = fopen('azure://mycontainer/myfile.txt', 'r');
  164. // ...
  165. fclose($fileHandle);
  166. ]]></programlisting>
  167. </example>
  168. <para>
  169. Um das zu tun muss die Windows Azure SDK für den PHP Blob Speicher Client als Stream
  170. Wrapper registriert werden. Das kann getan werden indem die Methode
  171. <methodname>registerStreamWrapper()</methodname> aufgerufen wird:
  172. </para>
  173. <example id="zend.service.windowsazure.storage.blob.wrapper.register">
  174. <title>Den Blob Speicher Stream Wrapper registrieren</title>
  175. <programlisting language="php"><![CDATA[
  176. $storageClient = new Zend_Service_WindowsAzure_Storage_Blob();
  177. // registriert azure:// auf diesem Speicher Client
  178. $storageClient->registerStreamWrapper();
  179. // oder:
  180. // registriert blob:// auf diesem Speicher Client
  181. $storageClient->registerStreamWrapper('blob://');
  182. ]]></programlisting>
  183. </example>
  184. <para>
  185. Um den Stream Wrapper zu deregistrieren kann die Methode
  186. <methodname>unregisterStreamWrapper()</methodname> verwendet werden.
  187. </para>
  188. </sect2>
  189. <sect2 id="zend.service.windowsazure.storage.blob.sharedaccesssig">
  190. <title>Shared Access Signaturen</title>
  191. <para>
  192. Der Windows Azure Bolb Speicher bietet ein Feature welches "Shared Access Signatures"
  193. genannt wird. Standardmäßig gibt es nur ein Level der Authorosierung welche in Windows
  194. Azure Blob Speicher möglich ist: entweder ist ein Container privat oder er ist
  195. öffentlich. Shared Access Signaturen bieten eine feinere Methode der Authorisierung:
  196. Lese-, Schreib-, Lösch- und Anzeigerechte können auf einem Container oder einem Blob
  197. für einen speziellen Client zugeordnet werden indem ein URL-basierendes Modell verwendet
  198. wird.
  199. </para>
  200. <para>
  201. Ein Beispiel würde die folgende Signatur sein:
  202. </para>
  203. <literallayout>
  204. http://phpstorage.blob.core.windows.net/phpazuretestshared1?st=2009-08-17T09%3A06%3A17Z&amp;se=2009-08-17T09%3A56%3A17Z&amp;sr=c&amp;sp=w&amp;sig=hscQ7Su1nqd91OfMTwTkxabhJSaspx%2BD%2Fz8UqZAgn9s%3D
  205. </literallayout>
  206. <para>
  207. Die obige Signatur gibt Schreibrechte auf den Container "phpazuretestshared1" des
  208. Accounts "phpstorage".
  209. </para>
  210. <sect3 id="zend.service.windowsazure.storage.blob.sharedaccesssig.generate">
  211. <title>Erstellen einer Shared Access Signature</title>
  212. <para>
  213. Wenn man Eigentümer eines Windows Azure Blob Speicher Accounts ist kann man einen
  214. geteilten Zugriffsschlüssel für jeden Typ einer Ressource im eigenen Account
  215. erstellen und teilen. Um das zu tun kann die Methode
  216. <methodname>generateSharedAccessUrl()</methodname> des
  217. <classname>Zend_Service_WindowsAzure_Storage_Blob</classname> Speicher Clients
  218. verwendet werden.
  219. </para>
  220. <para>
  221. Der folgende Beispielcode erzeugt eine Shared Access Signatur für den
  222. Schreibzugriff in einem Container der "container1" heißt, in einem Zeitrahmen von
  223. 3000 Sekunden.
  224. </para>
  225. <example id="zend.service.windowsazure.storage.blob.sharedaccesssig.generate-2">
  226. <title>Erstellung einer Shared Access Signatur für einen Container</title>
  227. <programlisting language="php"><![CDATA[
  228. $storageClient = new Zend_Service_WindowsAzure_Storage_Blob();
  229. $sharedAccessUrl = storageClient->generateSharedAccessUrl(
  230. 'container1',
  231. '',
  232. 'c',
  233. 'w',
  234. $storageClient ->isoDate(time() - 500),
  235. $storageClient ->isoDate(time() + 3000)
  236. );
  237. ]]></programlisting>
  238. </example>
  239. <para>
  240. Der folgende Beispielcode erzeugt eine Shared Access Signatur für den Lesezugriff in
  241. einem Blob der <filename>test.txt</filename> heißt und einem Container der
  242. "container1" heißt, in einem Zeitrahmen von 3000 Sekunden.
  243. </para>
  244. <example id="zend.service.windowsazure.storage.blob.sharedaccesssig-generate-3">
  245. <title>Erzeugen einer Shared Access Signatur für einen Blob</title>
  246. <programlisting language="php"><![CDATA[
  247. $storageClient = new Zend_Service_WindowsAzure_Storage_Blob();
  248. $sharedAccessUrl = storageClient->generateSharedAccessUrl(
  249. 'container1',
  250. 'test.txt',
  251. 'b',
  252. 'r',
  253. $storageClient ->isoDate(time() - 500),
  254. $storageClient ->isoDate(time() + 3000)
  255. );
  256. ]]></programlisting>
  257. </example>
  258. </sect3>
  259. <sect3 id="zend.service.windowsazure.storage.blob.sharedaccesssig.consume">
  260. <title>Arbeiten mit Shared Access Signaturen von anderen</title>
  261. <para>
  262. Wenn man eine Shared Access Signatur von jemandem anderen erhält kann man die
  263. Windows Azure SDK für PHP verwenden um mit der adressierten Ressource zu arbeiten.
  264. Zum Beispiel kann man die folgende Signatur vom Eigentümer eines Speicher Accounts
  265. erhalten:
  266. </para>
  267. <literallayout>
  268. http://phpstorage.blob.core.windows.net/phpazuretestshared1?st=2009-08-17T09%3A06%3A17Z&amp;se=2009-08-17T09%3A56%3A17Z&amp;sr=c&amp;sp=w&amp;sig=hscQ7Su1nqd91OfMTwTkxabhJSaspx%2BD%2Fz8UqZAgn9s%3D
  269. </literallayout>
  270. <para>
  271. Die obige Signatur gibt Schreibzugriff auf "phpazuretestshared1" "container" des
  272. PhpSpeicher Accounts. Da der geteilte Schlüssel für den Account nicht bekannt ist,
  273. kann die Shared Access Signatur verwendet werden um mit der authorisierten Ressource
  274. zu arbeiten.
  275. </para>
  276. <example id="zend.service.windowsazure.storage.blob.sharedaccesssig.consuming">
  277. <title>Verwenden einer Shared Access Signatur für einen Container</title>
  278. <programlisting language="php"><![CDATA[
  279. $storageClient = new Zend_Service_WindowsAzure_Storage_Blob(
  280. 'blob.core.windows.net', 'phpstorage', ''
  281. );
  282. $storageClient->setCredentials(
  283. new Zend_Service_WindowsAzure_Credentials_SharedAccessSignature()
  284. );
  285. $storageClient->getCredentials()->setPermissionSet(array(
  286. 'http://phpstorage.blob.core.windows.net/phpazuretestshared1?st=2009-08-17T09%3A06%3A17Z&se=2009-08-17T09%3A56%3A17Z&sr=c&sp=w&sig=hscQ7Su1nqd91OfMTwTkxabhJSaspx%2BD%2Fz8UqZAgn9s%3D'
  287. ));
  288. $storageClient->putBlob(
  289. 'phpazuretestshared1', 'NewBlob.txt', 'C:\Files\dataforazure.txt'
  290. );
  291. ]]></programlisting>
  292. </example>
  293. <para>
  294. Es ist zu beachten das es keine explizite Erlaubnis für das Schreiben eines
  295. spezifischen Blobs gab. Stattdessen hat die Windows Azure SDK für PHP festgestellt
  296. das eine Erlaubnis benötigt wurde um entweder an den spezifischen Blob zu schreiben,
  297. oder an seinen Container zu schreiben. Da nur eine Signatur für das letztere
  298. vorhanden war, hat die Windows Azure SDK für PHP diese Zugriffsrechte ausgewählt um
  299. die Anfrage auf den Windows Azure Blob Speicher durchzuführen.
  300. </para>
  301. </sect3>
  302. </sect2>
  303. </sect1>