/*
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 2004 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, 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 acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Apache Cocoon" 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
apache@apache.org.
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
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 (INCLU-
DING, 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.
*/
package org.apache.cocoon.portal.pluto.om;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.Locale;
import java.util.StringTokenizer;
import org.apache.cocoon.portal.pluto.om.common.ContentTypeSetImpl;
import org.apache.cocoon.portal.pluto.om.common.DescriptionSetImpl;
import org.apache.cocoon.portal.pluto.om.common.DisplayNameSetImpl;
import org.apache.cocoon.portal.pluto.om.common.LanguageSetImpl;
import org.apache.cocoon.portal.pluto.om.common.ParameterSetImpl;
import org.apache.cocoon.portal.pluto.om.common.PreferenceSetImpl;
import org.apache.cocoon.portal.pluto.om.common.SecurityRoleRefSetImpl;
import org.apache.cocoon.portal.pluto.om.common.Support;
import org.apache.pluto.invoker.PortletInvoker;
import org.apache.pluto.om.common.Description;
import org.apache.pluto.om.common.DescriptionSet;
import org.apache.pluto.om.common.DisplayName;
import org.apache.pluto.om.common.DisplayNameSet;
import org.apache.pluto.om.common.LanguageSet;
import org.apache.pluto.om.common.ObjectID;
import org.apache.pluto.om.common.ParameterSet;
import org.apache.pluto.om.common.PreferenceSet;
import org.apache.pluto.om.common.SecurityRoleRefSet;
import org.apache.pluto.om.portlet.ContentTypeSet;
import org.apache.pluto.om.portlet.PortletApplicationDefinition;
import org.apache.pluto.om.portlet.PortletDefinition;
import org.apache.pluto.om.portlet.PortletDefinitionCtrl;
import org.apache.pluto.om.servlet.ServletDefinition;
/**
*
*
* @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
*
* @version CVS $Id: PortletDefinitionImpl.java,v 1.2 2004/01/27 08:05:34 cziegeler Exp $
*/
public class PortletDefinitionImpl
implements PortletDefinition, PortletDefinitionCtrl, java.io.Serializable, Support {
private PortletApplicationDefinition application = null;
private LanguageSet castorResources = null;
// contains String objects
private ArrayList castorSupportedLocales = new ArrayList();
private ClassLoader classLoader = null;
private String className = null;
private ContentTypeSet contentTypes = new ContentTypeSetImpl();
private DescriptionSet descriptions = new DescriptionSetImpl();
private DisplayNameSet displayNames = new DisplayNameSetImpl();
private String expirationCache = null;
public String id = "";
private ParameterSet initParams = new ParameterSetImpl();
private SecurityRoleRefSet initSecurityRoleRefs = new SecurityRoleRefSetImpl();
private String name = null;
private ObjectID objectId = null;
private PreferenceSet preferences = new PreferenceSetImpl();
// private PortletInfoImpl portletInfo = null;
private String resourceBundle = null;
private ServletDefinition servlet = null;
// contains Locale objects
private ArrayList supportedLocales = new ArrayList();
/** is this a local portlet? */
protected boolean localPortlet = false;
/** The local portlet invoker */
protected PortletInvoker localPortletInvoker;
// PortletDefinition implementation.
public ObjectID getId() {
if (objectId==null) {
objectId = org.apache.cocoon.portal.pluto.om.common.ObjectIDImpl.createFromString(getGUID());
}
return objectId;
}
public String getClassName() {
return className;
}
public String getName() {
return name;
}
/* (non-Javadoc)
* @see org.apache.pluto.om.portlet.PortletDefinition#getDescription(Locale)
*/
public Description getDescription(Locale locale) {
return descriptions.get(locale);
}
public LanguageSet getLanguageSet() {
((LanguageSetImpl)castorResources).setClassLoader(this.getPortletClassLoader());
return castorResources;
}
public ParameterSet getInitParameterSet() {
return initParams;
}
public SecurityRoleRefSet getInitSecurityRoleRefSet() {
return initSecurityRoleRefs;
}
public PreferenceSet getPreferenceSet() {
((PreferenceSetImpl)preferences).setClassLoader(this.getPortletClassLoader());
return preferences;
}
public ContentTypeSet getContentTypeSet() {
return contentTypes;
}
public PortletApplicationDefinition getPortletApplicationDefinition() {
return application;
}
public ServletDefinition getServletDefinition() {
return servlet;
}
public DisplayName getDisplayName(Locale locale) {
return displayNames.get(locale);
}
public String getExpirationCache() {
return expirationCache;
}
// PortletDefinitionCtrl implementation.
public void setId(String id) {
// todo excep
}
public void setClassName(String className) {
this.className = className;
}
public void setName(String name) {
this.name = name;
}
/* (non-Javadoc)
* @see org.apache.pluto.om.portlet.PortletDefinitionCtrl#setDescriptions(DescriptionSet)
*/
public void setDescriptions(DescriptionSet descriptions) {
this.descriptions = descriptions;
}
public void setDisplayNames(DisplayNameSet displayNames) {
this.displayNames = displayNames;
}
public void setPortletClassLoader(ClassLoader loader) {
this.classLoader = loader;
}
public void store() throws java.io.IOException {
// not supported
}
public void postBuild(Object parameter) throws Exception {
setServletDefinition((ServletDefinition)parameter);
((Support)contentTypes).postBuild(this);
if (castorResources!=null) {
((Support)castorResources).postBuild(this);
}
}
public void postLoad(Object parameter) throws Exception {
((Support)contentTypes).postLoad(this);
// create Locale objects for given locale entries
Iterator iterator = castorSupportedLocales.iterator();
while (iterator.hasNext()) {
String locale = (String)iterator.next();
// parse locale String
StringTokenizer tokenizer = new StringTokenizer(locale,"_");
String[] localeDef = new String[3];
for (int i=0; i<3 ;i++) {
if (tokenizer.hasMoreTokens()) {
localeDef[i] = tokenizer.nextToken();
} else {
localeDef[i] = "";
}
}
supportedLocales.add(new java.util.Locale(localeDef[0], localeDef[1], localeDef[2]));
}
if (castorResources==null) {
castorResources = new LanguageSetImpl();
}
if (resourceBundle!=null) {
((LanguageSetImpl)castorResources).setResources(resourceBundle);
}
((Support)castorResources).postLoad(this.supportedLocales);
((Support)descriptions).postLoad(parameter);
((Support)displayNames).postLoad(parameter);
}
public void postStore(Object parameter) throws Exception {
((Support)contentTypes).postStore(this);
if (castorResources!=null) {
((Support)castorResources).postStore(this);
}
}
public void preBuild(Object parameter) throws Exception {
setPortletApplicationDefinition((PortletApplicationDefinition)parameter);
((Support)contentTypes).preBuild(this);
if (castorResources!=null) {
((Support)castorResources).preBuild(this);
}
}
public void preStore(Object parameter) throws Exception {
((Support)contentTypes).preStore(this);
if (castorResources!=null) {
((Support)castorResources).preStore(this);
}
}
// additional methods.
public Collection getCastorContentTypes() {
return(ContentTypeSetImpl)contentTypes;
}
public Collection getCastorDisplayNames() {
return(DisplayNameSetImpl)displayNames;
}
public Collection getCastorDescriptions() {
return(DescriptionSetImpl)descriptions;
}
public Collection getDescriptions() {
return(DescriptionSetImpl)descriptions;
}
public Collection getCastorInitParams() {
return(ParameterSetImpl)initParams;
}
public SecurityRoleRefSet getCastorInitSecurityRoleRefs() {
return initSecurityRoleRefs;
}
public PreferenceSet getCastorPreferences() {
return preferences;
}
public LanguageSet getCastorResources() {
return castorResources;
}
// not yet fully supported
// public Collection getSecurityRoleRef()
// {
// return securityRoleRef;
// }
// public void setSecurityRoleRef(Collection securityRoleRef)
// {
// this.securityRoleRef = (ArrayList)securityRoleRef;
// }
// additional internal methods
public Collection getCastorSupportedLocales() {
return castorSupportedLocales;
}
private String getGUID() {
String portletID = "";
if (getName()!=null) portletID += getName();
portletID = application.getId().toString() + "."+portletID;
return portletID;
}
public ClassLoader getPortletClassLoader() {
return classLoader;
}
public String getResourceBundle() {
return this.resourceBundle;
}
public Collection getSupportedLocales() {
return supportedLocales;
}
public void setCastorContentTypes(ContentTypeSet castorContentTypes) {
this.contentTypes = castorContentTypes;
}
public void setCastorInitParams(ParameterSet castorInitParams) {
this.initParams = castorInitParams;
}
public void setCastorInitSecurityRoleRefs(SecurityRoleRefSet castorInitSecurityRoleRefs) {
this.initSecurityRoleRefs = castorInitSecurityRoleRefs;
}
public void setCastorDisplayNames(DisplayNameSet castorDisplayNames) {
this.displayNames = castorDisplayNames;
}
public void setCastorDescriptions(DescriptionSet castorDescriptions) {
this.descriptions = castorDescriptions;
}
public void setCastorPreferences(PreferenceSet castorPreferences) {
this.preferences = castorPreferences;
}
public void setCastorResources(LanguageSet resources) {
this.castorResources = resources;
}
public void setCastorSupportedLocales(Collection castorSupportedLocales) {
this.castorSupportedLocales = (ArrayList)castorSupportedLocales;
}
public void setExpirationCache(String expirationCache) {
this.expirationCache = expirationCache;
}
protected void setPortletApplicationDefinition(PortletApplicationDefinition application) {
this.application = application;
}
public void setResourceBundle(String resourceBundle) {
this.resourceBundle = resourceBundle;
}
protected void setServletDefinition(ServletDefinition servlet) {
this.servlet = servlet;
}
/**
* @return Returns the localPortlet.
*/
public boolean isLocalPortlet() {
return this.localPortlet;
}
/**
* @param localPortlet The localPortlet to set.
*/
public void setLocalPortlet(boolean localPortlet) {
this.localPortlet = localPortlet;
}
/**
* @return Returns the localPortletInvoker.
*/
public PortletInvoker getLocalPortletInvoker() {
return this.localPortletInvoker;
}
/**
* Set a local portlet invoker for caching
* @param localPortletInvoker The localPortletInvoker to set.
*/
public void setLocalPortletInvoker(PortletInvoker localPortletInvoker) {
this.localPortletInvoker = localPortletInvoker;
}
}