/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.cocoon.portal.components.modules.input;
import java.util.Map;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.avalon.framework.service.ServiceException;
import org.apache.cocoon.environment.ObjectModelHelper;
import org.apache.cocoon.portal.Constants;
import org.apache.cocoon.portal.PortalService;
import org.apache.commons.jxpath.JXPathContext;
/**
* Makes accessible coplet instance data by using JXPath expressions.<br><br>
*
* Example:<br><br>
*
* <pre><map:action type="foo">
* <map:parameter name="maxpageable" value="{coplet:copletData/maxpageable}"/>
* </map:action><br></pre>
*
* The module will insert the boolean value specifying whether the coplet is
* maxpageable or not as value of attribute "value" in <map:parameter>.
* There are two possibilities how the module obtains the information required for
* getting the coplet instance data:<br><br>
* 1) If it is used within a coplet pipeline and this pipeline is called using the "cocoon:" protocol,
* all required information are passed automatically.<br>
* 2) Otherwise the portal name and the coplet id must be passed in the object model
* which can be done by using the ObjectModelAction:
*
* <pre><map:action type="objectModel">
* <map:parameter name="portalName" value="exampleportal"/>
* <map:parameter name="copletId" value="examplecoplet"/>
* <map:action type="foo">
* <map:parameter name="maxpageable" value="{coplet:copletData/maxpageable}"/>
* </map:action>
* </map:action></pre>
*
* Using the path '#' you get the current copletId: {coplet:#}
*
* @author <a href="mailto:bluetkemeier@s-und-n.de">Björn Lütkemeier</a>
* @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
* @version CVS $Id$
*/
public class CopletModule
extends AbstractModule {
/* (non-Javadoc)
* @see org.apache.cocoon.components.modules.input.InputModule#getAttribute(java.lang.String, org.apache.avalon.framework.configuration.Configuration, java.util.Map)
*/
public Object getAttribute(String name, Configuration modeConf, Map objectModel)
throws ConfigurationException {
PortalService portalService = null;
try {
portalService = (PortalService)this.manager.lookup(PortalService.ROLE);
// determine coplet id
String copletId = null;
Map context = (Map)objectModel.get(ObjectModelHelper.PARENT_CONTEXT);
if (context != null) {
copletId = (String)context.get(Constants.COPLET_ID_KEY);
} else {
copletId = (String)objectModel.get(Constants.COPLET_ID_KEY);
}
if (copletId == null) {
return null;
}
// return the coplet id
if ( name.equals("#") ) {
return copletId;
}
JXPathContext jxpathContext = JXPathContext.newContext(portalService.getComponentManager().getProfileManager().getCopletInstanceData(copletId));
return jxpathContext.getValue(name);
} catch (ServiceException e) {
throw new ConfigurationException("Unable to lookup portal service.", e);
} finally {
this.manager.release(portalService);
}
}
}