com.hfg.webapp.HfgCookie Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.webapp;

import javax.servlet.http.Cookie;

//------------------------------------------------------------------------------
/**
 Cookie extension that handles encoding/decoding of the cookie value.
 
  @author J. Alex Taylor, hairyfatguy.com
 
*/
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public class HfgCookie extends Cookie
{
   private String mDecodedValue;

   //###########################################################################
   // CONSTRUCTORS
   //###########################################################################

   //---------------------------------------------------------------------------
   public HfgCookie(String inName, String inValue)
   {
      super(inName, inValue);

      setValue(inValue);
   }

   //---------------------------------------------------------------------------
   public HfgCookie(Cookie inCookie)
   {
      this(inCookie.getName(), inCookie.getValue());

      if (inCookie.getPath() != null)
      {
         setPath(inCookie.getPath());
      }

      if (inCookie.getComment() != null)
      {
         setComment(inCookie.getComment());
      }

      if (inCookie.getDomain() != null)
      {
         setDomain(inCookie.getDomain());
      }

      setMaxAge(inCookie.getMaxAge());
      setHttpOnly(inCookie.isHttpOnly());
      setSecure(inCookie.getSecure());
      setVersion(inCookie.getVersion());
   }

   //###########################################################################
   // PUBLIC METHODS
   //###########################################################################

   //---------------------------------------------------------------------------
   @Override
   public void setValue(String inValue)
   {
      super.setValue(inValue);
      // The incoming value could be encoded or decoded.
      if (inValue != null)
      {
         if (WebappUtil.isCookieEncoded(this))
         {
            mDecodedValue = WebappUtil.decodeCookieValue(getValue());
            // Sometimes we have double-encoded values. Try unwinding further...
            while (WebappUtil.isCookieEncoded(mDecodedValue))
            {
               mDecodedValue = WebappUtil.decodeCookieValue(mDecodedValue);
            }
         }
         else
         {
            mDecodedValue = getValue();
            setValue(WebappUtil.encodeCookieValue(getValue()));
         }
      }
   }

   //---------------------------------------------------------------------------
   public String getDecodedValue()
   {
      return mDecodedValue;
   }
}