From 719f53dfb5e25e661dd61ee6a387a65cded32db8 Mon Sep 17 00:00:00 2001 From: Matt Tucker Date: Wed, 15 Jan 2003 15:03:36 +0000 Subject: [PATCH] Initial check-in. git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@1786 b35dd754-fafc-0310-a699-88a17e54d16e --- documentation/debugging.html | 64 +++++++++++++++ documentation/gettingstarted.html | 96 ++++++++++++++++++++++ documentation/images/debugwindow.gif | Bin 0 -> 15064 bytes documentation/index.html | 30 +++++++ documentation/overview.html | 55 +++++++++++++ documentation/processing.html | 0 documentation/properties.html | 114 +++++++++++++++++++++++++++ documentation/style.css | 56 +++++++++++++ 8 files changed, 415 insertions(+) create mode 100644 documentation/debugging.html create mode 100644 documentation/gettingstarted.html create mode 100644 documentation/images/debugwindow.gif create mode 100644 documentation/index.html create mode 100644 documentation/overview.html create mode 100644 documentation/processing.html create mode 100644 documentation/properties.html create mode 100644 documentation/style.css diff --git a/documentation/debugging.html b/documentation/debugging.html new file mode 100644 index 000000000..70bde31af --- /dev/null +++ b/documentation/debugging.html @@ -0,0 +1,64 @@ + + + Smack: Debugging - Jive Software + + + + + +
+Debugging with Smack +
+ +
+« Table of Contents +
+ +

+Smack includes a built-in debugging console that will let you track all XML traffic between +the client and server. +

+ +

+When debugging mode is enabled, a debug window will appear when each new connection is created. +The window will contain the following information: +

+ + + + + +

+Debugging mode can be enabled in two different ways: +

+ +
    +
  1. Add the following line of code before creating new connections:

    + XMPPConection.DEBUG_ENABLED = true;

    + +

  2. Set the Java system property smack.debugEnabled to true. The + system property can be set on the command line such as:

    + java SomeApp -Dsmack.debugEnabled=true. +

+ +

+If you wish to explicity disable debug mode in your application, including using the command-line parameter, +add the following line to your application before opening new connections: +

+ +

+XMPPConnection.DEBUG_ENABLED = false; +

+ +


+ +
+Copyright © Jive Software 2002-2003 +
+ + + diff --git a/documentation/gettingstarted.html b/documentation/gettingstarted.html new file mode 100644 index 000000000..a9bf8bb05 --- /dev/null +++ b/documentation/gettingstarted.html @@ -0,0 +1,96 @@ + + + Smack: Getting Started - Jive Software + + + + +
+Getting Started With Smack +
+ +
+« Table of Contents +
+ +

+This document will introduce you to the Smack API and provide an overview of +important classes and concepts. +

+ +

+Requirements +

+ +The only requirement for Smack is JDK 1.2 or later. An XML parser is embedded in the smack.jar +file and no other third party libraries are required. + +

+Establishing a Connection +

+ +The XMPPConnection class is used to create a connection to an +XMPP server. To create an SSL connection, use the SSLXMPPConnection class. +Below are code examples for making a connection:

+ +

+
+// Create a connection to the jabber.org server.
+XMPPConnection conn1 = new XMPPConnection("jabber.org");
+
+// Create a connection to the jabber.org server on a specific port.
+XMPPConnection conn2 = new XMPPConnection("jabber.org", 5222);
+
+// Create an SSL connection to jabber.org.
+XMPPConnection connection = new SSLXMPPConnection("jabber.org"); 
+
+ +

Once you've created a connection, you should login using a username and password +with the XMPPConnection.login(String username, String password) method. +Once you've logged in, you can being chatting with other users by creating +new Chat or GroupChat objects. + +

+Working with the Roster +

+ +CONTENT COMING SOON + +

+Packets, the PacketReader, and the PacketWriter +

+ +Each message to the XMPP server from a client is called a packet and is +sent as XML. The org.jivesoftware.smack.packet package contains +classes that encapsulate the different packet types allowed by XMPP (message, +presence, and IQ). Classes such as Chat and GroupChat +provide higher-level constructs that manage creating and sending packets +automatically, but you can also create and send packets directly. Below +is a code example for changing the presence to let people we're unavailable +because we're out fishing:

+ +

+
+// Create a new presence. Pass in false to indicate we're unavailable.
+Presence presence = new Presence(false);
+presence.setStatus("Gone fishing");
+// Send the packet (assume we have a XMPPConnection instance called "con").
+con.getPacketWriter().sendPacket(presence);
+
+

