001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package com.sun.rave.web.ui.component.util.event;
042:
043: /**
044: * <P> This class implements the OutputType interface to provide a way to
045: * get/set Output values from a ServletRequest attribute Map.</P>
046: *
047: * @author Ken Paulsen (ken.paulsen@sun.com)
048: */
049: public class RequestAttributeOutputType implements OutputType {
050:
051: /**
052: * <P> This method is responsible for retrieving the value of the Output
053: * from a Request attribute. 'key' may be null, if this occurs, a
054: * default name will be provided. That name will follow the
055: * following format:</P>
056: *
057: * <P> [handler-id]:[key]</P>
058: *
059: * @param context The HandlerContext
060: *
061: * @param outDesc The IODescriptor for this Output value in
062: * which to obtain the value
063: *
064: * @param key The optional 'key' to use when retrieving the
065: * value from the ServletRequest attribute Map.
066: *
067: * @return The requested value.
068: */
069: public Object getValue(HandlerContext context,
070: IODescriptor outDesc, String key) {
071: if (key == null) {
072: // Provide a reasonably unique default
073: key = context.getHandlerDefinition().getId() + ':'
074: + outDesc.getName();
075: }
076:
077: // Get it from the Request attribute map
078: return context.getFacesContext().getExternalContext()
079: .getRequestMap().get(key);
080: }
081:
082: /**
083: * <P> This method is responsible for setting the value of the Output to
084: * a ServletRequest attribute. 'key' may be null, in this case, a
085: * default name will be provided. That name will follow the
086: * following format:</P>
087: *
088: * <P> [handler-id]:[key]</P>
089: *
090: * @param context The HandlerContext
091: *
092: * @param outDesc The IODescriptor for this Output value in
093: * which to obtain the value
094: *
095: * @param key The optional 'key' to use when setting the
096: * value into the ServletRequest attribute Map
097: *
098: * @param value The value to set
099: */
100: public void setValue(HandlerContext context, IODescriptor outDesc,
101: String key, Object value) {
102: if (key == null) {
103: // Provide a reasonably unique default
104: key = context.getHandlerDefinition().getId() + ':'
105: + outDesc.getName();
106: }
107:
108: // Get it from the Request attribute map
109: context.getFacesContext().getExternalContext().getRequestMap()
110: .put(key, value);
111: }
112: }
|