Java Doc for CookieSpecBase.java in  » Net » Apache-common-HttpClient » org » apache » commons » httpclient » cookie » 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 » Net » Apache common HttpClient » org.apache.commons.httpclient.cookie 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.commons.httpclient.cookie.CookieSpecBase

All known Subclasses:   org.apache.commons.httpclient.cookie.NetscapeDraftSpec,  org.apache.commons.httpclient.cookie.RFC2109Spec,  org.apache.commons.httpclient.cookie.RFC2965Spec,
CookieSpecBase
public class CookieSpecBase implements CookieSpec(Code)
Cookie management functions shared by all specification.
author:
   B.C. Holmes
author:
   Park, Sung-Gu
author:
   Doug Sale
author:
   Rod Waldhoff
author:
   dIon Gillard
author:
   Sean C. Sullivan
author:
   John Evans
author:
   Marc A. Saegesser
author:
   Oleg Kalnichevski
author:
   Mike Bowler
since:
   2.0


Field Summary
final protected static  LogLOG
    

Constructor Summary
public  CookieSpecBase()
    

Method Summary
public  booleandomainMatch(String host, String domain)
     Performs domain-match as implemented in common browsers.
Parameters:
  host - The target host.
Parameters:
  domain - The cookie domain attribute.
public  StringformatCookie(Cookie cookie)
    
public  HeaderformatCookieHeader(Cookie[] cookies)
     Create a "Cookie" Header containing all Cookie s in cookies.
public  HeaderformatCookieHeader(Cookie cookie)
     Create a "Cookie" Header containing the Cookie .
public  StringformatCookies(Cookie[] cookies)
    
public  CollectiongetValidDateFormats()
    
public  booleanmatch(String host, int port, String path, boolean secure, Cookie cookie)
     Return true if the cookie should be submitted with a request with given attributes, false otherwise.
public  Cookie[]match(String host, int port, String path, boolean secure, Cookie cookies)
     Return an array of Cookie s that should be submitted with a request with given attributes, false otherwise.
public  Cookie[]parse(String host, int port, String path, boolean secure, String header)
     Parses the Set-Cookie value into an array of Cookies.
public  Cookie[]parse(String host, int port, String path, boolean secure, Header header)
     Parse the "Set-Cookie" Header into an array of Cookie s.
public  voidparseAttribute(NameValuePair attribute, Cookie cookie)
     Parse the cookie attribute and update the corresponsing Cookie properties.
public  booleanpathMatch(String path, String topmostPath)
     Performs path-match as implemented in common browsers.
Parameters:
  path - The target path.
Parameters:
  topmostPath - The cookie path attribute.
public  voidsetValidDateFormats(Collection datepatterns)
    
public  voidvalidate(String host, int port, String path, boolean secure, Cookie cookie)
    

Field Detail
LOG
final protected static Log LOG(Code)
Log object




Constructor Detail
CookieSpecBase
public CookieSpecBase()(Code)
Default constructor




Method Detail
domainMatch
public boolean domainMatch(String host, String domain)(Code)
Performs domain-match as implemented in common browsers.
Parameters:
  host - The target host.
Parameters:
  domain - The cookie domain attribute. true if the specified host matches the given domain.



formatCookie
public String formatCookie(Cookie cookie)(Code)
Return a string suitable for sending in a "Cookie" header
Parameters:
  cookie - a Cookie to be formatted as string a string suitable for sending in a "Cookie" header.



formatCookieHeader
public Header formatCookieHeader(Cookie[] cookies)(Code)
Create a "Cookie" Header containing all Cookie s in cookies.
Parameters:
  cookies - an array of Cookies to be formatted as a "Cookie" header a "Cookie" Header.



formatCookieHeader
public Header formatCookieHeader(Cookie cookie)(Code)
Create a "Cookie" Header containing the Cookie .
Parameters:
  cookie - Cookies to be formatted as a Cookieheader a Cookie header.



formatCookies
public String formatCookies(Cookie[] cookies) throws IllegalArgumentException(Code)
Create a "Cookie" header value containing all Cookie s in cookies suitable for sending in a "Cookie" header
Parameters:
  cookies - an array of Cookies to be formatted a string suitable for sending in a Cookie header.
throws:
  IllegalArgumentException - if an input parameter is illegal



getValidDateFormats
public Collection getValidDateFormats()(Code)