+ +Every connection has a PacketReader and PacketWriter. The +packet reader listens for XML data from the server and parses it into +individual packets. You can listen for incoming packets by registering +PacketWatcher objects with the packet reader. The packet writer +is responsible for writing packets to the server. It takes Packet +objects and converts them to XML before sending them over the network. + + +

+Copyright © Jive Software 2002-2003 +
+ + + \ No newline at end of file diff --git a/documentation/images/debugwindow.gif b/documentation/images/debugwindow.gif new file mode 100644 index 0000000000000000000000000000000000000000..e53c5dc3398a0088b27e6d75b53433c00837800d GIT binary patch literal 15064 zcmV;}Iw!?PNk%w1VP^r40rvm^00030|Nrdi*woO-ac^V>OoahnBl&ZB{q64f&e7r~ zI^h;Hz;Col|L64o%}~Q{r_nikajW5vYXVLaO0JKx@%UQ zbyDk`f%|n==1MNe)zag>yW_}Vr02$8!7OnseeFztW3K)Ym zLZtv9)Bqa102r$P6`lYSi~tjho~rTyAjk_T!T>4I03DzJ9-s#?*#;-M2r=0UGT{p` z&Hy8+2Qt|RG};R_)c`Zu2tVZrI@Jj}+yFY`06N(KHqQVt!w5z62u17wMCkxN+yFh? z06y9PKGFn1*a%Ge2ubt~Q0)yz+8bK&8&%&dS;SL<_JpSR%h&V(O!ELp@c>5T07l>d zL(>30%LG2Y2T$?`PVNUz>IhW)2vhY4Oyvqm*$qa(5>eq8NxLLn;VEeJD`Mm|ZuCNU z^=Om#wYOX&bj;{Z$G07usVMbiL7&jC*20YuOSFoPaoIGHi1y_d9<^W*)0ATt6VEF)A^#EG(09ft-Ti}8k09xk&Smpp#ur`17Pt3W$^`S{sm?F2W$BVXYvI;Y{40b=R` zYx4tc{{wIO266reZv6;y`xbco0CW8UQLh7X{|9vb2y*rxhW{~)|2mQXJ(d3eTf_)? z{40?EF_iy6nEn8F^aFhN18mpHLg1z=4?;ugKGZ1vj64d``z1c z0|Vrspa1{=A^8LW00930EC2ui0A~S@0RRa900RgVXiAYHJa`f*L`2F~Er-Zxfuco` zqNj@(Giuz(v7^V2AVZ4u$f=~slPFWFT*x+^${2hOL{~vuDYwUCXwu+qZDz z%AHF$F50_z^XlEpx3Ay7f9nb!Ot`S&vS_i5T`ab7V{4EjcYW3@iju2}bOlQ`?V0DU z)wYQi&8_t4)2LIcUd_6->({Vj%brcUw(Z-vbL-xnIy7p~+dvB+4%##2W}B)C6mzJQ zvFFc|C0jNPnlx$Er&Y%e4catj%&v?7A5Xr#`Sa-0t6$H)z5Dm@*WE6-^wP^IvuHBQCZ{ks%PgIE@*p7>b<)WwVLY*%DYt}pOD)Jm zC*6rCrYN0)EVk(4i!jD0s!zz~2EiI`H#mm!i^B6KK1_uPaOYN+O#Y_{p+*pMVA`=%9oaYN(%}B&z6=qd+Mol~g8FB_3gf5rr6-CZU89F>ES^B4Cb4 zq?x1|Lu5sXDyizKthVavtFXrZD(kGY)@tjmxaO+suDtfzsw#iban-O_{h^AIzzR$3 zvVTA_${~>iyR1O(Sk=HEVrZ(w4nM^3gA$*D2~jPj7D-DjwJf?MlkB$Z?z`~DEAPDY z)@yIPPUfrczWny<@4o;CEbzeoLTT{92q&!Y!VEX8aIkaCp@kN5R9tZ!7{~F(8&|-= z#UD^YEHT9v%aO6h9DDr7A&C6JPd@qJBeOmD*kkj}_S934Jqi4=>9#+p00X#uh)cuK z0r;a&0tvKmszj+ON$}KES8esxSZA&E)&o22_19oK9Kak$ZxQj?T8vC`9ByPm2b5!% zeRjlYPrP>9bVwOMKK}Us1M}a1%RF<=_t2s33qcPp1|Fr{Vharw9FVj>4>aIU1uf8` z3q?_{d++CSu*(g#?cfI$8P(8A_WC+Yd<n81quN#Dh_0e z@zNp}%U6hUK%fLn5=R8sMUE@B5sUQ_hdVMbz7Gn*jA(q97~8c+^CjhvfDEJ{11S!x zL?9{S7|0A`W}t%`!H zEGWV^KY&)XmIIt^U8}n!O1DZ{(xEJjs6shu*Gqcxp#iw4JpzZ1f!JdpI@{UuLOKLk zsz8>92n9+7Qh^;FAOQ#nfCe-Wf?sOL6Q7{sIygXxLJ)$A*9!mz3aMH`5P}@k%7AO{ zD3CM%F4G9GrGRT)d)w1KGYwvBEfwEUEq9Q15#@-0YsK*n*|Jt37}zZ#22l=u7~zrr zD1$jI09)fCmkY6-Z8-+gjtQ6{xEQ$O83`c{-Kw_)(v7ctd0WLZ76P^bXs&OG8vx_( zx45MBtw3~(+z53ZT%$Z+JxoQtUrF1b}7+v{ueoxmY9&;gvg3K@E`b1w&xydK%b3 z2qX}KBqw>~Wcpc8kfQ+&h`>dtD32C&L$$)_20LWyi9WEvoE!*5IUHbt6_8{9 z0@`?{I4ZyZ78n5|%PfK?mdT5AP+$e%2ml6_@yr#Fpd6!Bvp#&_39Kfv&g5W+KbDXY zp~8VP-Th)6j_Kz_ClMY*z;w17s)%J2ViD4cI`s#Duk|r(NxDK=sU$ zUIJ_xzy$X4vm6QN^=`-Q1Jk;e-R^#E02t72=>{MUB)%9dV1Z&3zrhc-TQR;T_CAZn zVc#*H@hboxfTG;^co3IawQihP#onU#elUX}7uge?m<5tG00JlaV*?ofz<`pc z%!^HI!X(+KB0D&cYk%zE(M1?X0~kPtL{^{z+}Bag;aG7GOfwebDrCNT3}45UK}s?Sng>^9WCXYuK*XXH9l9Go2H{Fajscc>$9oQXUp)g6jhSd)b%d^|43Ez2(5aitU@f%rsuxB)eq-*@m>XY>fb5sokf7wljLE_lNK7eoPakq4m3 z4FG`&%z*(qY_Cj}0d(kca)^g@h=88Nd%Y(I`_^x+UV0;iaY=FkGTfD5T0fAYr*H8%_xNQ3`J zXE#U$kv0L3)(G+!4(Ff`;LrdRzzDJ^j8b?Cy@*x#gijZ^j5Npu)g=U{aD!b?4(?Db z3_t?FD2sD;PF^rx&QhjKGidCv3aei_Tzmnm~j2=nqEFkUQs$&q#**XprN^3_J8v>XAA&$=1`Y!bpn7;4m1#F%oJ%E00@~dn99h1Nkamy zrVo-34s>t=g_#M`W&wQ%PH7o*72ppmfKO8}n4HO$0YFZuK$k+0377zClTeMBfK_le zTI*O|)9_4ZAV(7*1ZfF-fUsRu(3zPan4HO*x=ES{NoR0JXMRZprO6H!5QWAWnYO5y zjClf=FpQ%)n6O0ylc0>T$y7!lor5WBn5mhWP@R+ikeU<_3(7bGi;zg?L@4%n_833E0lpocUrgSsJ z6_wam0bbAqRH+13SqB!fmG6LZArJx$AZ72+WEfxq-jfTvunV#vjMSn5Bv72~$N*C? zqf}51KNkYeGzG{oUKKzAEby9AD2(!O0%s|VS||Z5Km@qZjur3@8ejuR`VJKU0TwU< zztD~XVGi6BXA}1h9dMRsDGTMm078HZ;h+u{Fa@|!n(%M|JE#vufD1P`3AIoT)W=Pd z@JRDU0+N6WKIGca{Z zH{%ZakXZE40A6sRM{olh$_ZMT2{d31sF-r}8UpYjEG?i6%1|GkPF8k3<2A-6pONxunPmp z0yGP>eL%AY`?D|`wNe|k%HIqo4x&dz1GXT&O3}yE57P0wTXKL8*?(S5C{FnpR2G5 zckrM6+P?3bG4VUUtWdxA8vw=%x}iI|6(^My&;_Y`1gqP+uNxsNx(pKR4bVWr&VU`? zk-O5cyByrX9{j-|9Ks?z!X&H=;?Mx8lmK>C!XCW7E*!nZFkV1(! zUTm(WTLFQvzzyuW5ONByxC_AG3(e3B%-{^*5y#@OyF6UScHFzd@Qmqu$9#;vGMkx9 zpuBy2$Gecn__W7^47_vyzy(<_25Zm;ZLkKCJjrV?29`VqZ2$suaJ`G%$d4S!lw8S| zjLDi@43{tm32+bepvw2a%BK6uuY3;)Fb4|k1q?g`tZT-cunD}t3#X6_Y77j((8kTM zqQ>mIDtgSyyv)qp%+CDG&>YRuJk5t&&DMO)*qqJUyv=gU&EEXY;2h54JkHn*40GTP zSXNo++^fSv2XnxpvS7~WjKU4D&ir*1?wks{nF(_c0Os(|0BsHeG0zWB&~)$zWRSWU zip#BQ2cw`QieXJy1(k6YZQmwN;uOB(zHQkPToL{;WVD!N>1NZ{^Ut+}=wv?Lls?>z4(XRJ=f=J1z2CjESMm_4FB+| zPUjJC@VTz;>%Qmh{_Yq4ICoc%6{z;zwj^r zpYq*K^Bq6);BNEap7T2I@b-T3zMk>$F6H-L^ek`W_3 z{`M!I_y(`}+3xd!FZfSR`0-xvXDO1{nmf|*q{B{zx~|*-~HbI z{lh{4(;xlhU;gG_-2y)S@v#2v-~R6Z{_r3F@<0FdU;p-h|M;K(`oI7D4-oML4kTF6 z;6a256)t4h(BVUf5d{Vi5RZVDCpcuF;NglAMT-PPjwD&q&(&bB-F=fuA zS<~iCoH=8{19>sy#*QB=5(rS#=uxCel`du4)ag^GQKe3$TGi@RtXZ{gdQm zdhFTN>{+yF)vjgR*6rH>UoD0ON_Hq*ym|HR<=fY9Rk=RJ1}*#7@L|M>6)#2_nC@7i z78y^bT-owvsg8d_E{xf8(SH3tM-3gIbZNMvk*bD@x-Dy^u0g|&s(G;gUCBmeC#BuD zx8mPjgRfQ1`giZ)qH>R`)tv$cWVca`gC{k=1((K z&prHV-Qm-_9{=5ad-~qhzh`gVdVc$~laITjcJr^m0s%CS!1%f&u)U?oYfv`^O{>to z__(vJuE>ZQkHP~p1kpkgNqo=25sl+bJP=j1kiXatJP|<=i%XG38CRsy#1>yHZ@2|R z6f(#QM@;d^1pRaILK~l2ayt{7d{VUyIU6cC`-Cj<#|CYLF*fg(OE60bXJn7XFL5j} z%Lv1SZ%hUM+tNuScg&GFF}WPFMG5CDvcE3xbWy+&tJDEE4}moQa?dw;{1Q+|%^jhmQ%gx3r8GM>JzaFpB_qtU(oT6ibvES$?NP}Xi_$EIjSlV5$R}SNbx+fU44{B6){C}%1n=KRM}ziyi?U)*GzTM<1W=T*d~1y6;^Jc-Er1h5w)~W@btW| zO92C%uetr={4w3*wuARR`RYAa#PY5K)m?h$ZS6et#>^LAPFK{=UUl0YutEd3gg4=X z_w5H<6m0EmG>kKT%ejIt<9I8IEv`;ul1nx#RFfxsD`as~cKKzPGiLeLm}|EA=EG*b z7-yb)_W3NGNB((eqKk$q=-iA}dTFJRCW>jOqvqLZsjIgC+GVOCr7GStnQU0)a#{U) z3+8H z@9oZ3&BzIVb9~(YMUTFzngupWGR3?cP3E6Pxz&N+mv~h0%Rg#%==m>J&b#071X!xp zEN6Jg30~s@$Q%?Yt6RZ}7Tc^vJ_N!qZT2%D-}pEGKmp1sd)pIP($*HjWo58;=!@P5 zAr-;*ZS7ihDqQ`f za}yKqMH)6ePjNt6UxwO+yZMEVP-CQA1M%0d&t(x}5tQN;u?H6IA#rDC^ve&kLOz$- z5rm%6V``KVx4v!AEl)gI!eB;7Cm|9simao70C_b?M$$5mlw>6>X&8!8Cux`DWGD0D z7$@8&iJl~7DboTmJm{t(+~HZR?tjAgIFxVof@*w9+O8sWIjMQE*bnvmJ4AD4e|YFIInZrZ$1&oLg4& zY0_d?+0+Oi*9B^dO-vl1RH)2dO>lCe`wlVfsk(md2W-@0ALPJ>xjh1}o$ZVwhK>oR zfhH%NnoJZk*{DC~b&G{sgVGY4IH+lTvv(Q2Tl$jKLe3FUclASI^%U1UxnVSVzbk3+ z;5N-)S_FCs^r#bwghP+^PlYf1-U-dO!KvUo=-5Qx{NBE%l@86WlxZ z*Tz6%(6m&HADrr?Fm&}aa|I+TPkq|OE1nCq^CZs(DS6qdAyaMUB&AU?_FJVYExBeh zBrhGRvEMpZx}}Wnbgg^I>Rwm7kj(COy&JXeepkFk3-5T%>$CEnmy^paT6!5H%*Pp% zo(C;kA)%R=YYq^P%#`b1@af9A#8I8qD_J&OC_zrRit~D!+0WbBRH%YV2@puPG|Cqwl;F>s0s9Gg-BtiFGZ8 zLQ^G*7RgL9C9)C^%skja5v0riy06y8swn;pkGR-!Y)#q8L&+MMK^xs*k(f?un<0Jn|$Vqs;@+*r85#k(>SO zV0XIOm5z1+#9i)lr@H_MPmyyXFJ_mB%9Di#raBrVc;&Zi#rt5<#NS^s+1#~${HFa1+2 z5_*dCo%Ff?eD8h#|9jxeT{5$meesEZeB&n{`OAO2=>2~CnIp>iy1zT`gMWSOXFu+z zSAO@I|9$U=ANwkay+rRvF&-?iUygiEA zzqk_#x^utyJ3s`)JMPOr{A)l4d_V`py!|7kujAzxIPcDlEh26FeMGM4; zsgu5ks6L69MOv&yi68(~OhsMP!-{Z-PQ1WRL=>GEMq(^Rlh{RM%ta*J3AO_Xcz8x= zj7DjkMry1^YrIBm%tme8MsDmzZ~R7Z3`cPsM{+Dja|Fj`tUb3AJ3s_QTYN`&j7NE# zM|!MBd%Q<{%*TgF$B-~afBZ*)3`l_-NP;X#fkeA?WVz4#MOO^QwoAy0Q^%%gMFDfi zw1de1jAKQH6fl~@$dA)VP{P26^vHz+$!QYFtfQp@C;+oyNu+SerC7EOQ2NCwq%O0OiQr5$)ae>vm{Ho980~V zORY@HzkEx#1kAhK%D&7?!(>aagvqrW%chu1v$RXV6wJZo%ddn>!YoTBe8G^+O0;Cm zznn?Oyi3w7&AMdFvkc9$Op3P*P0(D;x{S%vgw54dO~PbL*YwKKl+4%c%EB~F)%?u= z)SS)Q+|A-t%-MX(q)blQv`ybUPOThH=oHPrEWeWAOsrHVq&!U4oJqaZP1KiOxy%c(*)1r+{>Ws&geW(=6p}}tWW7gO{g4C<4nuxJBh38 zNzYu$_O#9V+|Sd5iUlRk2A$3amCOE=&gmS@##~MZbxjY&&&QNa@>I&;yo%ObPyb}l z3B6AVZBUlv$+>U>pG=znEKwH)QQTb5*4)q9+)5lJO%%0D&_vN1&Csc6&-m=o4<*mv zw9yvDP#%rY5QR=6-OVILO)IrgABEA2kkPD+&hkvmFa=ODT}#Z&PcfxSw_H>IGwn+- zolG-T)5V-qH8oMoY|}Bl(>!g`{6tg5G*7&w)AE!G$c)p*G|NEEOFgyBJ=IK7#7+cV zIh&ixnB!6}@KQ-_IX5jjOU2ZVB*~17#m>xBP^CC#jMPspRft>2QB74YiNKXyB zS2eg!ozaV|Re`(JFV$68J;PR|RTWJPN;OeRJ=UNMP}W3C?_|^g9oFyS)l6m9swmc@ zYzrR+(f8y~Xw6b1-OkJuFKO*a#1u_xl~cbw)N+DARm7{yhdJx5&1D*-^;^7HQ1LWO z#W>c%ZCa-_3&~Ag%II669bJo+(kT_)y_iba4cWbTTr3^TksVwA_e5LZ?Ob{7T=oRi zK84G|UDveTP~;TbK?TwwWnSS;&)&V>m2KX9jo!#)SGEPv;Jr-$OkCki&LVx<9yQpM zwa=bKSOz^`4~d(k6Xgt4&yb#nOq*-mHaR`90g2omwRYPWh#Xx?RESq^O29 z(zJEY=3P=htzDfZ)Dg|i^VHGrq~9QYTZNs^4d&JerCkap*!YcI_GM2D_Dvln->7}x zDGl8u^6-=AQ0et?uiR?n|X^?QTilwwdeh?(D9l(tT}g{btvWYXVMIW)@|r z;Oc0O;|iCUOmEJpNwG7GC1jP0EH^sa{lk2Gp=k z=ijB^mTu=d?q1Ix=;xegwXNp}ALm5YXAzuzdu@8f(}A$C-#Xhi}?6y*$Hc1Gu#w&9%B*Bn1(86IAf zP1^icW{4GPET3v6j`9{S-o6H8erC=8PE~OqW$^(Xb1?>LEOu)>&gS)%=@^&tzSd$L zX7P&F&@y&&IY09*w(6uz^IpABCbsdNwsR!q;l5q;F8=Q|w&pe8^A_jvjm2xWc3Lu4 z+K@H$X`NFJckInpY{$N1=RC||R^IS^^0l>WGj?Rch2$VUTlc}e9vxd&*b~YaiGR#YKHGKKJ(Rm_@_W>U<^bQFGMs{ z#$-%+l<&NS>^q88UwN9BNTwjY&x=DlB*P&*MVk-$npb&^bonpriK55l z_?vm5Z~CFn#iHN&qaVffi$bM`KcIhlt#^7}bVENhdO$28pWi^Mr$k)bdbHl8Dx6Azk9=vz#X*8P;~pg7yGIV zd{JEblP`SAKl}&O`wry$k$3z)g#4?Y!Lzsg${&6G6Zc4D{LP2^x>Ni){Q1cjeb^^` z@0-A{NBxHMd!)zr$jAEs(3kz#|NZ2Pdcbpma5;@ADp*FM5ee&nD2 zCDeV}7ckC0!`%mc>hFH(kG$pgJK~SUlh((B=>6~ae)W%dhEV*za~gxZ3H48Z`e(eD z(EQskp>y1S{s#zn0tXT-Xz(DygbEijZ0PVI#E23nQmklEVE_T~2zYsdLk0>Rt|(;; zVDco&lqy%UZ0YhP%$PD~(yVFoCeEBXck=9+QzJ)@AVreY81E?3q)L}EZR+$X)TmOY zQmtzBD%Px8w{q?36>G+g9Y2N~8I}Orv})I~ZR_?e+_-Y*(yeRvF5bL)_ww!Q_b*;} zXU7gT3)Cm##EKXHGj8noF=U(qCR46#SpWgSKna&Ex-l~7(4t3^E^WG{0GS&#ixt}W z?CIFDXVb1NJN4z{->hn*JUETU**af9sa|EDdUt;{B z*WQ6JjR)R?44U_nf<8g$SbiBwh+upCRk&V%p#3))0lHg;>VJE2g27K ziwe%C;e;EqxSo4GruX7|ALjTVkmkkrqmdmp802{uE*KtpL8f%$jv+EOVp^98$k}$E zA-JECE`gc(Z57$KQY=D4OzI1cF~nm-D8mR&pmU zmqTGHemG{HeX0qlqeI@wD5R0rS!0VF(kP>uola`0gN;_nCYnnInpkyhU1w-(h`x5% zm!<+rX{L)_im9wMdAO#XQzE(Polx>>>Zma8DJ-$2rgKQD;nJ(LIv&R7l6l+1rtD?BHRcaxz5bOG}$5%=WV7!U`_V31x`Kxk_ zD~G)Qn9DD_JMy!vT5K|RGV8oE&pjC>mCYSpd~(l48+|lOcU3Gj&dwqIG}Jv$Y+2CJ zHcf5RS!>N~YB81ks?%GGJvMajnz*#pU}H@-+ilZkww6IVF?7yuOBb`7IKg7}TY0#%yUsf9JtkalnN5b7FYXhv2m7A153l-*;hy<=nk~=gt?Re9 zn0vvbLQdJ1r%(H^?_uJqE%V!oKWC(`ME`+2#C=?l;Q zySJatf8qMPbG-n`ZE^&ZZ^uX?)xzB7v{gg~S+Pw?JmP|&crG8>YJ~q&*L@%u#1b~~ zQW->|4!hVx2CZ<4e|wJwdl$Vt_KtPV+fNRI7f4_=tcgBqSRwsI!8SS&k-*#F?0gly zJu>c($1@-ByvRR1AxTb6s$&7~*g3IXE;24FWo%Gc8db&wl#&zW?zT2a#IbV!G_#b= zEhR%Uc!d&mdHW?WBjZZbQ8AdtJZ8kC*vsu9vzgAc$uL`3%x6-wnk>ua~I=F@EgrFYm7>xcY%HmN}N&<7 zdc1(fa&=U4r~{RBNs&U2rWV!XCVeGQ)WNWJ`a2_;dD8l`%QGW3o zA0GR6ET_UTsv`_wCL1Kip)%AwJLN%vh&a?lUXp!DUWC_))2sW%q!eRWM@zurj}uwo2`MtmR*FBrn|B_(kqz5pxcOlw{Sq z#T)7ftLIBUbH~cOAJ%rH~p~wK}n>fd1VW>-Vkuu`#1joZ8o>g+R|j*SmcjVpbEa zJ@)P#WPPEEjq_3`qXs&>}_k!#$Oxt)fe3J zlc_pJJ~s-{NFKEeHH2#tgK4Xk1uAP1iq|6tSBP-*YjorP_{8Aamet(uHJz)4+TB*Q zjnl?3oYjm;fqmC@i?a9P6v^E&SCZe~ex#ty``zH>PKS*YuX6|9)8u}7V90&YyFYB2 z87qe3kFj`9;@cmLpCsZ24o#s6H{?~0JaZ*CImbKxW4`eQpe25JyKueUwZXjRAxh0u zs^+Sh+q~yiQd-MP3vZtjy*L91z|oVA^rb6(06`YI#EUNV;541-RzLdFi#znGbA2{d z|2osN&hxGxE#z4PJJ`j(^}Dq=jc?{rOySH=OUv-as?M=h_sh~)vIOl{N4nZSd~)D) zdDOj@G{{okZdg0{iutr*%KTpSz@Ju1R>pFtrg>gp%2cdb#+H{8rx*4<6z z4X1gh-p!ZS{66PA=Oou#b)=(=&Y=z)J$F0Uz4EiRe;4XJhVO^NUiF{v-g{&_9=MJ+ zDWsK(`0f@z)t2rWOujbrO)pV;oc(p~rSr5nF8um8g_bQw5r18Cq?SLp|2G5g-Q*pzmQ353QT2k)I9`*9Hn6e#jf~>6<0d zTb(gn2<;0d8Ck!1TKWwfCmj;PjoBhGo*t?H9{iD2jGfoWIbnOy;M&<;a425I35UiB zRAZzHTjXC0kwp!DoXBZmLk%9tsi7^gVH;}Upr{4QjUh;s;ewGJ9*zc2F1|u;J zqcIjEG9IHcCL=R0qcbL*E*2s#Qr<19Mu~{cMl_=~J|j17qc?UVIDVrz{vGzc#768Q zHJ)QAs-rKqqdUIiVT_|Zh9f=BqdnIDBR)zVD50bN&D=hQB0L6UKxSh;7UVr1q(LSm zLi*i4>S8)xV{S+z0j-cgR%APV#zHEjMrI^OZsap!2`}+uE$-i0ybB+$3PoC^O6np( zcBD&sq)sDdsigEpvxK4{Ky24Q_Cg;uDAUMPlUsD^GRhuVdN zvcX80fryUih5@KylRhbwMyZraDU(*|lwK*8X6X}DDVKJsmQHDxDk+wR zsS|vunVu<{j%k>tDVw&bmXfKP#%Y=+!44ow3giHu=Bb|UDWCSKpZ=+y;((wIDxntY zp#G_$9%`Q^s-Oa@pE4>AII5%uDx@+hqFU;tW~!!cDyMepq(Z8vhAN`YKn%!$sh%pT urmCv0Dyz1ttG+6%#;UB&Dy`P4t==lG=BlplDzEmcucGP<%zz981OPkFpS@)O literal 0 HcmV?d00001 diff --git a/documentation/index.html b/documentation/index.html new file mode 100644 index 000000000..006a01cae --- /dev/null +++ b/documentation/index.html @@ -0,0 +1,30 @@ + + + Smack Documentation - Jive Software + + + + + +
+Smack Documentation +
+ + +

+Documentation Contents: +

+ + + +
+Copyright © Jive Software 2002-2003 +
+ + + diff --git a/documentation/overview.html b/documentation/overview.html new file mode 100644 index 000000000..56e9b4d4a --- /dev/null +++ b/documentation/overview.html @@ -0,0 +1,55 @@ + + + Smack: Overview - Jive Software + + + + + +
+Smack Overview +
+ +
+« Table of Contents +
+ +

+ +Smack is a library for communicating with XMPP (Jabber) servers to perform +instant messaging and chat. + +

+Key Advantages: +

+ +
    +
  • Extremely simple to use, yet powerful API. Sending a text message to a user + can be accomplished in three lines of code: + +
    +XMPPConnection connection = new XMPPConnection("jabber.org");
+connection.login("mtucker", "password");
+connection.createChat("jsmith@jivesoftware.com").sendMessage("Howdy!");
+
    + + +
  • Doesn't force you to code at the packet level, as other libraries do. Smack provides + intelligent higher level constructs such as the Chat and GroupChat + classes, which let you program more efficiently. + +
  • Does not require that you're familiar with the XMPP XML format, or even that you're familiar with XML. + +
  • Provides easy machine to machine communication. Smack lets you set any number of properties on + each message, including properties that are Java objects. + +
  • Open Source under the Apache License, which means you can incorporate Smack into your commercial or + non-commercial applications. +
+ +
+Copyright © Jive Software 2002-2003 +
+ + + diff --git a/documentation/processing.html b/documentation/processing.html new file mode 100644 index 000000000..e69de29bb diff --git a/documentation/properties.html b/documentation/properties.html new file mode 100644 index 000000000..3a7cdf5f8 --- /dev/null +++ b/documentation/properties.html @@ -0,0 +1,114 @@ + + + Smack: Packet Properties - Jive Software + + + + +
+Packet Properties +
+ +
+« Table of Contents +
+ +

+Smack provides an easy mechanism for attaching arbitrary properties to packets. Each property +has a String name, and a value that is a Java primitive (int, long, float, double, boolean) or +any Serializable object (a Java object is Serializable when it implements the Serializable +interface). +

+ +

+Using the API +

+ +

+All major objects have property support, such as Message objects. The following code +demonstrates how to set properties: +

+ +
+Message message = chat.createMessage();
+// Add a Color object as a property.
+message.setProperty("favoriteColor", new Color(0, 0, 255));
+// Add an int as a property.
+message.setProperty("favoriteNumber", 4);
+chat.sendMessage(message);
+
+ +

+Getting those same properties would use the following code: +

+ +
+Message message = chat.nextMessage();
+// Get a Color object property.
+Color favoriteColor = (Color)message.getProperty("favoriteColor");
+// Get an int property. Note that properties are always returned as
+// Objects, so we must cast the value to an Integer, then convert
+// it to an int.
+int favoriteNumber = ((Integer)message.getProperty("favoriteNumber")).intValue();
+
+ +

+Objects as Properties +

+ +

+Using objects as property values is a very powerful and easy way to exchange data. However, +you should keep the following in mind: +

+ +
    +
  • When you send a Java object, only clients running Java will be able to interpret the data. + So, consider using a series of primitive values to transfer data instead. + +
  • Objects sent as property values must implement Serialiable. Additionally, both the sender + and receiver must have identical versions of the class, or a serialization exception + will occur when de-serialiazing the object. + +
  • Serialized objects can potentially be quite large, which will use more bandwidth and + server resources. +
+ +

+XML Format +

+ +

+The current XML format used to send property data is not a standard, so will likely not be +recognized by clients not using Smack. The XML looks like the following (comments added for +clarity): +

+ +
+<!-- All properties are in a x block. --> 
+<x xmlns="http://www.jivesoftware.com/xmlns/xmpp/properties">
+  <!-- First, a property named "prop1" that's an integer. --> 
+  <property>
+    <name>prop1</name>
+    <value type="integer">123</value>
+  <property>
+  <!-- Next, a Java object that's been serialized and then converted
+       from binary data to base-64 encoded text. -->  
+  <property>
+    <name>blah2</name>
+    <value type="java-object">adf612fna9nab</value>
+  <property>
+</x> 
+
+ +

+The currently supported types are: integer, long, float, +double, boolean, string, and java-object. +

+ +
+Copyright © Jive Software 2002-2003 +
+ + + diff --git a/documentation/style.css b/documentation/style.css new file mode 100644 index 000000000..082da56a1 --- /dev/null +++ b/documentation/style.css @@ -0,0 +1,56 @@ +BODY { + font-size : 100%; + background-color : #fff; +} +BODY, TD, TH { + font-family : tahoma, arial, helvetica; + font-size : 0.8em; +} +PRE, TT, CODE { + font-family : courier new, monospaced; + font-size : 1.0em; +} +A:hover { + text-decoration : none; +} +LI { + padding-bottom : 4px; +} +.header { + font-size : 1.4em; + font-weight : bold; + width : 100%; + border-bottom : 1px #ccc solid; + padding-bottom : 2px; +} +.subheader { + font-weight : bold; +} +.footer { + font-size : 0.8em; + color : #999; + text-align : center; + width : 100%; + border-top : 1px #ccc solid; + padding-top : 2px; +} +.code { + border : 1px #ccc solid; + padding : 0em 1.0em 0em 1.0em; + margin : 4px 0px 4px 0px; +} +.nav, .nav A { + font-family : verdana; + font-size : 0.85em; + color : #600; + text-decoration : none; + font-weight : bold; +} +.nav { + width : 100%; + border-bottom : 1px #ccc solid; + padding : 3px 3px 5px 1px; +} +.nav A:hover { + text-decoration : underline; +} \ No newline at end of file