attributetoscopetag.java

jakarta-struts-1.2.4-src

/*
 * \$Header\$
 * \$Revision\$
 * \$Date\$
 *
 * Copyright 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.
 */
/*
  *  $Header: /home/cvs/jakarta-struts/src/share/org/apache/struts/taglib/tiles/AttributeToScopeTag.java,v 1.7 2004/03/14 06:23:49 sraeburn Exp $
  *  $Revision: 1.7 $
  *  $Date: 2004/03/14 06:23:49 $
  *
  *  ====================================================================
  *
  *  The  Apache  Software  License,  Version  1.1
  *
  *  Copyright  (c)  1999-2003  The  Apache  Software  Foundation.    All  rights
  *  reserved.
  *
  *  Redistribution  and  use  in  source  and  binary  forms,  with  or  without
  *  modification,  are  permitted  provided  that  the  following  conditions
  *  are  met:
  *
  *  1.  Redistributions  of  source  code  must  retain  the  above  copyright
  *        notice,  this  list  of  conditions  and  the  following  disclaimer.
  *
  *  2.  Redistributions  in  binary  form  must  reproduce  the  above  copyright
  *        notice,  this  list  of  conditions  and  the  following  disclaimer  in
  *        the  documentation  and/or  other  materials  provided  with  the
  *        distribution.
  *
  *  3.  The  end-user  documentation  included  with  the  redistribution,  if
  *        any,  must  include  the  following  acknowlegement:
  *              "This  product  includes  software  developed  by  the
  *                Apache  Software  Foundation  (http://www.apache.org/)."
  *        Alternately,  this  acknowlegement  may  appear  in  the  software  itself,
  *        if  and  wherever  such  third-party  acknowlegements  normally  appear.
  *
  *  4.  The  names  "The  Jakarta  Project",  "Struts",  and  "Apache  Software
  *        Foundation"  must  not  be  used  to  endorse  or  promote  products  derived
  *        from  this  software  without  prior  written  permission.  For  written
  *        permission,  please  contact  [e-mail].
  *
  *  5.  Products  derived  from  this  software  may  not  be  called  "Apache"
  *        nor  may  "Apache"  appear  in  their  names  without  prior  written
  *        permission  of  the  Apache  Group.
  *
  *  THIS  SOFTWARE  IS  PROVIDED  ``AS  IS''  AND  ANY  EXPRESSED  OR  IMPLIED
  *  WARRANTIES,  INCLUDING,  BUT  NOT  LIMITED  TO,  THE  IMPLIED  WARRANTIES
  *  OF  MERCHANTABILITY  AND  FITNESS  FOR  A  PARTICULAR  PURPOSE  ARE
  *  DISCLAIMED.    IN  NO  EVENT  SHALL  THE  APACHE  SOFTWARE  FOUNDATION  OR
  *  ITS  CONTRIBUTORS  BE  LIABLE  FOR  ANY  DIRECT,  INDIRECT,  INCIDENTAL,
  *  SPECIAL,  EXEMPLARY,  OR  CONSEQUENTIAL  DAMAGES  (INCLUDING,  BUT  NOT
  *  LIMITED  TO,  PROCUREMENT  OF  SUBSTITUTE  GOODS  OR  SERVICES;  LOSS  OF
  *  USE,  DATA,  OR  PROFITS;  OR  BUSINESS  INTERRUPTION)  HOWEVER  CAUSED  AND
  *  ON  ANY  THEORY  OF  LIABILITY,  WHETHER  IN  CONTRACT,  STRICT  LIABILITY,
  *  OR  TORT  (INCLUDING  NEGLIGENCE  OR  OTHERWISE)  ARISING  IN  ANY  WAY  OUT
  *  OF  THE  USE  OF  THIS  SOFTWARE,  EVEN  IF  ADVISED  OF  THE  POSSIBILITY  OF
  *  SUCH  DAMAGE.
  *  ====================================================================
  *
  *  This  software  consists  of  voluntary  contributions  made  by  many
  *  individuals  on  behalf  of  the  Apache  Software  Foundation.    For  more
  *  information  on  the  Apache  Software  Foundation,  please  see
  *  <http://www.apache.org/>.
  *
  */


package  org.apache.struts.taglib.tiles;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.TagSupport;

import org.apache.struts.taglib.tiles.util.TagUtils;
import org.apache.struts.tiles.ComponentContext;


/**
  *  Custom  tag  that  puts  component's  attributes  in  a  scope  (request,  page,  ...).
  *  @deprecated  Is  it  still  in  use  ?
  */
public  final  class  AttributeToScopeTag  extends  TagSupport  {


        //  ----------------------------------------------------- Instance Variables


    /**
     * The scope name.
     */
    private String scopeName = null;

    /**
     * The scope value.
     */
    private int scope = PageContext.PAGE_SCOPE;



    /**
     * The property name to be exposed.
     */
    private String property = null;


    // ------------------------------------------------------------- Properties



    /**
     * Return the property name.
     */
    public String getProperty()
    {
    return  (this.property);
    }


     /**
       *  Set  the  property  name.
       *
       *  @param  property  The  property  name
       */
    public  void  setProperty(String  property)
    {  
    this.property  =  property;
    }

    /**
      *  Set  the  scope.
      *
      *  @param  scope  The  new  scope
      */
    public  void  setScope(String  scope)
    {
    this.scopeName  =  scope;
    }

        //  ---------------------------------------------------------  Public  Methods


        /**
          *  Expose  the  requested  property  from  component  context.
          *
          *  @exception  JspException  if  a  JSP  exception  has  occurred
          */
    public  int  doStartTag()  throws  JspException
        {
        if(  id==null  )
            id=property;
            
        ComponentContext  compContext  =  (ComponentContext)pageContext.getAttribute(  ComponentConstants.COMPONENT_CONTEXT,  PageContext.REQUEST_SCOPE);

        if(  compContext  ==  null  )
            throw  new  JspException  (  "Error  -  tag.useProperty  :  component  context  is  not  defined.  Check  tag  syntax"  );

        Object  value  =  compContext.getAttribute(property);
        if(  value  ==  null  )
            throw  new  JspException  (  "Error  -  tag.useProperty  :  property  '"+  property  +  "'  not  found  in  context.  Check  tag  syntax"  );

        if(  scopeName  !=  null  )
            {
            scope  =  TagUtils.getScope(  scopeName,  PageContext.PAGE_SCOPE  );
            pageContext.setAttribute(id,  value,  scope);
            }
          else
            pageContext.setAttribute(id,  value);

          //  Continue  processing  this  page
        return  SKIP_BODY;
        }




        /**
          *  Clean  up  after  processing  this  enumeration.
          *
          *  @exception  JspException  if  a  JSP  exception  has  occurred
          */
    public  int  doEndTag()  throws  JspException
        {
        return  (EVAL_PAGE);
        }

        /**
          *  Release  all  allocated  resources.
          */
        public  void  release()  {

                super.release();
                property  =  null;
                scopeName  =  null;
                scope  =  PageContext.PAGE_SCOPE;
        }

}