2011/08/05 - Jakarta Cactus has been retired.

For more information, please explore the Attic.

Clover coverage report - Cactus 1.8dev for J2EE API 1.3

Coverage timestamp: Sun Mar 26 2006 18:50:18 BRT

FRAMES NO FRAMES

file stats:	LOC:	371		Methods:	23
	NCLOC:	144		Classes:	1

30 day Evaluation Version distributed via the Maven Jar Repository. Clover is not free. You have 30 days to evaluate it. Please visit http://www.thecortex.net/clover to obtain a licensed version of Clover

Source file

Conditionals

Statements

Methods

TOTAL

Cookie.java

40%

48.9%

65.2%

52.6%

 /* 
  * ========================================================================
  * 
  * Copyright 2001-2004 The Apache Software Foundation.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  * 
  *   http://www.apache.org/licenses/LICENSE-2.0
  * 
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  * 
  * ========================================================================
  */
 package org.apache.cactus;
 
 import java.io.Serializable;
 
 import java.util.Date;
 
 import org.apache.cactus.internal.util.CookieUtil;
 
 /**
  * Client cookie. Used for manipulating client cookies either in
  * <code>beginXXX()</code> (to send cookies) or in
  * <code>endXXX()</code> methods (to assert returned cookies).
  *
  * @version $Id: Cookie.java 238991 2004-05-22 11:34:50Z vmassol $
  */
 public class Cookie implements Serializable
 {
     /**
      * The cookie name
      */
     private String name;
 
     /**
      * The cookie value
      */
     private String value;
 
     /**
      * The cookie description.
      * @see #setComment(String)
      */
     private String comment;
 
     /**
      * The cookie domain.
      * @see #setDomain(String)
      */
     private String domain;
 
     /**
      * The cookie expiry date.
      * @see #setExpiryDate(Date)
      */
     private Date expiryDate;
 
     /**
      * The cookie path.
      * @see #setPath(String)
      */
     private String path;
 
     /**
      * True if the cookie should only be sent over secure connections.
      * @see #setSecure(boolean)
      */
     private boolean isSecure = false;
 
     /**
      * Create a cookie.
      *
      * @param theDomain the cookie domain
      * @param theName the cookie name
      * @param theValue the cookie value
      */
     public Cookie(String theDomain, String theName, String theValue)
     {
         if (theDomain == null)
         {
             throw new NullPointerException("missing cookie domain");
         }
 
         if (theName == null)
         {
             throw new NullPointerException("missing cookie name");
         }
 
         if (theValue == null)
         {
             throw new NullPointerException("missing cookie value");
         }
 
         setDomain(theDomain);
         setName(theName);
         setValue(theValue);
     }
 
     /**
      * Sets the cookie name
      *
      * @param theName the cookie name
      */
     public void setName(String theName)
     {
         this.name = theName;
     }
 
     /**
      * @return the cookie name
      */
     public String getName()
     {
         return this.name;
     }
 
     /**
      * Sets the cookie value
      *
      * @param theValue the cookie value
      */
     public void setValue(String theValue)
     {
         this.value = theValue;
     }
 
     /**
      * @return the cookie value
      */
     public String getValue()
     {
         return this.value;
     }
 
     /**
      * Returns the comment describing the purpose of this cookie, or
      * null if no such comment has been defined.
      *
      * @return the cookie comment
      */
     public String getComment()
     {
         return this.comment;
     }
 
     /**
      * If a user agent (web browser) presents this cookie to a user, the
      * cookie's purpose will be described using this comment.
      *
      * @param theComment the cookie's text comment
      */
     public void setComment(String theComment)
     {
         this.comment = theComment;
     }
 
     /**
      * Return the expiry date.
      *
      * @return the expiry date of this cookie, or null if none set.
      */
     public Date getExpiryDate()
     {
         return this.expiryDate;
     }
 
     /**
      * Set the cookie expires date.
      *
      * <p>Netscape's original proposal defined an Expires header that took
      * a date value in a fixed-length variant format in place of Max-Age:
      *
      * Wdy, DD-Mon-YY HH:MM:SS GMT
      *
      * Note that the Expires date format contains embedded spaces, and that
      * "old" cookies did not have quotes around values.  Clients that
      * implement to this specification should be aware of "old" cookies and
      * Expires.
      *
      * @param theExpiryDate the expires date.
      */
     public void setExpiryDate(Date theExpiryDate)
     {
         this.expiryDate = theExpiryDate;
     }
 
     /**
      * @return true if the cookie should be discarded at the end of the
      *         session; false otherwise
      */
     public boolean isToBeDiscarded()
     {
         return (this.getExpiryDate() != null);
     }
 
     /**
      * Returns the domain of this cookie.
      *
      * @return the cookie domain
      */
     public String getDomain()
     {
         return this.domain;
     }
 
     /**
      * Sets the cookie domain. This cookie should be presented only to hosts
      * satisfying this domain name pattern.  Read RFC 2109 for specific
      * details of the syntax.
      *
      * Briefly, a domain name name begins with a dot (".foo.com") and means
      * that hosts in that DNS zone ("www.foo.com", but not "a.b.foo.com")
      * should see the cookie.  By default, cookies are only returned to
      * the host which saved them.
      *
      * @param theDomain the cookie domain
      */
     public void setDomain(String theDomain)
     {
         int ndx = theDomain.indexOf(":");
 
         if (ndx != -1)
         {
             theDomain = theDomain.substring(0, ndx);
         }
 
         this.domain = theDomain.toLowerCase();
     }
 
     /**
      * Return the path this cookie is associated with.
      *
      * @return the cookie path
      */
     public String getPath()
     {
         return this.path;
     }
 
     /**
      * Sets the cookie path. This cookie should be presented only with
      * requests beginning with this URL. Read RFC 2109 for a specification
      * of the default behaviour. Basically, URLs in the same "directory" as
      * the one which set the cookie, and in subdirectories, can all see the
      * cookie unless a different path is set.
      *
      * @param thePath the cookie path
      */
     public void setPath(String thePath)
     {
         this.path = thePath;
     }
 
     /**
      * @return true if the cookie should only be sent over secure connections.
      */
     public boolean isSecure()
     {
         return this.isSecure;
     }
 
     /**
      * Indicates to the user agent that the cookie should only be sent
      * using a secure protocol (https).  This should only be set when
      * the cookie's originating server used a secure protocol to set the
      * cookie's value.
      *
      * @param isSecure true if the cookie should be sent over secure
      *                 connections only
      */
     public void setSecure(boolean isSecure)
     {
         this.isSecure = isSecure;
     }
 
     /**
      * @return true if this cookie has expired
      */
     public boolean isExpired()
     {
         return (this.getExpiryDate() != null
             && this.getExpiryDate().getTime() <= System.currentTimeMillis());
     }
 
     /**
      * Hash up name, value and domain into new hash.
      *
      * @return the hashcode of this class
      */
     public int hashCode()
     {
         return (this.getName().hashCode() + this.getValue().hashCode()
             + this.getDomain().hashCode());
     }
 
     /**
      * Two cookies match if the name, path and domain match.
      *
      * @param theObject the cookie object to match
      * @return true of the object passed as paramater is equal to this coookie
      *         instance
      */
     public boolean equals(Object theObject)
     {
         if ((theObject != null) && (theObject instanceof Cookie))
         {
             Cookie other = (Cookie) theObject;
 
             return (this.getName().equals(other.getName())
                 && this.getPath().equals(other.getPath())
                 && this.getDomain().equals(other.getDomain()));
         }
 
         return false;
     }
 
     /**
      * @return a string representation of the cookie
      */
     public String toString()
     {
         StringBuffer buffer = new StringBuffer();
 
         buffer.append("name = [" + getName() + "], ");
         buffer.append("value = [" + getValue() + "], ");
         buffer.append("domain = [" + getDomain() + "], ");
         buffer.append("path = [" + getPath() + "], ");
         buffer.append("isSecure = [" + isSecure() + "], ");
         buffer.append("comment = [" + getComment() + "], ");
         buffer.append("expiryDate = [" + getExpiryDate() + "]");
 
         return buffer.toString();
     }
 
     /**
      * @see CookieUtil#getCookieDomain(WebRequest, String)
      * @deprecated use {@link CookieUtil#getCookieDomain(WebRequest, String)} 
      */
     public static String getCookieDomain(WebRequest theRequest, 
         String theRealHost)
     {
         return CookieUtil.getCookieDomain(theRequest, theRealHost);
     }
 
     /**
      * @see CookieUtil#getCookiePort(WebRequest, int)
      * @deprecated use {@link CookieUtil#getCookiePort(WebRequest, int)} 
      */
     public static int getCookiePort(WebRequest theRequest, int theRealPort)
     {
         return CookieUtil.getCookiePort(theRequest, theRealPort);
     }
 
     /**
      * @see CookieUtil#getCookiePath(WebRequest, String)
      * @deprecated use {@link CookieUtil#getCookiePath(WebRequest, String)} 
      */
     public static String getCookiePath(WebRequest theRequest, 
         String theRealPath)
     {
         return CookieUtil.getCookiePath(theRequest, theRealPath);
     }
 }
 

