org.apache.jetspeed.spaces.SpacesServiceImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jetspeed-portal Show documentation
Show all versions of jetspeed-portal Show documentation
Jetspeed-2 Portal Components
/*
* 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.jetspeed.spaces;
import org.apache.jetspeed.administration.AdminUtil;
import org.apache.jetspeed.locator.TemplateLocator;
import org.apache.jetspeed.om.folder.Folder;
import org.apache.jetspeed.om.folder.FolderNotFoundException;
import org.apache.jetspeed.om.page.Link;
import org.apache.jetspeed.om.page.Page;
import org.apache.jetspeed.om.portlet.GenericMetadata;
import org.apache.jetspeed.om.portlet.LocalizedField;
import org.apache.jetspeed.page.PageManager;
import org.apache.jetspeed.page.document.Node;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Locale;
/**
* Spaces Services
*
* @author David Sean Taylor
* @version $Id: SpacesServiceImpl.java 1578721 2014-03-18 02:25:49Z rwatler $
*/
public class SpacesServiceImpl implements Spaces
{
protected static Logger log = LoggerFactory.getLogger(SpacesServiceImpl.class);
private PageManager pageManager;
private TemplateLocator decoratorLocator;
public SpacesServiceImpl(PageManager pageManager, TemplateLocator decoratorLocator)
{
this.pageManager = pageManager;
this.decoratorLocator = decoratorLocator;
}
public List listEnvironments()
{
List envs = new LinkedList();
Folder envFolder = null;
try
{
envFolder = pageManager.getFolder(ENVIRONMENTS_LOCATION);
for (Node backingFolderNode : envFolder.getFolders())
{
Environment env = loadEnvironment((Folder)backingFolderNode);
envs.add(env);
}
}
catch (Exception e)
{
// its OK to have no environments, optional feature
}
return envs;
}
public Environment createEnvironment(String envName, String owner) throws SpacesException
{
Folder folder = pageManager.newFolder(makeEnvironmentPath(envName));
// TODO: store owner in security constraints
updateField(folder, Locale.ENGLISH, Environment.META_ENV_OWNER, owner);
try
{
pageManager.updateFolder(folder);
}
catch (Exception e)
{
throw new SpacesException(e);
}
return new EnvironmentImpl(folder);
}
public void storeEnvironment(Environment env) throws SpacesException
{
try
{
if (env instanceof EnvironmentImpl)
{
pageManager.updateFolder(((EnvironmentImpl)env).getBackingFolder());
}
}
catch (Exception e)
{
throw new SpacesException(e);
}
}
public void deleteEnvironment(Environment env) throws SpacesException
{
try
{
if (env instanceof EnvironmentImpl)
{
pageManager.removeFolder(((EnvironmentImpl)env).getBackingFolder());
}
}
catch (Exception e)
{
throw new SpacesException(e);
}
}
public Environment lookupEnvironment(String envName)
{
try
{
Environment env = new EnvironmentImpl(pageManager.getFolder(makeEnvironmentPath(envName)));
return env;
}
catch (FolderNotFoundException e)
{
}
catch (Exception e)
{
log.error("lookupEnvironment", e);
}
return null;
}
public List listSpaces()
{
List result = new ArrayList();
try
{
Folder root = pageManager.getFolder(Folder.PATH_SEPARATOR);
Space defaultSpace = loadSpace(root);
result.add(defaultSpace);
for (Node folderNode : root.getFolders())
{
Folder folder = (Folder)folderNode;
if (folder.isReserved())
continue;
Space space = loadSpace(folder);
// Exclude ordinary folders
if (space.getOwner() != null)
{
result.add(space);
}
}
}
catch (Exception e)
{
log.error("listSpaces", e);
}
return result;
}
public List listSpaces(String envName)
{
List result = new ArrayList();
Folder envFolder = null;
try
{
envFolder = pageManager.getFolder(makeEnvironmentPath(envName));
}
catch (FolderNotFoundException e)
{
return result;
}
catch (Exception e)
{
log.error("listSpaces", e);
}
try
{
for (Node linkNode : envFolder.getLinks())
{
Link link = (Link)linkNode;
String spacePath = link.getPath();
Folder folder = pageManager.getFolder(spacePath);
if (folder.isHidden() || folder.isReserved())
continue;
Space space = loadSpace(folder);
// Exclude ordinary folders which is neither the root folder nor the user home root folder.
if (space.getOwner() != null)
{
result.add(space);
}
}
}
catch (FolderNotFoundException e)
{
}
catch (Exception e)
{
log.error("listSpaces", e);
}
return result;
}
public Space createSpace(String spaceName, String owner, Folder templateFolder, String title, String shortTitle, String description, String theme, String constraint) throws SpacesException
{
Space space = null;
String spacePath = makeSpacePath(spaceName);
Folder spaceFolder = null;
if (pageManager.folderExists(spacePath))
{
throw new SpacesException("Space " + spaceName + " already exists");
}
try
{
if (templateFolder != null)
{
pageManager.deepCopyFolder(templateFolder, spacePath, owner, false);
spaceFolder = pageManager.getFolder(spacePath);
}
else
{
spaceFolder = pageManager.newFolder(spacePath);
}
space = new SpaceImpl(spaceFolder);
space.setOwner(owner);
space.setTitle(title);
space.setShortTitle(shortTitle);
space.setDescription(description);
space.setTheme(theme);
if (constraint != null && !"".equals(constraint.trim()))
{
space.setSecurityConstraint(constraint);
}
storeSpace(space);
}
catch (SpacesException e)
{
throw e;
}
catch (Exception e)
{
throw new SpacesException(e);
}
return space;
}
public void storeSpace(Space space) throws SpacesException
{
try
{
if (space instanceof SpaceImpl)
{
pageManager.updateFolder(((SpaceImpl)space).getBackingFolder(), true);
}
}
catch (Exception e)
{
throw new SpacesException(e);
}
}
public void deleteSpace(Space space) throws SpacesException
{
try
{
if (space instanceof SpaceImpl)
{
pageManager.removeFolder(((SpaceImpl)space).getBackingFolder());
// TODO: remove from environments
}
}
catch (Exception e)
{
throw new SpacesException(e);
}
}
public Space lookupSpace(String spaceName)
{
try
{
Space space = loadSpace(pageManager.getFolder(makeSpacePath(spaceName)));
// Exclude ordinary folders which is neither the root folder nor the user home root folder.
if (space.getOwner() != null)
{
return space;
}
}
catch (FolderNotFoundException e)
{
}
catch (Exception e)
{
log.error("lookupSpace", e);
}
return null;
}
public Space lookupUserSpace(String username)
{
String spaceName = Folder.USER_FOLDER + username;
try
{
Folder folder = pageManager.getFolder(makeSpacePath(spaceName));
Space space = loadSpace(folder);
return space;
}
catch (FolderNotFoundException e)
{
}
catch (Exception e)
{
log.error("lookupSpace", e);
}
return null;
}
public boolean isUserSpace(Space space)
{
return space.getPath().startsWith(Folder.USER_FOLDER);
}
public void addSpaceToEnvironment(Space space, Environment env) throws SpacesException
{
try
{
String path = AdminUtil.concatenatePaths(ENVIRONMENTS_LOCATION, env.getPath());
path = AdminUtil.concatenatePaths(path, space.getName());
Link link = pageManager.newLink(path);
link.setUrl(space.getPath());
pageManager.updateLink(link);
}
catch (Exception e)
{
throw new SpacesException(e);
}
}
public void removeSpaceFromEnvironment(Space space, Environment env) throws SpacesException
{
try
{
String path = AdminUtil.concatenatePaths(ENVIRONMENTS_LOCATION, env.getPath());
path = AdminUtil.concatenatePaths(path, space.getName());
Link link ;
try
{
link = pageManager.getLink(path);
}
catch (Exception e)
{
return; // not found
}
pageManager.removeLink(link);
}
catch (Exception e)
{
throw new SpacesException(e);
}
}
public boolean isSpaceInEnvironment(Space space, Environment env)
{
String path = AdminUtil.concatenatePaths(ENVIRONMENTS_LOCATION, env.getPath());
path = AdminUtil.concatenatePaths(path, space.getName());
try
{
Link link = pageManager.getLink(path);
return true;
}
catch (Exception e)
{
}
return false; // not found
}
public void deletePage(Page page) throws SpacesException
{
try
{
pageManager.removePage(page);
}
catch (Exception e)
{
throw new SpacesException(e);
}
}
public List listFolders(Space space)
{
List result = new ArrayList();
try
{
Folder root = pageManager.getFolder(space.getPath());
Iterator folders = root.getFolders().iterator();
for (int ix = 0; folders.hasNext(); ix++)
{
Node folder = (Node)folders.next();
result.add((Folder)folder);
}
}
catch (Exception e)
{
log.error("listFolders", e);
}
return result;
}
public List listLinks(Space space)
{
List result = new ArrayList();
try
{
Folder root = pageManager.getFolder(space.getPath());
Iterator links = root.getLinks().iterator();
for (int ix = 0; links.hasNext(); ix++)
{
Node link = (Node)links.next();
result.add((Link)link);
}
}
catch (Exception e)
{
log.error("listLinks", e);
}
return result;
}
public List listPages(Space space)
{
List result = new ArrayList();
try
{
Folder root = pageManager.getFolder(space.getPath());
Iterator pages = root.getPages().iterator();
for (int ix = 0; pages.hasNext(); ix++)
{
Node page = (Node)pages.next();
result.add((Page)page);
}
}
catch (Exception e)
{
log.error("listPages", e);
}
return result;
}
/*
* Helpers
*/
static protected boolean updateMetaField(Collection fields, Locale locale, String name, String value)
{
Iterator it = fields.iterator();
while (it.hasNext())
{
LocalizedField field = it.next();
if (locale == null || field.getLocale().equals(locale))
{
if (field.getName().equals(name))
{
field.setValue(value);
return true;
}
}
}
return false;
}
static protected String retrieveField(Folder folder, Locale locale, String name)
{
GenericMetadata metadata = folder.getMetadata();
Collection fields = metadata.getFields();
if (fields != null)
{
Iterator it = fields.iterator();
while (it.hasNext())
{
LocalizedField field = it.next();
if (locale == null || field.getLocale().equals(locale))
{
if (field.getName().equals(name))
{
return field.getValue();
}
}
}
}
return null;
}
static protected void updateField(Folder folder, Locale locale, String name, String value)
{
Locale addLocale = (locale == null) ? Locale.ENGLISH : locale;
GenericMetadata metadata = folder.getMetadata();
Collection fields = metadata.getFields();
if (fields == null || fields.size() == 0)
metadata.addField(addLocale, name, value);
else
{
if (!updateMetaField(fields, locale, name, value))
{
metadata.addField(addLocale, name, value);
}
}
}
protected Space loadSpace(Folder f)
{
return new SpaceImpl(f);
}
protected Environment loadEnvironment(Folder f)
{
return new EnvironmentImpl(f);
}
protected String makeSpacePath(String spaceName)
{
return AdminUtil.concatenatePaths(Folder.PATH_SEPARATOR, spaceName);
}
protected String makeEnvironmentPath(String envName)
{
return AdminUtil.concatenatePaths(ENVIRONMENTS_LOCATION, envName);
}
}