-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathchap-thirdparty.lyx
2137 lines (1394 loc) · 32.9 KB
/
chap-thirdparty.lyx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#LyX 1.6.7 created this file. For more info see http://www.lyx.org/
\lyxformat 345
\begin_document
\begin_header
\textclass book
\use_default_options false
\language english
\inputencoding auto
\font_roman default
\font_sans default
\font_typewriter default
\font_default_family default
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
\graphics default
\paperfontsize default
\spacing single
\use_hyperref false
\papersize default
\use_geometry false
\use_amsmath 1
\use_esint 1
\cite_engine basic
\use_bibtopic false
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\defskip medskip
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\author ""
\author ""
\end_header
\begin_body
\begin_layout Chapter
Third Party Integrations
\end_layout
\begin_layout Standard
In this chapter we'll explore how you can integrate Lift with some well-known
third party libraries and applications
\end_layout
\begin_layout Section
OpenID Integration
\end_layout
\begin_layout Standard
The OpenID Foundation
\begin_inset Foot
status open
\begin_layout Plain Layout
\begin_inset Flex URL
status open
\begin_layout Plain Layout
http://openid.net/
\end_layout
\end_inset
\end_layout
\end_inset
explain OpenID as:
\end_layout
\begin_layout Standard
\begin_inset Quotes eld
\end_inset
OpenID eliminates the need for multiple usernames across different websites,
simplifying your online experience.
\end_layout
\begin_layout Standard
You get to choose the OpenID Provider that best meets your needs and most
importantly that you trust.
At the same time, your OpenID can stay with you, no matter which Provider
you move to.
And best of all, the OpenID technology is not proprietary and is completely
free.
For businesses, this means a lower cost of password and account management,
while drawing new web traffic.
OpenID lowers user frustration by letting users have control of their login.
For geeks, OpenID is an open, decentralized, free framework for user-centric
digital identity.
OpenID takes advantage of already existing internet technology (URI, HTTP,
SSL, Diffie-Hellman) and realizes that people are already creating identities
for themselves whether it be at their blog, photostream, profile page,
etc.
With OpenID you can easily transform one of these existing URIs into an
account which can be used at sites which support OpenID logins.
\end_layout
\begin_layout Standard
OpenID is still in the adoption phase and is becoming more and more popular,
as large organizations like AOL, Microsoft, Sun, Novell, etc.
begin to accept and provide OpenIDs.
Today it is estimated that there are over 160-million OpenID enabled URIs
with nearly ten-thousand sites supporting OpenID logins.
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Standard
Lift provides openId support using onepID4Java
\begin_inset Foot
status open
\begin_layout Plain Layout
http://code.google.com/p/openid4java/
\end_layout
\end_inset
.
It provides two fundamental traits
\family typewriter
net.liftweb.openId.OpenIdVendor
\family default
and
\family typewriter
net.liftweb.openId.OpenIdConsumer.
OpenIdVendor
\family default
contains variables such as:
\end_layout
\begin_layout Itemize
PathRoot - The path sequence for processing OpenID requests.
The default value is
\begin_inset Quotes eld
\end_inset
openid
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Itemize
LoginPath - The path sequence for processing login requests.
The default value is
\begin_inset Quotes eld
\end_inset
login
\begin_inset Quotes erd
\end_inset
.
The login path will be /openid/login
\end_layout
\begin_layout Itemize
LogoutPath - The path sequence for processing logout requests.
The default value is
\begin_inset Quotes eld
\end_inset
logout
\begin_inset Quotes erd
\end_inset
.
The login path will be /openid/logour
\end_layout
\begin_layout Itemize
ResponsePath - The path sequence for processing login requests.
The default value is
\begin_inset Quotes eld
\end_inset
response
\begin_inset Quotes erd
\end_inset
.
The login path will be /openid/response
\end_layout
\begin_layout Itemize
PostParamName - The form parameter name containing the OpeID identity URL
entered by the user
\end_layout
\begin_layout Standard
Also the vendor trait contains the loginForm function that returns the login
form containing an input text field for the OpenID identity and the submit
button.
The form will point to /<PathRoot>/<LoginPath> where PathRoot and LoginPath
are the variables described above.
Here is an example:
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
OpenID example
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
// Your template
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
<lift:OpenID.form>
\end_layout
\begin_layout Plain Layout
<openId:renderForm/>
\end_layout
\begin_layout Plain Layout
</lift:OpenID.form>
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
// Your snippet
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
class OpenID {
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
def renderForm(xhtml: NodeSeq) : NodeSeq = {
\end_layout
\begin_layout Plain Layout
SimpleOpenIdVendor.loginForm
\end_layout
\begin_layout Plain Layout
}
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
}
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
class Boot {
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
...
\end_layout
\begin_layout Plain Layout
// This is needed in order to process the login and logout requests and
also to process
\end_layout
\begin_layout Plain Layout
// the response comming from OpenID provider
\end_layout
\begin_layout Plain Layout
LiftRules.dispatch.append(SimpleOpenIdVendor.dispatchPF)
\end_layout
\begin_layout Plain Layout
...
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
}
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Standard
That is pretty much all you need to add into your Lift application.
The authentication flow is:
\end_layout
\begin_layout Enumerate
User accesses your lift page that contains the OpenID form
\end_layout
\begin_layout Enumerate
User enters his/her OpenID identity URL and submits the form.
Note that you don't have to use the default login form asyou can construct
your own as long as the form is submitted to the correct path and contains
the correct input text parameter name.
\end_layout
\begin_layout Enumerate
The dispatchPF function that we appended above will process the /openid/login
request and will send the authentication request to the Identity Provider
site
\end_layout
\begin_layout Enumerate
Identity Provider will validate the user and redirect back to your Lift
application to /openid/response path.
\end_layout
\begin_layout Enumerate
The response is validated using OpenId4Java library
\end_layout
\begin_layout Enumerate
\family typewriter
OpenIdConsumer.postLogin
\family default
gets called.
\end_layout
\begin_layout Standard
The SimpleOpenIDVendor looks like:
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
SimpleOpenIDVendor
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
trait SimpleOpenIdVendor extends OpenIdVendor {
\end_layout
\begin_layout Plain Layout
type UserType = Identifier
\end_layout
\begin_layout Plain Layout
type ConsumerType = OpenIdConsumer[UserType]
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
def currentUser = OpenIdUser.is
\end_layout
\begin_layout Plain Layout
def postLogin(id: Box[Identifier],res: VerificationResult): Unit = {
\end_layout
\begin_layout Plain Layout
id match {
\end_layout
\begin_layout Plain Layout
case Full(id) => S.notice("Welcome "+id)
\end_layout
\begin_layout Plain Layout
case _ => S.error("Failed to authenticate")
\end_layout
\begin_layout Plain Layout
}
\end_layout
\begin_layout Plain Layout
OpenIdUser(id)
\end_layout
\begin_layout Plain Layout
}
\end_layout
\begin_layout Plain Layout
def logUserOut() {
\end_layout
\begin_layout Plain Layout
OpenIdUser.remove
\end_layout
\begin_layout Plain Layout
}
\end_layout
\begin_layout Plain Layout
def displayUser(in: UserType): NodeSeq = Text("Welcome "+in)
\end_layout
\begin_layout Plain Layout
def createAConsumer = new AnyRef with OpenIDConsumer[UserType]
\end_layout
\begin_layout Plain Layout
}
\end_layout
\begin_layout Plain Layout
object SimpleOpenIdVendor extends SimpleOpenIdVendor
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Note the postLogin implementation.
Of course if you need a more complex post-login processing you can extend
OpenIdVendor by yourself.
\end_layout
\begin_layout Standard
During this message exchange between the Identity Provider ans your Lift
application, Lift utilizes a couple of SessionVars:
\end_layout
\begin_layout Itemize
OpenIdObject - holds an OpenIdConsumer
\end_layout
\begin_layout Itemize
OpenIdUser - holding an org.openid4java.discovery.Identifier
\end_layout
\begin_layout Section
AMQP
\end_layout
\begin_layout Standard
AMQP stands for
\series bold
A
\series default
dvanced
\series bold
M
\series default
essage
\series bold
Q
\series default
ueuing
\series bold
P
\series default
rotocol
\begin_inset Foot
status open
\begin_layout Plain Layout
http://jira.amqp.org/confluence/display/AMQP/Advanced+Message+Queuing+Protocol
\end_layout
\end_inset
.
It is an open Internet protocol for messaging.
It is concepted as a binary representation of messages.
Lift facilitates the work with AMQP using the RabbitMQ
\begin_inset Foot
status open
\begin_layout Plain Layout
http://www.rabbitmq.com/
\end_layout
\end_inset
Java implementation.
There are two fundamental classes:
\end_layout
\begin_layout Itemize
\family typewriter
net.liftweb.amqp.AMQPSender
\family default
- used for sending AMQP messages
\end_layout
\begin_layout Itemize
\family typewriter
net.liftweb.amqp.AMQPDispatcher
\family default
- used for receiving AMQP messages
\end_layout
\begin_layout Standard
Let's see how we can use Lift to send AMQP messages
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
AMQP sending messages example
\begin_inset CommandInset label
LatexCommand label
name "lst:AMQP-sending-messages"
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
import net.liftweb.amqp._
\end_layout
\begin_layout Plain Layout
import com.rabbitmq.client._
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
val params = new ConnectionParameters
\end_layout
\begin_layout Plain Layout
// All of the params, exchanges, and queues are all just example data.
\end_layout
\begin_layout Plain Layout
params.setUsername("guest")
\end_layout
\begin_layout Plain Layout
params.setPassword("guest")
\end_layout
\begin_layout Plain Layout
params.setVirtualHost("/")
\end_layout
\begin_layout Plain Layout
params.setRequestedHeartbeat(0)
\end_layout
\begin_layout Plain Layout
val factory = new ConnectionFactory(params)
\end_layout
\begin_layout Plain Layout
val amqp = new StringAMQPSender(factory, "localhost", 5672, "mult", "routerout
e")
\end_layout
\begin_layout Plain Layout
amqp.start
\end_layout
\begin_layout Plain Layout
amqp ! AMQPMessage("hi")
\end_layout
\end_inset
\end_layout
\begin_layout Standard
As you can see the
\family typewriter
AMQSender
\family default
is leveraging Scala actors to send messages.
Scala actors and AMQP messaging concepts play very well together.
\end_layout
\begin_layout Standard
Now let's see how we can receive and process AMQP messages:
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
AMQP receiving messages example
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
import net.liftweb.amqp._
\end_layout
\begin_layout Plain Layout
import com.rabbitmq.client._
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
/**
\end_layout
\begin_layout Plain Layout
* Example Dispatcher that listens on an example queue and exchange.
Use this
\end_layout
\begin_layout Plain Layout
* as your guiding example for creating your own Dispatcher.
\end_layout
\begin_layout Plain Layout
*
\end_layout
\begin_layout Plain Layout
*/
\end_layout
\begin_layout Plain Layout
class ExampleSerializedAMQPDispatcher[T](factory: ConnectionFactory, host:
String, port: Int)
\end_layout
\begin_layout Plain Layout
extends AMQPDispatcher[T](factory, host, port) {
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
override def configure(channel: Channel) {
\end_layout
\begin_layout Plain Layout
// Get the ticket.
\end_layout
\begin_layout Plain Layout
val ticket = channel.accessRequest("/data")
\end_layout
\begin_layout Plain Layout
// Set up the exchange and queue
\end_layout
\begin_layout Plain Layout
channel.exchangeDeclare(ticket, "mult", "direct")
\end_layout
\begin_layout Plain Layout
channel.queueDeclare(ticket, "mult_queue")
\end_layout
\begin_layout Plain Layout
channel.queueBind(ticket, "mult_queue", "mult", "routeroute")
\end_layout
\begin_layout Plain Layout
// Use the short version of the basicConsume method for convenience.
\end_layout
\begin_layout Plain Layout
channel.basicConsume(ticket, "mult_queue", false, new SerializedConsumer(chan
nel, this))
\end_layout
\begin_layout Plain Layout
}
\end_layout
\begin_layout Plain Layout
}
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
/**
\end_layout
\begin_layout Plain Layout
* Example class that accepts Strings coming in from the
\end_layout
\begin_layout Plain Layout
* ExampleSerializedAMQPDispatcher.
\end_layout
\begin_layout Plain Layout
*/
\end_layout
\begin_layout Plain Layout
class ExampleStringAMQPListener {
\end_layout
\begin_layout Plain Layout
val params = new ConnectionParameters
\end_layout
\begin_layout Plain Layout
params.setUsername("guest")
\end_layout
\begin_layout Plain Layout
params.setPassword("guest")
\end_layout
\begin_layout Plain Layout
params.setVirtualHost("/")
\end_layout
\begin_layout Plain Layout
params.setRequestedHeartbeat(0)
\end_layout
\begin_layout Plain Layout
val factory = new ConnectionFactory(params)
\end_layout
\begin_layout Plain Layout
// thor.local is a machine on your network with rabbitmq listening on port
5672
\end_layout
\begin_layout Plain Layout
val amqp = new ExampleSerializedAMQPDispatcher[String](factory, "thor.local",
5672)
\end_layout
\begin_layout Plain Layout
amqp.start
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
// Example Listener that just prints the String it receives.
\end_layout
\begin_layout Plain Layout
class StringListener extends Actor {
\end_layout
\begin_layout Plain Layout
def act = {
\end_layout
\begin_layout Plain Layout
react {
\end_layout
\begin_layout Plain Layout
case msg@AMQPMessage(contents: String) => println("received: " +
msg); act
\end_layout
\begin_layout Plain Layout
}
\end_layout
\begin_layout Plain Layout
}
\end_layout
\begin_layout Plain Layout
}
\end_layout
\begin_layout Plain Layout
val stringListener = new StringListener()
\end_layout
\begin_layout Plain Layout
stringListener.start
\end_layout
\begin_layout Plain Layout
amqp ! AMQPAddListener(stringListener)
\end_layout
\begin_layout Plain Layout
}
\end_layout
\end_inset