|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface CookieSpec
Defines the cookie management specification.
Cookie management specification must define
| Field Summary | |
|---|---|
static String |
PATH_DELIM
Path delimiter |
static char |
PATH_DELIM_CHAR
Path delimiting charachter |
| Method Summary | |
|---|---|
boolean |
domainMatch(String host,
String domain)
Performs domain-match as defined by the cookie specification. |
String |
formatCookie(Cookie cookie)
Create a "Cookie" header value for an array of cookies. |
Header |
formatCookieHeader(Cookie cookie)
Create a "Cookie" Header for single Cookie. |
Header |
formatCookieHeader(Cookie[] cookies)
Create a "Cookie" Header for an array of Cookies. |
String |
formatCookies(Cookie[] cookies)
Create a "Cookie" header value for an array of cookies. |
Collection |
getValidDateFormats()
Returns the Collection of date patterns used for parsing. |
boolean |
match(String host,
int port,
String path,
boolean secure,
Cookie cookie)
Determines if a Cookie matches a location. |
Cookie[] |
match(String host,
int port,
String path,
boolean secure,
Cookie[] cookies)
Determines which of an array of Cookies matches a location. |
Cookie[] |
parse(String host,
int port,
String path,
boolean secure,
Header header)
Parse the "Set-Cookie" Header into an array of Cookies. |
Cookie[] |
parse(String host,
int port,
String path,
boolean secure,
String header)
Parse the "Set-Cookie" header value into Cookie array. |
void |
parseAttribute(NameValuePair attribute,
Cookie cookie)
Parse the cookie attribute and update the corresponsing Cookie properties. |
boolean |
pathMatch(String path,
String topmostPath)
Performs path-match as defined by the cookie specification. |
void |
setValidDateFormats(Collection datepatterns)
Sets the Collection of date patterns used for parsing. |
void |
validate(String host,
int port,
String path,
boolean secure,
Cookie cookie)
Validate the cookie according to validation rules defined by the cookie specification. |
| Field Detail |
|---|
static final String PATH_DELIM
static final char PATH_DELIM_CHAR
| Method Detail |
|---|
Cookie[] parse(String host,
int port,
String path,
boolean secure,
String header)
throws MalformedCookieException,
IllegalArgumentException
This method will not perform the validation of the resultant
Cookies
host - the host which sent the Set-Cookie headerport - the port which sent the Set-Cookie headerpath - the path which sent the Set-Cookie headersecure - true when the Set-Cookie header
was received over secure conectionheader - the Set-Cookie received from the server
MalformedCookieException - if an exception occurs during parsing
IllegalArgumentException - if an input parameter is illegalvalidate(String, int, String, boolean, Cookie)
Cookie[] parse(String host,
int port,
String path,
boolean secure,
Header header)
throws MalformedCookieException,
IllegalArgumentException
This method will not perform the validation of the resultant
Cookies
host - the host which sent the Set-Cookie headerport - the port which sent the Set-Cookie headerpath - the path which sent the Set-Cookie headersecure - true when the Set-Cookie header
was received over secure conectionheader - the Set-Cookie received from the server
MalformedCookieException - if an exception occurs during parsing
IllegalArgumentException - if an input parameter is illegalvalidate(String, int, String, boolean, Cookie)
void parseAttribute(NameValuePair attribute,
Cookie cookie)
throws MalformedCookieException,
IllegalArgumentException
attribute - cookie attribute from the Set-Cookiecookie - the to be updated
MalformedCookieException - if an exception occurs during parsing
IllegalArgumentException - if an input parameter is illegal
void validate(String host,
int port,
String path,
boolean secure,
Cookie cookie)
throws MalformedCookieException,
IllegalArgumentException
host - the host from which the Cookie was receivedport - the port from which the Cookie was receivedpath - the path from which the Cookie was receivedsecure - true when the Cookie was received
using a secure connectioncookie - the Cookie to validate
MalformedCookieException - if the cookie is invalid
IllegalArgumentException - if an input parameter is illegalvoid setValidDateFormats(Collection datepatterns)
Collection of date patterns used for parsing. The String patterns must be
compatible with SimpleDateFormat.
datepatterns - collection of date patternsCollection getValidDateFormats()
Collection of date patterns used for parsing. The String patterns are compatible
with the SimpleDateFormat.
boolean match(String host,
int port,
String path,
boolean secure,
Cookie cookie)
host - the host to which the request is being submittedport - the port to which the request is being submittedpath - the path to which the request is being submittedsecure - true if the request is using a secure connectioncookie - the Cookie to be matched
Cookie[] match(String host,
int port,
String path,
boolean secure,
Cookie[] cookies)
host - the host to which the request is being submittedport - the port to which the request is being submitted
(currenlty ignored)path - the path to which the request is being submittedsecure - true if the request is using a secure protocolcookies - an array of Cookies to be matched
boolean domainMatch(String host,
String domain)
host - The target host.domain - The cookie domain attribute.
boolean pathMatch(String path,
String topmostPath)
path - The target path.topmostPath - The cookie path attribute.
String formatCookie(Cookie cookie)
cookie - the cookie to be formatted as string
String formatCookies(Cookie[] cookies)
throws IllegalArgumentException
cookies - the Cookies to be formatted
IllegalArgumentException - if an input parameter is illegal
Header formatCookieHeader(Cookie[] cookies)
throws IllegalArgumentException
cookies - the Cookies format into a Cookie header
IllegalArgumentException - if an input parameter is illegal
Header formatCookieHeader(Cookie cookie)
throws IllegalArgumentException
cookie - the Cookie format as a Cookie header
IllegalArgumentException - if an input parameter is illegal
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||