1		/*
2		* ========================================================================
3		*
4		* Copyright 2001-2004 The Apache Software Foundation.
5		*
6		* Licensed under the Apache License, Version 2.0 (the "License");
7		* you may not use this file except in compliance with the License.
8		* You may obtain a copy of the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS,
14		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15		* See the License for the specific language governing permissions and
16		* limitations under the License.
17		*
18		* ========================================================================
19		*/
20		package org.apache.cactus;
21
22		import java.io.Serializable;
23
24		import java.util.Date;
25
26		import org.apache.cactus.internal.util.CookieUtil;
27
28		/**
29		* Client cookie. Used for manipulating client cookies either in
30		* <code>beginXXX()</code> (to send cookies) or in
31		* <code>endXXX()</code> methods (to assert returned cookies).
32		*
33		* @version $Id: Cookie.java 238991 2004-05-22 11:34:50Z vmassol $
34		*/
35		public class Cookie implements Serializable
36		{
37		/**
38		* The cookie name
39		*/
40		private String name;
41
42		/**
43		* The cookie value
44		*/
45		private String value;
46
47		/**
48		* The cookie description.
49		* @see #setComment(String)
50		*/
51		private String comment;
52
53		/**
54		* The cookie domain.
55		* @see #setDomain(String)
56		*/
57		private String domain;
58
59		/**
60		* The cookie expiry date.
61		* @see #setExpiryDate(Date)
62		*/
63		private Date expiryDate;
64
65		/**
66		* The cookie path.
67		* @see #setPath(String)
68		*/
69		private String path;
70
71		/**
72		* True if the cookie should only be sent over secure connections.
73		* @see #setSecure(boolean)
74		*/
75		private boolean isSecure = false;
76
77		/**
78		* Create a cookie.
79		*
80		* @param theDomain the cookie domain
81		* @param theName the cookie name
82		* @param theValue the cookie value
83		*/
84	5	public Cookie(String theDomain, String theName, String theValue)
85		{
86	5	if (theDomain == null)
87		{
88	0	throw new NullPointerException("missing cookie domain");
89		}
90
91	5	if (theName == null)
92		{
93	0	throw new NullPointerException("missing cookie name");
94		}
95
96	5	if (theValue == null)
97		{
98	0	throw new NullPointerException("missing cookie value");
99		}
100
101	5	setDomain(theDomain);
102	5	setName(theName);
103	5	setValue(theValue);
104		}
105
106		/**
107		* Sets the cookie name
108		*
109		* @param theName the cookie name
110		*/
111	5	public void setName(String theName)
112		{
113	5	this.name = theName;
114		}
115
116		/**
117		* @return the cookie name
118		*/
119	6	public String getName()
120		{
121	6	return this.name;
122		}
123
124		/**
125		* Sets the cookie value
126		*
127		* @param theValue the cookie value
128		*/
129	5	public void setValue(String theValue)
130		{
131	5	this.value = theValue;
132		}
133
134		/**
135		* @return the cookie value
136		*/
137	4	public String getValue()
138		{
139	4	return this.value;
140		}
141
142		/**
143		* Returns the comment describing the purpose of this cookie, or
144		* null if no such comment has been defined.
145		*
146		* @return the cookie comment
147		*/
148	3	public String getComment()
149		{
150	3	return this.comment;
151		}
152
153		/**
154		* If a user agent (web browser) presents this cookie to a user, the
155		* cookie's purpose will be described using this comment.
156		*
157		* @param theComment the cookie's text comment
158		*/
159	2	public void setComment(String theComment)
160		{
161	2	this.comment = theComment;
162		}
163
164		/**
165		* Return the expiry date.
166		*
167		* @return the expiry date of this cookie, or null if none set.
168		*/
169	3	public Date getExpiryDate()
170		{
171	3	return this.expiryDate;
172		}
173
174		/**
175		* Set the cookie expires date.
176		*
177		* <p>Netscape's original proposal defined an Expires header that took
178		* a date value in a fixed-length variant format in place of Max-Age:
179		*
180		* Wdy, DD-Mon-YY HH:MM:SS GMT
181		*
182		* Note that the Expires date format contains embedded spaces, and that
183		* "old" cookies did not have quotes around values. Clients that
184		* implement to this specification should be aware of "old" cookies and
185		* Expires.
186		*
187		* @param theExpiryDate the expires date.
188		*/
189	2	public void setExpiryDate(Date theExpiryDate)
190		{
191	2	this.expiryDate = theExpiryDate;
192		}
193
194		/**
195		* @return true if the cookie should be discarded at the end of the
196		* session; false otherwise
197		*/
198	0	public boolean isToBeDiscarded()
199		{
200	0	return (this.getExpiryDate() != null);
201		}
202
203		/**
204		* Returns the domain of this cookie.
205		*
206		* @return the cookie domain
207		*/
208	7	public String getDomain()
209		{
210	7	return this.domain;
211		}
212
213		/**
214		* Sets the cookie domain. This cookie should be presented only to hosts
215		* satisfying this domain name pattern. Read RFC 2109 for specific
216		* details of the syntax.
217		*
218		* Briefly, a domain name name begins with a dot (".foo.com") and means
219		* that hosts in that DNS zone ("www.foo.com", but not "a.b.foo.com")
220		* should see the cookie. By default, cookies are only returned to
221		* the host which saved them.
222		*
223		* @param theDomain the cookie domain
224		*/
225	5	public void setDomain(String theDomain)
226		{
227	5	int ndx = theDomain.indexOf(":");
228
229	5	if (ndx != -1)
230		{
231	0	theDomain = theDomain.substring(0, ndx);
232		}
233
234	5	this.domain = theDomain.toLowerCase();
235		}
236
237		/**
238		* Return the path this cookie is associated with.
239		*
240		* @return the cookie path
241		*/
242	3	public String getPath()
243		{
244	3	return this.path;
245		}
246
247		/**
248		* Sets the cookie path. This cookie should be presented only with
249		* requests beginning with this URL. Read RFC 2109 for a specification
250		* of the default behaviour. Basically, URLs in the same "directory" as
251		* the one which set the cookie, and in subdirectories, can all see the
252		* cookie unless a different path is set.
253		*
254		* @param thePath the cookie path
255		*/
256	2	public void setPath(String thePath)
257		{
258	2	this.path = thePath;
259		}
260
261		/**
262		* @return true if the cookie should only be sent over secure connections.
263		*/
264	3	public boolean isSecure()
265		{
266	3	return this.isSecure;
267		}
268
269		/**
270		* Indicates to the user agent that the cookie should only be sent
271		* using a secure protocol (https). This should only be set when
272		* the cookie's originating server used a secure protocol to set the
273		* cookie's value.
274		*
275		* @param isSecure true if the cookie should be sent over secure
276		* connections only
277		*/
278	2	public void setSecure(boolean isSecure)
279		{
280	2	this.isSecure = isSecure;
281		}
282
283		/**
284		* @return true if this cookie has expired
285		*/
286	0	public boolean isExpired()
287		{
288	0	return (this.getExpiryDate() != null
289		&& this.getExpiryDate().getTime() <= System.currentTimeMillis());
290		}
291
292		/**
293		* Hash up name, value and domain into new hash.
294		*
295		* @return the hashcode of this class
296		*/
297	0	public int hashCode()
298		{
299	0	return (this.getName().hashCode() + this.getValue().hashCode()
300		+ this.getDomain().hashCode());
301		}
302
303		/**
304		* Two cookies match if the name, path and domain match.
305		*
306		* @param theObject the cookie object to match
307		* @return true of the object passed as paramater is equal to this coookie
308		* instance
309		*/
310	0	public boolean equals(Object theObject)
311		{
312	0	if ((theObject != null) && (theObject instanceof Cookie))
313		{
314	0	Cookie other = (Cookie) theObject;
315
316	0	return (this.getName().equals(other.getName())
317		&& this.getPath().equals(other.getPath())
318		&& this.getDomain().equals(other.getDomain()));
319		}
320
321	0	return false;
322		}
323
324		/**
325		* @return a string representation of the cookie
326		*/
327	0	public String toString()
328		{
329	0	StringBuffer buffer = new StringBuffer();
330
331	0	buffer.append("name = [" + getName() + "], ");
332	0	buffer.append("value = [" + getValue() + "], ");
333	0	buffer.append("domain = [" + getDomain() + "], ");
334	0	buffer.append("path = [" + getPath() + "], ");
335	0	buffer.append("isSecure = [" + isSecure() + "], ");
336	0	buffer.append("comment = [" + getComment() + "], ");
337	0	buffer.append("expiryDate = [" + getExpiryDate() + "]");
338
339	0	return buffer.toString();
340		}
341
342		/**
343		* @see CookieUtil#getCookieDomain(WebRequest, String)
344		* @deprecated use {@link CookieUtil#getCookieDomain(WebRequest, String)}
345		*/
346	0	public static String getCookieDomain(WebRequest theRequest,
347		String theRealHost)
348		{
349	0	return CookieUtil.getCookieDomain(theRequest, theRealHost);
350		}
351
352		/**
353		* @see CookieUtil#getCookiePort(WebRequest, int)
354		* @deprecated use {@link CookieUtil#getCookiePort(WebRequest, int)}
355		*/
356	0	public static int getCookiePort(WebRequest theRequest, int theRealPort)
357		{
358	0	return CookieUtil.getCookiePort(theRequest, theRealPort);
359		}
360
361		/**
362		* @see CookieUtil#getCookiePath(WebRequest, String)
363		* @deprecated use {@link CookieUtil#getCookiePath(WebRequest, String)}
364		*/
365	0	public static String getCookiePath(WebRequest theRequest,
366		String theRealPath)
367		{
368	0	return CookieUtil.getCookiePath(theRequest, theRealPath);
369		}
370		}
371