Source Code Cross Referenced for SessionFormAction.java in  » Content-Management-System » apache-lenya-2.0 » org » apache » cocoon » webapps » session » acting » Java Source Code / Java DocumentationJava Source Code and Java Documentation

001:        /*
002:         * Licensed to the Apache Software Foundation (ASF) under one or more
003:         * contributor license agreements.  See the NOTICE file distributed with
004:         * this work for additional information regarding copyright ownership.
005:         * The ASF licenses this file to You under the Apache License, Version 2.0
006:         * (the "License"); you may not use this file except in compliance with
007:         * the License.  You may obtain a copy of the License at
008:         * 
009:         *      http://www.apache.org/licenses/LICENSE-2.0
010:         * 
011:         * Unless required by applicable law or agreed to in writing, software
012:         * distributed under the License is distributed on an "AS IS" BASIS,
013:         * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014:         * See the License for the specific language governing permissions and
015:         * limitations under the License.
016:         */
017:        package org.apache.cocoon.webapps.session.acting;
018:
019:        import org.apache.avalon.framework.configuration.Configuration;
020:        import org.apache.avalon.framework.parameters.Parameters;
021:
022:        import org.apache.cocoon.acting.FormValidatorAction;
023:        import org.apache.cocoon.environment.ObjectModelHelper;
024:        import org.apache.cocoon.environment.Session;
025:        import org.apache.cocoon.environment.SourceResolver;
026:        import org.apache.cocoon.webapps.session.SessionConstants;
027:
028:        import java.util.Map;
029:
030:        /**
031:         * This is the action used to validate Request parameters.
032:         * The validation rules are either embedded within the form
033:         * 
034:         * <pre>
035:         *    &lt;session:form name="info_form"&gt;
036:         *      &lt;session:action&gt;next_page&lt;/session:action&gt;
037:         *      &lt;session:content&gt;
038:         *        &lt;session:inputxml name="name" type="text" context="trackdemo" path="/user/name"/&gt;
039:         *      &lt;/session:content&gt;
040:         *      &lt;session:validate&gt;
041:         *        &lt;root&gt;
042:         *          &lt;parameter name="name" type="string" nullable="no"/&gt;
043:         *          &lt;constraint-set name="form_a_set"&gt;
044:         *            &lt;validate name="name"/&gt;
045:         *          &lt;/constraint-set&gt;
046:         *        &lt;/root&gt;
047:         *      &lt;/session:validate&gt;
048:         *    &lt;/session:form&gt;
049:         * </pre>
050:         * 
051:         * or described via the external xml file referenced
052:         * through the "src" attribute
053:         * (the format is defined in AbstractValidatorAction).
054:         * Then the constraint-set to be used has to be identified
055:         * through the "constraint-set" element
056:         *
057:         * <pre>
058:         *    &lt;session:form name="info_form&gt;
059:         *      &lt;session:action&gt;next_page&lt;/session:action&gt;
060:         *      &lt;session:content&gt;
061:         *        &lt;session:inputxml name="name" type="text" context="trackdemo" path="/user/name"/&gt;
062:         *      &lt;/session:content&gt;
063:         *      &lt;session:validate src="descriptor.xml"&gt;
064:         *        &lt;constraint-set name="form_a_set"/&gt;
065:         *      &lt;/session:validate&gt;
066:         *    &lt;/session:form&gt;
067:         * </pre>
068:         *
069:         * Since the validation rules are contained within the form document
070:         * they are read and supplied by the SessionTransformer.
071:         * So this action has to be used in conjunction with the SessionTransformer.
072:         * The "next_page" pipeline might look like this:
073:         * 
074:         * <pre>
075:         *     &lt;map:match pattern="next_page"&gt;
076:         *       &lt;map:act type="session-form"&gt;
077:         *           &lt;map:generate src="next_page.xml"/&gt;
078:         *           &lt;map:transform type="session"/&gt;
079:         *           &lt;map:transform src="simple2html.xsl"/&gt;
080:         *           &lt;map:serialize/&gt;
081:         *       &lt;/map:act&gt;
082:         *       &lt;map:generate src="first_page.xml"/&gt;
083:         *       &lt;map:transform type="session"/&gt;
084:         *       &lt;map:transform src="simple2html.xsl"/&gt;
085:         *       &lt;map:serialize/&gt;
086:         *     &lt;/map:match&gt;
087:         * </pre>
088:         *
089:         * where "session-form" is configured as SessionFormAction
090:         * 
091:         * @see org.apache.cocoon.acting.FormValidatorAction
092:         * @see org.apache.cocoon.acting.AbstractValidatorAction
093:         * 
094:         * @author <a href="mailto:gcasper@s-und-n.de">Guido Casper</a>
095:         * @author <a href="mailto:haul@apache.org">Christian Haul</a>
096:         * @deprecated This block is deprecated and will be removed in future versions.
097:         * @version $Id: SessionFormAction.java 433543 2006-08-22 06:22:54Z crossley $
098:         */
099:        public class SessionFormAction extends FormValidatorAction {
100:
101:            /* (non-Javadoc)
102:             * @see org.apache.cocoon.acting.AbstractValidatorAction#getDescriptor(org.apache.cocoon.environment.SourceResolver, org.apache.avalon.framework.parameters.Parameters)
103:             */
104:            protected Configuration getDescriptor(SourceResolver resolver,
105:                    Map objectModel, Parameters parameters) {
106:
107:                Session session = ObjectModelHelper.getRequest(objectModel)
108:                        .getSession(true);
109:                return (Configuration) session.getAttribute(ObjectModelHelper
110:                        .getRequest(objectModel).getParameter(
111:                                SessionConstants.SESSION_FORM_PARAMETER));
112:            }
113:        }