Zend_Amf-Server.xml 32 KB

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