match
public boolean match(String host, int port, String path, boolean secure, Cookie cookie)(Code)
Return true if the cookie should be submitted with a request with given attributes, false otherwise.
Parameters:
  host - the host to which the request is being submitted
Parameters:
  port - the port to which the request is being submitted (ignored)
Parameters:
  path - the path to which the request is being submitted
Parameters:
  secure - true if the request is using a secure connection
Parameters:
  cookie - Cookie to be matched true if the cookie matches the criterium



match
public Cookie[] match(String host, int port, String path, boolean secure, Cookie cookies)(Code)
Return an array of Cookie s that should be submitted with a request with given attributes, false otherwise.
Parameters:
  host - the host to which the request is being submitted
Parameters:
  port - the port to which the request is being submitted (currentlyignored)
Parameters:
  path - the path to which the request is being submitted
Parameters:
  secure - true if the request is using a secure protocol
Parameters:
  cookies - an array of Cookies to be matched an array of Cookies matching the criterium



parse
public Cookie[] parse(String host, int port, String path, boolean secure, String header) throws MalformedCookieException(Code)
Parses the Set-Cookie value into an array of Cookies.

The syntax for the Set-Cookie response header is:

 set-cookie      =    "Set-Cookie:" cookies
 cookies         =    1#cookie
 cookie          =    NAME "=" VALUE * (";" cookie-av)
 NAME            =    attr
 VALUE           =    value
 cookie-av       =    "Comment" "=" value
 |    "Domain" "=" value
 |    "Max-Age" "=" value
 |    "Path" "=" value
 |    "Secure"
 |    "Version" "=" 1*DIGIT
 

Parameters:
  host - the host from which the Set-Cookie value wasreceived
Parameters:
  port - the port from which the Set-Cookie value wasreceived
Parameters:
  path - the path from which the Set-Cookie value wasreceived
Parameters:
  secure - true when the Set-Cookie value wasreceived over secure conection
Parameters:
  header - the Set-Cookie received from the server an array of Cookies parsed from the Set-Cookie value
throws:
  MalformedCookieException - if an exception occurs during parsing



parse
public Cookie[] parse(String host, int port, String path, boolean secure, Header header) throws MalformedCookieException(Code)
Parse the "Set-Cookie" Header into an array of Cookie s.

The syntax for the Set-Cookie response header is:

 set-cookie      =    "Set-Cookie:" cookies
 cookies         =    1#cookie
 cookie          =    NAME "=" VALUE * (";" cookie-av)
 NAME            =    attr
 VALUE           =    value
 cookie-av       =    "Comment" "=" value
 |    "Domain" "=" value
 |    "Max-Age" "=" value
 |    "Path" "=" value
 |    "Secure"
 |    "Version" "=" 1*DIGIT
 

Parameters:
  host - the host from which the Set-Cookie header wasreceived
Parameters:
  port - the port from which the Set-Cookie header wasreceived
Parameters:
  path - the path from which the Set-Cookie header wasreceived
Parameters:
  secure - true when the Set-Cookie header wasreceived over secure conection
Parameters:
  header - the Set-Cookie received from the server an array of Cookies parsed from the "Set-Cookie" header
throws:
  MalformedCookieException - if an exception occurs during parsing



parseAttribute
public void parseAttribute(NameValuePair attribute, Cookie cookie) throws MalformedCookieException(Code)
Parse the cookie attribute and update the corresponsing Cookie properties.
Parameters:
  attribute - HeaderElement cookie attribute from theSet- Cookie
Parameters:
  cookie - Cookie to be updated
throws:
  MalformedCookieException - if an exception occurs during parsing



pathMatch
public boolean pathMatch(String path, String topmostPath)(Code)
Performs path-match as implemented in common browsers.
Parameters:
  path - The target path.
Parameters:
  topmostPath - The cookie path attribute. true if the paths match



setValidDateFormats
public void setValidDateFormats(Collection datepatterns)(Code)



validate
public void validate(String host, int port, String path, boolean secure, Cookie cookie) throws MalformedCookieException(Code)
Performs most common Cookie validation
Parameters:
  host - the host from which the Cookie was received
Parameters:
  port - the port from which the Cookie was received
Parameters:
  path - the path from which the Cookie was received
Parameters:
  secure - true when the Cookie was received using asecure connection
Parameters:
  cookie - The cookie to validate.
throws:
  MalformedCookieException - if an exception occurs duringvalidation



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.