Java Doc for Guard.java in  » Web-Services » restlet-1.0.8 » org » restlet » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Web Services » restlet 1.0.8 » org.restlet 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.restlet.Uniform
      org.restlet.Restlet
         org.restlet.Filter
            org.restlet.Guard

Guard
public class Guard extends Filter (Code)
Filter guarding the access to an attached Restlet.
See Also:    Tutorial: Guarding * access to sensitive resources
author:
   Jerome Louvel (contact@noelios.com)



Constructor Summary
public  Guard(Context context, ChallengeScheme scheme, String realm)
     Constructor.

Method Summary
public  voidaccept(Request request, Response response)
     Accepts the call.
public  intauthenticate(Request request)
     Indicates if the call is properly authenticated.
public  booleanauthorize(Request request)
     Indicates if the request is authorized to pass through the Guard.
public  voidchallenge(Response response)
     Challenges the client by adding a challenge request to the response and by setting the status to CLIENT_ERROR_UNAUTHORIZED.
protected  booleancheckSecret(String identifier, char[] secret)
     Indicates if the secret is valid for the given identifier.
public  voiddoHandle(Request request, Response response)
     Handles the call by distributing it to the next Restlet.
protected  char[]findSecret(String identifier)
     Finds the secret associated to a given identifier.
public  voidforbid(Response response)
     Rejects the call due to a failed authentication or authorization.
public  Map<String, char[]>getSecrets()
     Returns the map of identifiers and secrets.


Constructor Detail
Guard
public Guard(Context context, ChallengeScheme scheme, String realm)(Code)
Constructor.
Parameters:
  context - The context.
Parameters:
  scheme - The authentication scheme to use.
Parameters:
  realm - The authentication realm.




Method Detail
accept
public void accept(Request request, Response response)(Code)
Accepts the call. By default, it is invoked it the request is authenticated and authorized, and asks the attached Restlet to handle the call.
Parameters:
  request - The request to accept.
Parameters:
  response - The response to accept.



authenticate
public int authenticate(Request request)(Code)
Indicates if the call is properly authenticated. By default, this delegates credential checking to checkSecret().
Parameters:
  request - The request to authenticate. -1 if the given credentials were invalid, 0 if no credentialswere found and 1 otherwise.
See Also:   Guard.checkSecret(String,char[])



authorize
public boolean authorize(Request request)(Code)
Indicates if the request is authorized to pass through the Guard. This method is only called if the call was sucessfully authenticated. It always returns true by default. If specific checks are required, they could be added by overriding this method.
Parameters:
  request - The request to authorize. True if the request is authorized.



challenge
public void challenge(Response response)(Code)
Challenges the client by adding a challenge request to the response and by setting the status to CLIENT_ERROR_UNAUTHORIZED.
Parameters:
  response - The response to update.



checkSecret
protected boolean checkSecret(String identifier, char[] secret)(Code)
Indicates if the secret is valid for the given identifier. By default, this returns true given the correct login/password couple as verified via the findSecret() method.
Parameters:
  identifier - the identifier
Parameters:
  secret - the identifier's secret true if the secret is valid for the given identifier



doHandle
public void doHandle(Request request, Response response)(Code)
Handles the call by distributing it to the next Restlet.
Parameters:
  request - The request to handle.
Parameters:
  response - The response to update.



findSecret
protected char[] findSecret(String identifier)(Code)
Finds the secret associated to a given identifier. By default it looks up into the secrets map, but this behavior can be overriden.
Parameters:
  identifier - The identifier to lookup. The secret associated to the identifier or null.



forbid
public void forbid(Response response)(Code)
Rejects the call due to a failed authentication or authorization. This can be overriden to change the defaut behavior, for example to display an error page. By default, if authentication is required, the challenge method is invoked, otherwise the call status is set to CLIENT_ERROR_FORBIDDEN.
Parameters:
  response - The reject response.



getSecrets
public Map<String, char[]> getSecrets()(Code)
Returns the map of identifiers and secrets. The map of identifiers and secrets.



Methods inherited from org.restlet.Filter
protected void afterHandle(Request request, Response response)(Code)(Java Doc)
protected void beforeHandle(Request request, Response response)(Code)(Java Doc)
protected void doHandle(Request request, Response response)(Code)(Java Doc)
public Restlet getNext()(Code)(Java Doc)
final public void handle(Request request, Response response)(Code)(Java Doc)
public boolean hasNext()(Code)(Java Doc)
public void setNext(Restlet next)(Code)(Java Doc)
public void setNext(Class<? extends Resource> targetClass)(Code)(Java Doc)

Methods inherited from org.restlet.Restlet
public Context getContext()(Code)(Java Doc)
public Logger getLogger()(Code)(Java Doc)
public void handle(Request request, Response response)(Code)(Java Doc)
protected synchronized void init(Request request, Response response)(Code)(Java Doc)
public synchronized boolean isStarted()(Code)(Java Doc)
public synchronized boolean isStopped()(Code)(Java Doc)
public void setContext(Context context)(Code)(Java Doc)
public synchronized void start() throws Exception(Code)(Java Doc)
public synchronized void stop() throws Exception(Code)(Java Doc)

Methods inherited from org.restlet.Uniform
final public Response delete(String resourceUri)(Code)(Java Doc)
final public Response delete(Reference resourceRef)(Code)(Java Doc)
final public Response get(String resourceUri)(Code)(Java Doc)
final public Response get(Reference resourceRef)(Code)(Java Doc)
final public Response handle(Request request)(Code)(Java Doc)
abstract public void handle(Request request, Response response)(Code)(Java Doc)
final public Response head(String resourceUri)(Code)(Java Doc)
final public Response head(Reference resourceRef)(Code)(Java Doc)
final public Response options(String resourceUri)(Code)(Java Doc)
final public Response options(Reference resourceRef)(Code)(Java Doc)
final public Response post(String resourceUri, Representation entity)(Code)(Java Doc)
final public Response post(Reference resourceRef, Representation entity)(Code)(Java Doc)
final public Response put(String resourceUri, Representation entity)(Code)(Java Doc)
final public Response put(Reference resourceRef, Representation entity)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.