Zend_Amf-Server.xml 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 16650 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.amf.server">
  5. <title>Zend_Amf_Server</title>
  6. <para>
  7. <classname>Zend_Amf_Server</classname> proporciona un servidor al estilo <acronym>RPC</acronym> para
  8. tramitar solicitudes hechas desde Adobe Flash Player utilizando el protocolo <acronym>AMF</acronym>.
  9. Al igual que todas las clases de servidor, Zend Framework sigue la <acronym>API</acronym> de
  10. SoapServer, proporcionando una interfaz para crear servidores fácil de recordar.
  11. </para>
  12. <example id="zend.amf.server.basic">
  13. <title>Servidor AMF básico</title>
  14. <para>
  15. Asumamos que ha creado la clase <classname>Foo</classname> con una
  16. variedad de métodos públicos. Usando el siguiente código, puede
  17. crear un servidor <acronym>AMF</acronym>:
  18. </para>
  19. <programlisting language="php"><![CDATA[
  20. $servidor = new Zend_Amf_Server();
  21. $servidor->setClass('Foo');
  22. $respuesta = $servidor->handle();
  23. echo $respuesta;
  24. ]]></programlisting>
  25. <para>
  26. Alternativamente, en su lugar puede elegir agregar una función simple como
  27. llamada de retorno:
  28. </para>
  29. <programlisting language="php"><![CDATA[
  30. $servidor = new Zend_Amf_Server();
  31. $servidor->addFunction('myUberCoolFunction');
  32. $respuesta = $servidor->handle();
  33. echo $respuesta;
  34. ]]></programlisting>
  35. <para>
  36. También puede combinar y examinar la identidad de varias clases y funciones.
  37. Al hacerlo, sugerimos darle un espacio de nombres a cada una para
  38. garantizar que no ocurran colisiones entre nombres de métodos;
  39. puede hacerse simplemente pasando una segunda cadena de argumentos para cualquier <methodname>addFunction()</methodname> o
  40. <methodname>setClass()</methodname>:
  41. </para>
  42. <programlisting language="php"><![CDATA[
  43. $servidor = new Zend_Amf_Server();
  44. $servidor->addFunction('myUberCoolFunction', 'my')
  45. ->setClass('Foo', 'foo')
  46. ->setClass('Bar', 'bar');
  47. $respuesta = $servidor->handle();
  48. echo $respuesta;
  49. ]]></programlisting>
  50. <para>
  51. El <classname>Zend_Amf_Server</classname> también permite cargar servicios
  52. dinámicamente, en función de una ruta de directorio ya suministrada.
  53. Puede añadir al servidor tantos directorios como desee.
  54. El orden en que se añadan los directorios al servidor será el orden en que
  55. se realizarán las búsquedas <acronym>LIFO</acronym> en los directorios para coincidir
  56. con la clase.
  57. El método <methodname>addDirectory()</methodname> realiza la acción de añadir directorios.
  58. </para>
  59. <programlisting language="php"><![CDATA[
  60. $servidor->addDirectory(dirname(__FILE__) .'/../services/');
  61. $servidor->addDirectory(dirname(__FILE__) .'/../package/');
  62. ]]></programlisting>
  63. <para>
  64. Cuando se llama a servicios remotos, los nombres de los directorios que
  65. contengan las fuentes pueden tener los delimitadores guión bajo ("_") y el punto (".").
  66. Cuando se utilize un guión bajo ("_") tanto en <acronym>PEAR</acronym> como en Zend Framework,
  67. se respetarán los nombres de clases de acuerdo a las convenciones de nomenclatura.
  68. Esto significa que si usted llama al servicio <classname>com_Foo_Bar</classname> el servidor
  69. buscará el archivo <filename>Bar.php</filename> en cada una de las rutas incluidas en
  70. <filename>com/Foo/Bar.php</filename>.
  71. Si se usa la notación punto para su servicio remoto como <filename>com.Foo.Bar</filename>
  72. cada ruta incluida deberá tener <filename>com/Foo/Bar.php</filename> agregado al final
  73. para autocargar <filename>Bar.php</filename>
  74. </para>
  75. <para>
  76. Todos las solicitudes <acronym>AMF</acronym> enviadas al script serán manejadas
  77. por el servidor, y este devolverá una respuesta <acronym>AMF</acronym>.
  78. </para>
  79. </example>
  80. <note>
  81. <title>Todos los métodos y las funciones agregadas requieren bloques de documentación (docblocks)</title>
  82. <para>
  83. Como todos los demás componentes del servidor en Zend Framework,
  84. debe documentar los métodos de su clase usando <acronym>PHP</acronym> docblocks.
  85. Como mínimo, necesita proporcionar anotaciones para cada argumento
  86. así como para el valor de retorno. Como ejemplos:
  87. </para>
  88. <programlisting language="php"><![CDATA[
  89. // Función que agregar:
  90. /**
  91. * @param string $nombre
  92. * @param string $saludo
  93. * @return string
  94. */
  95. function holaMundo($ombre, $saludo = 'Hola')
  96. {
  97. return $saludo . ', ' . $nombre;
  98. }
  99. ]]></programlisting>
  100. <programlisting language="php"><![CDATA[
  101. // Clase agregada
  102. class Mundo
  103. {
  104. /**
  105. * @param string $nombre
  106. * @param string $saludo
  107. * @return string
  108. */
  109. public function hola($nombre, $saludo = 'Hola')
  110. {
  111. return $saludo . ', ' . $nombre;
  112. }
  113. }
  114. ]]></programlisting>
  115. <para>
  116. Pueden usarse otras anotaciones, pero serán ignoradas.
  117. </para>
  118. </note>
  119. <sect2 id="zend.amf.server.flex">
  120. <title>Conectándose al Servidor desde Flex</title>
  121. <para>
  122. Conectarse a <classname>Zend_Amf_Server</classname> desde su proyecto Flex
  123. es bastante simple; solo necesita apuntar el final del <acronym>URI</acronym>
  124. a su script <classname>Zend_Amf_Server</classname>.
  125. </para>
  126. <para>
  127. Por ejemplo, digamos que ya ha creado su servidor y lo ha
  128. puesto en el fichero <filename>server.php</filename> en el directorio raíz (root)
  129. de su aplicación, por lo tanto la <acronym>URI</acronym> es <filename>http://example.com/server.php</filename>.
  130. En este caso, usted debería modificar su fichero <filename>service-config.xml</filename>
  131. poniendo este valor como atributo al punto final del canal uri.
  132. </para>
  133. <para>
  134. Si nunca ha creado un fichero <filename>service-config.xml</filename> puede hacerlo
  135. abriendo su proyecto en la ventana del navegador.
  136. Haga clic derecho sobre el nombre del proyecto y seleccione 'properties' (propiedades).
  137. En el cuadro de diálogo 'properties' del proyecto ir al menú ‘Flex Build Path' (Crear ruta Flex),
  138. luego en la pestaña ‘Library path’ (ruta de biblioteca) asegúrese
  139. de que el fichero '<filename>rpc.swc</filename>' sea añadido a su ruta de proyectos
  140. y pulse Ok (Aceptar) para cerrar la ventana.
  141. </para>
  142. <para>
  143. También necesitará indicarle al compilador que debe usar
  144. <filename>service-config.xml</filename> para encontrar el punto final de RemoteObject.
  145. Para hacerlo, abra de nuevo el panel de propiedades de su proyecto
  146. haciendo clic en el botón derecho sobre el proyecto en la carpeta del
  147. navegador y seleccione 'properties' (propiedades).
  148. Ahora seleccione ‘Flex Compiler' (Compilador Flex) y añada la cadena:
  149. <command>-services "services-config.xml"</command>.
  150. Presione 'Apply' (Aplicar) y luego en OK para volver a actualizar la opción.
  151. Lo que acaba de hacer es decirle al compilador Flex que busque en el fichero
  152. <filename>services-config.xml</filename> aquellas variables que se usarán en tiempo de
  153. ejecución por la clase RemotingObject.
  154. </para>
  155. <para>
  156. Ahora, para conectarnos a nuestros métodos remotos debemos indicarle a Flex
  157. qué fichero de configuración de servicios utilizar.
  158. Por esta razón creamos un nuevo fichero '<filename>services-config.xml</filename>'
  159. en la carpeta src del proyecto Flex.
  160. Con click derecho sobre el proyecto y seleccionando 'new'(nuevo)
  161. 'File' (fichero), se abrirá una nueva ventana.
  162. Seleccione la carpeta del proyecto y luego nombre el archivo
  163. '<filename>services-config.xml</filename>' y presione 'finish' (finalizar).
  164. </para>
  165. <para>
  166. Flex ha creado y abierto el nuevo fichero <filename>services-config.xml</filename>.
  167. Utilice el siguiente texto de ejemplo para su fichero <filename>services-config.xml</filename>.
  168. Asegúrese de actualizar su punto final para que concuerde con el servidor.
  169. Asegúrese también de guardar el fichero.
  170. </para>
  171. <programlisting language="xml"><![CDATA[
  172. <?xml version="1.0" encoding="UTF-8"?>
  173. <services-config>
  174. <services>
  175. <service id="zend-service"
  176. class="flex.messaging.services.RemotingService"
  177. messageTypes="flex.messaging.messages.RemotingMessage">
  178. <destination id="zend">
  179. <channels>
  180. <channel ref="zend-endpoint"/>
  181. </channels>
  182. <properties>
  183. <source>*</source>
  184. </properties>
  185. </destination>
  186. </service>
  187. </services>
  188. <channels>
  189. <channel-definition id="zend-endpoint"
  190. class="mx.messaging.channels.AMFChannel">
  191. <endpoint uri="http://example.com/server.php"
  192. class="flex.messaging.endpoints.AMFEndpoint"/>
  193. </channel-definition>
  194. </channels>
  195. </services-config>
  196. ]]></programlisting>
  197. <para>
  198. Hay dos puntos clave en el ejemplo.
  199. En primer lugar, pero último en el listado, creamos un canal <acronym>AMF</acronym>,
  200. y especificamos el punto final como la URL a nuestro <classname>Zend_Amf_Server</classname>:
  201. </para>
  202. <programlisting language="xml"><![CDATA[
  203. <channel-definition id="zend-endpoint"
  204. <endpoint uri="http://example.com/server.php"
  205. class="flex.messaging.endpoints.AMFEndpoint"/>
  206. </channel-definition>
  207. ]]></programlisting>
  208. <para>
  209. Advierta que a este canal le hemos dado un identificador, "zend-endpoint".
  210. El ejemplo crea un servicio cuyo destino hace referencia a este canal,
  211. asignándole también un ID, en este caso es "zend".
  212. </para>
  213. <para>
  214. Dentro de nuestros ficheros Flex <acronym>MXML</acronym>, necesitamos vincular un RemoteObject al servicio.
  215. En <acronym>MXML</acronym>, esto podría hacerse así:
  216. </para>
  217. <programlisting language="xml"><![CDATA[
  218. <mx:RemoteObject id="myservice"
  219. fault="faultHandler(event)"
  220. showBusyCursor="true"
  221. destination="zend">
  222. ]]></programlisting>
  223. <para>
  224. Aquí, hemos definido un nuevo objeto remoto identificado por "myservice"
  225. vinculado destino de servicio "zend" que hemos definido en el fichero
  226. <filename>services-config.xml</filename>. Entonces invocamos sus métodos en
  227. nuestro ActionScript simplemente llamando a "myservice.&lt;method&gt;".
  228. . A modo de ejemplo:
  229. </para>
  230. <programlisting language="ActionScript"><![CDATA[
  231. myservice.hello("Wade");
  232. ]]></programlisting>
  233. <para>
  234. Cuando se usan nombres-de-espacio, puede usarse
  235. "myservice.&lt;namespace&gt;.&lt;method&gt;":
  236. </para>
  237. <programlisting language="ActionScript"><![CDATA[
  238. myservice.world.hello("Wade");
  239. ]]></programlisting>
  240. <para>
  241. Para más información sobre como invocar a Flex RemoteObject visite el
  242. sitio de ayuda de Adobe Flex 3 en:<ulink
  243. url="http://livedocs.adobe.com/flex/3/html/help.html?content=data_access_4.html"></ulink>.
  244. </para>
  245. </sect2>
  246. <sect2 id="zend.amf.server.errors">
  247. <title>Manejo de errores</title>
  248. <para>
  249. Por defecto, todas las excepciones producidas en sus
  250. clases o funciones adjuntas serán capturados y devueltas como
  251. mensajes de error de <acronym>AMF</acronym> (AMF ErrorMessages).
  252. Sin embargo, el contenido de estos objetos de mensajes de error
  253. variará dependiendo de si el servidor está o no en modo "producción"
  254. (el estado por defecto).
  255. </para>
  256. <para>
  257. Cuando se está en modo de producción, únicamente el código de excepción será devuelto.
  258. Si desactiva el modo de producción, algo que debe hacerse sólo
  259. para probar -- serán devueltos más detalles de la excepción:
  260. el mensaje de excepción (error), línea y backtrace serán adjuntados.
  261. </para>
  262. <para>
  263. Para desactivar el modo de producción, haga lo siguiente:
  264. </para>
  265. <programlisting language="php"><![CDATA[
  266. $server->setProduction(false);
  267. ]]></programlisting>
  268. <para>
  269. Para habilitarlo nuevamente, pase el valor <constant>TRUE</constant> en su lugar.
  270. </para>
  271. <programlisting language="php"><![CDATA[
  272. $server->setProduction(true);
  273. ]]></programlisting>
  274. <note>
  275. <title>¡Deshabilite el modo de producción racionalmente!</title>
  276. <para>
  277. Sugerimos deshabilitar el modo de producción solo cuando se está
  278. en modo de desarrollo.
  279. Los mensajes de excepción y los backtraces puede contener información
  280. sensible del sistema, y no desea que se pueda acceder a ellas
  281. desde el exterior.
  282. Aunque <acronym>AMF</acronym> es un formato binario, ahora al ser abierta la especificación,
  283. cualquiera puede potencialmente deserializar los datos.
  284. </para>
  285. </note>
  286. <para>
  287. Un área en la que se debe tener especialmente mucho cuidado son los
  288. errores propios de <acronym>PHP</acronym>.
  289. Cuando la directiva <acronym>INI</acronym> <property>display_errors</property> está habilitada,
  290. los errores de <acronym>PHP</acronym> de cualquier nivel del reporte actual serán
  291. pasados directamente a la salida, y potencialmente se podrían hacer
  292. estragos con las respuestas de <acronym>AMF</acronym>.
  293. Para prevenir estos problemas, sugerimos deshabilitar la directiva
  294. <property>display_errors</property> cuando se está en modo de producción.
  295. </para>
  296. </sect2>
  297. <sect2 id="zend.amf.server.response">
  298. <title>Respuestas de AMF</title>
  299. <para>
  300. En ocasiones es posible que quiera manipular ligeramente el objeto
  301. respuesta, es bastante usual querer devolver algunas cebeceras
  302. de mensajes adicionales. Puede hacerlo mediante el método del servidor
  303. <methodname>handle()</methodname> que devuelve el objeto respuesta.
  304. </para>
  305. <example id="zend.amf.server.response.messageHeaderExample">
  306. <title>Agregar cabeceras de mensaje a la respuesta de AMF</title>
  307. <para>
  308. En este ejemplo, añadiremos la cabecera de mensaje (MessageHeader)
  309. "foo" con el valor 'bar' a la respuesta antes de devolverla.
  310. </para>
  311. <programlisting language="php"><![CDATA[
  312. $respuesta = $servidor->handle();
  313. $respuesta->addAmfHeader(new Zend_Amf_Value_MessageHeader('foo', true, 'bar'))
  314. echo $respuesta;
  315. ]]></programlisting>
  316. </example>
  317. </sect2>
  318. <sect2 id="zend.amf.server.typedobjects">
  319. <title>Objetos tipados</title>
  320. <para>
  321. Similarmente a <acronym>SOAP</acronym>, <acronym>AMF</acronym> permite pasar objetos entre cliente y servidor.
  322. Esto le da una gran flexibilidad y coherencia a ambos entornos.
  323. </para>
  324. <para>
  325. <methodname>Zend_Amf</methodname> ofrece tres métodos para mapear ActionScript
  326. y objetos PHP.
  327. </para>
  328. <itemizedlist>
  329. <listitem>
  330. <para>
  331. Primero, usted puede crear uniones explícitas a nivel del servidor,
  332. utilizando el método <methodname>setClassMap()</methodname>.
  333. El primer argumento es el nombre de la clase de ActionScript,
  334. el segundo es el nombre de la clase <acronym>PHP</acronym> que lo mapea:
  335. </para>
  336. <programlisting language="php"><![CDATA[
  337. // Mapea la clase ActionScript 'ContactVO' a la clase PHP 'Contact':
  338. $servidor->setClassMap('ContactVO', 'Contact');
  339. ]]></programlisting>
  340. </listitem>
  341. <listitem>
  342. <para>
  343. Segundo, en su clase <acronym>PHP</acronym> puede ajustar la propiedad como pública
  344. mediante <methodname>$_explicitType</methodname>, con el valor
  345. representativo de la clase ActionScript que mapear:
  346. </para>
  347. <programlisting language="php"><![CDATA[
  348. class Contact
  349. {
  350. public $_explicitType = 'ContactVO';
  351. }
  352. ]]></programlisting>
  353. </listitem>
  354. <listitem>
  355. <para>
  356. Tercero, en un sentido similar, puede definir como público el método
  357. <methodname>getASClassName()</methodname> dentro de su clase.
  358. Este método debe devolver la clase ActionScript apropiada:
  359. </para>
  360. <programlisting language="php"><![CDATA[
  361. class Contact
  362. {
  363. public function getASClassName()
  364. {
  365. return 'ContactVO';
  366. }
  367. }
  368. ]]></programlisting>
  369. </listitem>
  370. </itemizedlist>
  371. <para>
  372. Aunque hemos creado <emphasis>ContactVO</emphasis> en el servidor,
  373. ahora tenemos que hacer su clase correspondiente en <acronym>AS3</acronym>
  374. para que el servidor pueda mapear el objeto.
  375. </para>
  376. <para>
  377. Haga clic derecho sobre la carpeta src del proyecto Flex y seleccione New -> ActionScript File.
  378. Nombre el fichero como ContactVO y pulse 'finish' (finalizar) para verlo.
  379. Copie el siguiente código en el fichero para terminar de crear la clase.
  380. </para>
  381. <programlisting language="as"><![CDATA[
  382. package
  383. {
  384. [Bindable]
  385. [RemoteClass(alias="ContactVO")]
  386. public class ContactVO
  387. {
  388. public var id:int;
  389. public var firstname:String;
  390. public var lastname:String;
  391. public var email:String;
  392. public var mobile:String;
  393. public function ProductVO():void {
  394. }
  395. }
  396. }
  397. ]]></programlisting>
  398. <para>
  399. La clase es sintácticamente equivalente a la de <acronym>PHP</acronym> del mismo nombre.
  400. Los nombres de variables son exactamente los mismos y necesitan estar
  401. en el mismo contenedor para trabajar correctamente. Hay
  402. dos meta tags <acronym>AS3</acronym> únicos en esta clase.
  403. El primero es vinculable y dispara un evento cuando es actualizada.
  404. El segundo es el tag RemoteClass y define que esta clase puede tener
  405. mapeado un objeto remoto con un nombre de alias, en este caso <emphasis>ContactVO</emphasis>
  406. Es obligatorio que en esta etiqueta(tag), el valor que se estableció es la clase PHP
  407. sea estrictamente equivalente.
  408. </para>
  409. <programlisting language="as"><![CDATA[
  410. [Bindable]
  411. private var myContact:ContactVO;
  412. private function getContactHandler(event:ResultEvent):void {
  413. myContact = ContactVO(event.result);
  414. }
  415. ]]></programlisting>
  416. <para>
  417. El siguiente resultado del evento debido a la llamada de servicio,
  418. se incorporó instantáneamente a <emphasis>ContactVO</emphasis> de Flex.
  419. Cualquier cosa que esté ligada a myContact será actualizada con los
  420. datos retornados por <emphasis>ContactVO</emphasis>.
  421. </para>
  422. </sect2>
  423. <sect2 id="zend.amf.server.resources">
  424. <title>Recursos</title>
  425. <para>
  426. <classname>Zend_Amf</classname> provides tools for mapping resource types
  427. returned by service classes into data consumable by ActionScript.
  428. </para>
  429. <para>
  430. In order to handle specific resource type, the user needs to create a plugin class named
  431. after the resource name, with words capitalized and spaces removed (so, resource
  432. type "mysql result" becomes MysqlResult), with some prefix, e.g.
  433. <classname>My_MysqlResult</classname>. This class should implement one method,
  434. <methodname>parse()</methodname>, receiving one argument - the resource - and returning
  435. the value that should be sent to ActionScript. The class should be located in the file
  436. named after the last component of the name, e.g. <filename>MysqlResult.php</filename>.
  437. </para>
  438. <para>
  439. The directory containing the resource handling plugins should be registered with
  440. <classname>Zend_Amf</classname> type loader:
  441. </para>
  442. <programlisting language="php"><![CDATA[
  443. Zend_Amf_Parse_TypeLoader::addResourceDirectory(
  444. "My",
  445. "application/library/resources/My"
  446. ));
  447. ]]></programlisting>
  448. <para>
  449. For detailed discussion of loading plugins, please see
  450. the <link linkend="zend.loader.pluginloader">plugin loader</link> section.
  451. </para>
  452. <para>
  453. Default directory for <classname>Zend_Amf</classname> resources is registered
  454. automatically and currently contains handlers for "mysql result" and "stream"
  455. resources.
  456. </para>
  457. <programlisting language="php"><![CDATA[
  458. // Example class implementing handling resources of type mysql result
  459. class Zend_Amf_Parse_Resource_MysqlResult
  460. {
  461. /**
  462. * Parse resource into array
  463. *
  464. * @param resource $resource
  465. * @return array
  466. */
  467. public function parse($resource) {
  468. $result = array();
  469. while($row = mysql_fetch_assoc($resource)) {
  470. $result[] = $row;
  471. }
  472. return $result;
  473. }
  474. }
  475. ]]></programlisting>
  476. <para>
  477. Trying to return unknown resource type (i.e., one for which no handler plugin exists)
  478. will result in an exception.
  479. </para>
  480. </sect2>
  481. <sect2 id="zend.amf.server.flash">
  482. <title>Conectándose al Servidor desde Flash</title>
  483. <para>
  484. La conexión a <classname>Zend_Amf_Server</classname> desde su proyecto Flash
  485. es ligeramente distinta a la de Flex. Sin embargo una vez que la conexión
  486. con Flash funcione con <classname>Zend_Amf_Server</classname> lo hará igual
  487. modo que con Flex. El siguiente ejemplo también puede ser utilizado
  488. desde un fichero Flex <acronym>AS3</acronym>. Para nuestra conexión vamos a reutilizar
  489. la misma configuracion <classname>Zend_Amf_Server</classname> junto a la clase Mundo.
  490. </para>
  491. <para>
  492. Abra Flash CS y cree un nuevo fichero Flash (ActionScript 3).
  493. Nombre al documento como <filename>ZendExample.fla</filename> y guárdelo en una carpeta
  494. que utilizará para este ejemplo. Cree una nuevo fichero <acronym>AS3</acronym> en el mismo
  495. directorio y llámelo <filename>Main.as</filename>. Abra ambos ficheros con su editor.
  496. Ahora vamos a conectar las dos ficheros a través de la clase documento.
  497. Seleccione ZendExample y haga clic en el escenario.
  498. Desde el panel del escenario cambie la propiedad de la clase Document a Main.
  499. Esto vincula al fichero Main.as con la interfaz de usuario en<filename>ZendExample.fla</filename>
  500. Cuando ejecute el fichero ZendExample de Flash se ejecutará ahora
  501. la clase <filename>Main.as</filename>
  502. El paso siguiente será añadir ActionScript para hacer una lamada <acronym>AMF</acronym>.
  503. </para>
  504. <para>
  505. Ahora vamos a hacer una clase Main(principal) para que podamos enviar
  506. los datos al servidor y mostrar el resultado.
  507. Copie el código siguiente en su fichero <filename>Main.as</filename> y luego vamos a recorrer
  508. el código para describir cuál es el papel de cada elemento.
  509. </para>
  510. <programlisting language="as"><![CDATA[
  511. package {
  512. import flash.display.MovieClip;
  513. import flash.events.*;
  514. import flash.net.NetConnection;
  515. import flash.net.Responder;
  516. public class Main extends MovieClip {
  517. private var gateway:String = "http://example.com/server.php";
  518. private var connection:NetConnection;
  519. private var responder:Responder;
  520. public function Main() {
  521. responder = new Responder(onResult, onFault);
  522. connection = new NetConnection;
  523. connection.connect(gateway);
  524. }
  525. public function onComplete( e:Event ):void{
  526. var params = "Sent to Server";
  527. connection.call("World.hello", responder, params);
  528. }
  529. private function onResult(result:Object):void {
  530. // Display the returned data
  531. trace(String(result));
  532. }
  533. private function onFault(fault:Object):void {
  534. trace(String(fault.description));
  535. }
  536. }
  537. }
  538. ]]></programlisting>
  539. <para>
  540. Primero tenemos que importar dos bibliotecas de ActionScript que realizan
  541. la mayor parte del trabajo. La primera es NetConnection que actúa como un
  542. tubo bidireccional entre el cliente y el servidor.
  543. La segunda es un objeto Responder que maneja los valores de retorno desde
  544. el servidor, y que están relacionados con el éxito o el fracaso de la llamada.
  545. </para>
  546. <programlisting language="as"><![CDATA[
  547. import flash.net.NetConnection;
  548. import flash.net.Responder;
  549. ]]></programlisting>
  550. <para>
  551. En la clase necesitaremos tres variables para representar a NetConnection,
  552. Responder, y la URL del gateway a nuestra instalación <classname>Zend_Amf_Server</classname>.
  553. </para>
  554. <programlisting language="as"><![CDATA[
  555. private var gateway:String = "http://example.com/server.php";
  556. private var connection:NetConnection;
  557. private var responder:Responder;
  558. ]]></programlisting>
  559. <para>
  560. En el constructor Main creamos un Responder(respondedor) y una nueva conexión al
  561. punto final de <classname>Zend_Amf_Server</classname>. El respondedor define dos
  562. diferentes métodos para manejar la respuesta desde el servidor.
  563. Por simplicidad los hemos llamado onResult y onFault.
  564. </para>
  565. <programlisting language="as"><![CDATA[
  566. responder = new Responder(onResult, onFault);
  567. connection = new NetConnection;
  568. connection.connect(gateway);
  569. ]]></programlisting>
  570. <para>
  571. La función onComplete se ejecuta tan pronto como la construcción
  572. ha concluido, enviando los datos al servidor.
  573. Necesitamos añadir una línea más que hace una llamada a la función
  574. <classname>Zend_Amf_Server</classname> Mundo->hola.
  575. </para>
  576. <programlisting language="as"><![CDATA[
  577. connection.call("Mundo.hola", responder, params);
  578. ]]></programlisting>
  579. <para>
  580. Cuando creamos la variable responder hemos definido las funciones onResult y onFault
  581. para manejar la respuesta proveniente del servidor.
  582. Hemos añadido la función OnResult para el resultado exitoso desde el servidor.
  583. Cada vez que se ejecuta apropiadamente el manejo de conexión con el
  584. servidor, el manejador de eventos llama esta función.
  585. </para>
  586. <programlisting language="as"><![CDATA[
  587. private function onResult(result:Object):void {
  588. // Muestra los datos devueltos
  589. trace(String(result));
  590. }
  591. ]]></programlisting>
  592. <para>
  593. La función onFault, se llama si hubo una respuesta nula desde el servidor.
  594. Esto ocurre cuando hay un error en el servidor, la <acronym>URL</acronym> al servidor es inválida,
  595. el servicio remoto o método no existe o cualquier otra cuestión
  596. relacionada con la conexión.
  597. </para>
  598. <programlisting language="as"><![CDATA[
  599. private function onFault(fault:Object):void {
  600. trace(String(fault.description));
  601. }
  602. ]]></programlisting>
  603. <para>
  604. La inclusión de ActionScript para realizar la conexión remota ha finalizado.
  605. Al ejecutar el fichero ZendExample, se establece una conexión con Zend_Amf.
  606. En resumen, se han añadido las variables requeridas para abrir una conexión
  607. con el servidor remoto, se han definido qué métodos se deben utilizar cuando su aplicación
  608. recibe una respuesta desde el servidor, y finalmente se han mostrado los datos de salida
  609. devueltos a través de <methodname>trace()</methodname>.
  610. </para>
  611. </sect2>
  612. <sect2 id="zend.amf.server.auth">
  613. <title>Authentication</title>
  614. <para>
  615. <classname>Zend_Amf_Server</classname> allows you to specify authentication and
  616. authorization hooks to control access to the services. It is using the infrastructure
  617. provided by <link linkend="zend.auth"><classname>Zend_Auth</classname></link> and
  618. <link linkend="zend.acl"><classname>Zend_Acl</classname></link> components.
  619. </para>
  620. <para>
  621. In order to define authentication, the user provides authentication adapter extening
  622. <classname>Zend_Amf_Auth_Abstract</classname> abstract class. The adapter should
  623. implement the <methodname>authenticate()</methodname> method just like regular
  624. <link linkend="zend.auth.introduction.adapters">authentication adapter</link>.
  625. </para>
  626. <para>
  627. The adapter should use properties <emphasis>_username</emphasis> and
  628. <emphasis>_password</emphasis> from the parent
  629. <classname>Zend_Amf_Auth_Abstract</classname> class in order to authenticate. These
  630. values are set by the server using <methodname>setCredentials()</methodname> method
  631. before call to <methodname>authenticate()</methodname> if the credentials are received
  632. in the <acronym>AMF</acronym> request headers.
  633. </para>
  634. <para>
  635. The identity returned by the adapter should be an object containing property
  636. <property>role</property> for the <acronym>ACL</acronym> access control to work.
  637. </para>
  638. <para>
  639. If the authentication result is not successful, the request is not proceseed further
  640. and failure message is returned with the reasons for failure taken from the result.
  641. </para>
  642. <para>
  643. The adapter is connected to the server using <methodname>setAuth()</methodname> method:
  644. </para>
  645. <programlisting language="php"><![CDATA[
  646. $server->setAuth(new My_Amf_Auth());
  647. ]]></programlisting>
  648. <para>
  649. Access control is performed by using <classname>Zend_Acl</classname> object set by
  650. <methodname>setAcl()</methodname> method:
  651. </para>
  652. <programlisting language="php"><![CDATA[
  653. $acl = new Zend_Acl();
  654. createPermissions($acl); // create permission structure
  655. $server->setAcl($acl);
  656. ]]></programlisting>
  657. <para>
  658. If the <acronym>ACL</acronym> object is set, and the class being called defines
  659. <methodname>initAcl()</methodname> method, this method will be called with the
  660. <acronym>ACL</acronym> object as an argument. The class then can create additional
  661. <acronym>ACL</acronym> rules and return <constant>TRUE</constant>, or return
  662. <constant>FALSE</constant> if no access control is required for this class.
  663. </para>
  664. <para>
  665. After <acronym>ACL</acronym> have been set up, the server will check if access is
  666. allowed with role set by the authentication, resource being the class name (or
  667. <constant>NULL</constant> for
  668. function calls) and privilege being the function name. If no authentication was
  669. provided, then if the <emphasis>anonymous</emphasis> role was defined, it will be used,
  670. otherwise the access will be denied.
  671. </para>
  672. <programlisting language="php"><![CDATA[
  673. if($this->_acl->isAllowed($role, $class, $function)) {
  674. return true;
  675. } else {
  676. require_once 'Zend/Amf/Server/Exception.php';
  677. throw new Zend_Amf_Server_Exception("Access not allowed");
  678. }
  679. ]]></programlisting>
  680. </sect2>
  681. </sect1>
  682. <!--
  683. vim:se ts=4 sw=4 et:
  684. -->