Web Script unit test base class added, helpers for JSON support in web scripts added (JSON reader, JSON error template), update to test webscript server to support easy submit of content, first cut of site service API (JS and HTTP) - create site and listSites available

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@8950 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/repo/site/SiteInfo.java

@@ -0,0 +1,86 @@
+/*
+ * Copyright (C) 2005-2007 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.repo.site;
+
+/**
+ * @author Roy Wetherall
+ */
+public class SiteInfo
+{
+    private String sitePreset;
+    private String shortName;
+    private String title;
+    private String description;
+    private boolean isPublic;
+   
+    public SiteInfo(String sitePreset, String shortName, String title, String description, boolean isPublic)
+    {
+        this.sitePreset = sitePreset;
+        this.shortName = shortName;
+        this.title = title;
+        this.description = description;
+        this.isPublic = isPublic;
+    }
+    
+    public String getSitePreset()
+    {
+        return sitePreset;
+    }
+    
+    public String getShortName()
+    {
+        return shortName;
+    }
+    
+    public String getTitle()
+    {
+        return title;
+    }
+    
+    public void setTitle(String title)
+    {
+        this.title = title;
+    }
+    
+    public String getDescription()
+    {
+        return description;
+    }
+    
+    public void setDescription(String description)
+    {
+        this.description = description;
+    }
+    
+    public void setIsPublic(boolean isPublic)
+    {
+        this.isPublic = isPublic;
+    }
+    
+    public boolean getIsPublic()
+    {
+        return this.isPublic;
+    }
+}

source/java/org/alfresco/repo/site/SiteModel.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright (C) 2005-2007 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.repo.site;
+
+import org.alfresco.service.namespace.QName;
+
+/**
+ * Site models constants
+ * 
+ * @author Roy Wetherall
+ */
+public interface SiteModel
+{
+    /** Site Model */
+    public static final String SITE_MODEL_URL = "http://www.alfresco.org/model/site/1.0";
+    public static final String SITE_MODEL_PREFIX = "st";
+    
+    /** Site */
+    public static final QName TYPE_SITE = QName.createQName(SITE_MODEL_URL, "site");
+    public static final QName PROP_SITE_PRESET = QName.createQName(SITE_MODEL_URL, "sitePreset");
+    
+    /** Site Permission */
+    public static final String SITE_MANAGER = "SiteManager";
+    public static final String SITE_COLLABORATOR = "SiteCollaborator";
+    public static final String SITE_CONSUMER = "SiteConsumer";
+}
+

source/java/org/alfresco/repo/site/SiteService.java

@@ -0,0 +1,36 @@
+package org.alfresco.repo.site;
+
+import java.util.List;
+
+/**
+ * Site service fundamental API.
+ * <p>
+ * This service API is designed to support the public facing Site APIs
+ * 
+ * @author Roy Wetherall
+ */
+public interface SiteService
+{
+    /**
+     * Create a new site.
+     * 
+     * @param sitePreset    site preset name
+     * @param shortName     site short name, must be unique
+     * @param title         site title
+     * @param description   site description
+     * @param isPublic      whether the site is public or not
+     * @return SiteInfo     information about the created site
+     */
+    // TODO ... audit information
+    SiteInfo createSite(String sitePreset, String shortName, String title, String description, boolean isPublic);
+    
+    /**
+     * List the available sites.  This list can optionally be filtered by site name and/or site preset.
+     * 
+     * @param nameFilter            name filter
+     * @param sitePresetFilter      site preset filter
+     * @return List<SiteInfo>       list of site information
+     */
+    // TODO audit information
+    List<SiteInfo> listSites(String nameFilter, String sitePresetFilter);
+}

source/java/org/alfresco/repo/site/SiteServiceImpl.java

@@ -0,0 +1,300 @@
+/*
+ * Copyright (C) 2005-2007 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.repo.site;
+
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.repo.avm.AVMRepository;
+import org.alfresco.repo.security.authentication.AuthenticationComponent;
+import org.alfresco.repo.transaction.RetryingTransactionHelper;
+import org.alfresco.service.cmr.repository.ChildAssociationRef;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.cmr.repository.NodeService;
+import org.alfresco.service.cmr.repository.StoreRef;
+import org.alfresco.service.cmr.search.ResultSet;
+import org.alfresco.service.cmr.search.SearchService;
+import org.alfresco.service.cmr.security.AccessPermission;
+import org.alfresco.service.cmr.security.AuthenticationService;
+import org.alfresco.service.cmr.security.PermissionService;
+import org.alfresco.service.namespace.NamespaceService;
+import org.alfresco.service.namespace.QName;
+import org.alfresco.service.namespace.RegexQNamePattern;
+import org.alfresco.util.AbstractLifecycleBean;
+import org.alfresco.util.PropertyMap;
+import org.springframework.context.ApplicationEvent;
+
+/**
+ * Bootstraps the site AVN and DM stores
+ * 
+ * @author Roy Wetherall
+ */
+public class SiteServiceImpl extends AbstractLifecycleBean implements SiteService, SiteModel
+{
+    public static final String SITE_AVM_STORE = "SiteStore";
+    public static final StoreRef SITE_DM_STORE = new StoreRef(StoreRef.PROTOCOL_WORKSPACE, "SiteStore");
+    
+    private NodeService nodeService;
+    private SearchService searchService;
+    private AuthenticationService authenticationService;
+    private PermissionService permissionService;
+    private AuthenticationComponent authenticationComponent;
+    private AVMRepository AVMRepository;
+    private RetryingTransactionHelper retryingTransactionHelper;
+    
+    public void setNodeService(NodeService nodeService)
+    {
+        this.nodeService = nodeService;
+    }
+    
+    public void setSearchService(SearchService searchService)
+    {
+        this.searchService = searchService;
+    }
+    
+    public void setAuthenticationService(AuthenticationService authenticationService)
+    {
+        this.authenticationService = authenticationService;
+    }
+    
+    public void setPermissionService(PermissionService permissionService)
+    {
+        this.permissionService = permissionService;
+    }
+    
+    public void setAuthenticationComponent(AuthenticationComponent authenticationComponent)
+    {
+        this.authenticationComponent = authenticationComponent;
+    }
+    
+    public void setAVMRepository(AVMRepository repository)
+    {
+        AVMRepository = repository;
+    }
+    
+    public void setRetryingTransactionHelper(RetryingTransactionHelper retryingTransactionHelper)
+    {
+        this.retryingTransactionHelper = retryingTransactionHelper;
+    }
+    
+    public SiteInfo createSite(String sitePreset, String shortName, String title, String description, boolean isPublic)
+    {
+        // TODO:
+        // 1.  Check that the site preset exists
+        // 2.  Check that the short name of the site isn't a duplicate
+        // 3.  AVM create:
+        //     3a.   Find the site preset AVM folder
+        //     3b.   Create a new site folder in the correct location (named by the short name)
+        //     3c.   Copy the contents of the site preset folder into the new site folder
+        //     3d.   Mangle files as needed during copy ??
+        // 4.  DM create:
+        //     4a.   Find the site preset DM folder ??
+        //     4b.   Create a new site in the correct location (named by short name)
+        //     4c.   Set meta-data
+        //     4d.   Set up memberships (copying from site preset DM folder??)
+        //     4e.   Set up another details (rules) on site from DM preset folder ??
+        // 5. Return created site information
+        
+        
+        
+        // 4. DM create .. create the DM object that represents the site
+        
+        // Get the site parent node reference
+        NodeRef siteParent = getDMSiteParent(shortName);
+        
+        // Create the site node
+        PropertyMap properties = new PropertyMap(4);
+        properties.put(ContentModel.PROP_NAME, shortName);
+        properties.put(SiteModel.PROP_SITE_PRESET, sitePreset);
+        properties.put(ContentModel.PROP_TITLE, title);
+        properties.put(ContentModel.PROP_DESCRIPTION, description);
+        NodeRef siteNodeRef = this.nodeService.createNode(
+                siteParent, 
+                ContentModel.ASSOC_CONTAINS, 
+                QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, shortName), 
+                SiteModel.TYPE_SITE,
+                properties).getChildRef();
+        
+       // Set the memberhips details
+       this.permissionService.setInheritParentPermissions(siteNodeRef, false);
+       if (isPublic == true)
+       {
+           this.permissionService.setPermission(siteNodeRef, PermissionService.ALL_AUTHORITIES, SITE_CONSUMER, true);
+       }
+        
+       // 5. Return created site information
+       SiteInfo siteInfo = new SiteInfo(sitePreset, shortName, title, description, isPublic);
+       return siteInfo;
+    }
+    
+    private NodeRef getDMSiteParent(String shortName)
+    {
+        // TODO
+        // For now just return the site root, later we may build folder structure based on the shortname to
+        // spread the sites about
+        return getDMSiteRoot();
+    }
+    
+    private NodeRef getDMSiteRoot()
+    {
+        // Get the root 'sites' folder
+        ResultSet resultSet = this.searchService.query(SITE_DM_STORE, SearchService.LANGUAGE_LUCENE, "PATH:\"cm:sites\"");
+        if (resultSet.length() == 0)
+        {
+            // TODO
+            throw new RuntimeException("No root sites folder exists");
+        }
+        else if (resultSet.length() != 1)
+        {
+            // TODO
+            throw new RuntimeException("More than one root sites folder exists");
+        }        
+        NodeRef sitesRoot = resultSet.getNodeRef(0);
+        
+        // TODO
+        // In time we will use some sort of algorithm to spread the creation of sites across an arbitary structure
+                
+        return sitesRoot;
+    }
+    
+    public List<SiteInfo> listSites(String nameFilter, String sitePresetFilter)
+    {
+        // TODO 
+        // - take into consideration the filters set
+        // - take into consideration that the sites may not just be in a flat list under the site root
+        // - should we be taking the list from the AVM store, since we can have an AVM site pointing to
+        //   the default DM data site 
+        
+        // TODO
+        // For now just return the list of sites present under the site root
+        NodeRef siteRoot = getDMSiteRoot();
+        List<ChildAssociationRef> assocs = this.nodeService.getChildAssocs(siteRoot, ContentModel.ASSOC_CONTAINS, RegexQNamePattern.MATCH_ALL);
+        List<SiteInfo> result = new ArrayList<SiteInfo>(assocs.size());
+        for (ChildAssociationRef assoc : assocs)
+        {
+            result.add(createSiteInfo(assoc.getChildRef()));
+        }
+        
+        return result;
+    }
+  
+    private SiteInfo createSiteInfo(NodeRef siteNodeRef)
+    {
+        // Get the properties
+        Map<QName, Serializable> properties = this.nodeService.getProperties(siteNodeRef);
+        String shortName = (String)properties.get(ContentModel.PROP_NAME);
+        String sitePreset = (String)properties.get(PROP_SITE_PRESET);
+        String title = (String)properties.get(ContentModel.PROP_TITLE);
+        String description = (String)properties.get(ContentModel.PROP_DESCRIPTION);
+        
+        // Determine whether the space is public or not
+        boolean isPublic = false;
+        Set<AccessPermission> permissions = this.permissionService.getAllSetPermissions(siteNodeRef);
+        for (AccessPermission permission : permissions)
+        {
+            if (permission.getAuthority().equals(PermissionService.ALL_AUTHORITIES) == true &&
+                permission.getPermission().equals(SITE_CONSUMER) == true)
+            {
+                isPublic = true;
+                break;
+            }                
+        }
+        
+        // Create and return the site information
+        SiteInfo siteInfo = new SiteInfo(sitePreset, shortName, title, description, isPublic);
+        return siteInfo;
+    }
+    
+    /**
+     * @see org.alfresco.util.AbstractLifecycleBean#onBootstrap(org.springframework.context.ApplicationEvent)
+     */
+    @Override
+    protected void onBootstrap(ApplicationEvent event)
+    {
+        // Ensure execution occures in a transaction
+        this.retryingTransactionHelper.doInTransaction(
+            new RetryingTransactionHelper.RetryingTransactionCallback<Object>()
+            {        
+                public Object execute() throws Throwable
+                {
+                    String currentUserName = SiteServiceImpl.this.authenticationComponent.getCurrentUserName();
+                    SiteServiceImpl.this.authenticationComponent.setSystemUserAsCurrentUser();
+                    try
+                    {
+                        // Bootstrap the site stores
+                        bootstrapSiteStore(SITE_DM_STORE);
+                    }
+                    finally
+                    {
+                        if (currentUserName != null)
+                        {
+                            SiteServiceImpl.this.authenticationComponent.setCurrentUser(currentUserName);
+                        }
+                        else
+                        {
+                            SiteServiceImpl.this.authenticationComponent.clearCurrentSecurityContext();
+                        }
+                    }
+                    
+                    return null;
+                }                
+            });        
+    }
+    
+    /**
+     * @see org.alfresco.util.AbstractLifecycleBean#onShutdown(org.springframework.context.ApplicationEvent)
+     */
+    @Override
+    protected void onShutdown(ApplicationEvent event)
+    {
+        // Do nothing
+    }
+    
+    /**
+     * Bootstrap the DM site store
+     * 
+     * @param storeRef  the store reference
+     */
+    private void bootstrapSiteStore(StoreRef storeRef)
+    {
+        // Check to see if the sotre exists
+        if (this.nodeService.exists(storeRef) == false)
+        {
+            // Create the store
+            this.nodeService.createStore(storeRef.getProtocol(), storeRef.getIdentifier());
+            NodeRef rootNode = this.nodeService.getRootNode(storeRef);
+            
+            // Create the root folder where sites will be stored
+            this.nodeService.createNode(rootNode, 
+                                        ContentModel.ASSOC_CHILDREN, 
+                                        QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "sites"), 
+                                        ContentModel.TYPE_FOLDER);
+        }
+    }
+}

source/java/org/alfresco/repo/site/SiteServiceImplTest.java

@@ -0,0 +1,144 @@
+/*
+ * Copyright (C) 2005-2007 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.repo.site;
+
+import java.util.HashMap;
+import java.util.List;
+
+import org.alfresco.repo.jscript.ClasspathScriptLocation;
+import org.alfresco.service.cmr.repository.ScriptLocation;
+import org.alfresco.service.cmr.repository.ScriptService;
+import org.alfresco.util.BaseAlfrescoSpringTest;
+
+/**
+ * Thumbnail service implementation unit test
+ * 
+ * @author Roy Wetherall
+ */
+public class SiteServiceImplTest extends BaseAlfrescoSpringTest 
+{
+    private static final String TEST_SITE_PRESET = "testSitePreset";
+    private static final String TEST_SITE_PRESET_2 = "testSitePreset2";
+    private static final String TEST_TITLE = "This is my title";
+    private static final String TEST_DESCRIPTION = "This is my description";
+    
+    private SiteService siteService;
+    
+    private ScriptService scriptService;
+    
+    /**
+     * Called during the transaction setup
+     */
+    protected void onSetUpInTransaction() throws Exception
+    {
+        super.onSetUpInTransaction();
+        
+        // Get the required services
+        this.siteService = (SiteService)this.applicationContext.getBean("siteService");
+        this.scriptService = (ScriptService)this.applicationContext.getBean("ScriptService");
+    }
+	
+    public void testCreateSite() throws Exception
+    {
+        // Create a public site
+        SiteInfo siteInfo = this.siteService.createSite(TEST_SITE_PRESET, "mySiteTest", TEST_TITLE, TEST_DESCRIPTION, true);
+        
+        // Check the site
+        checkSiteInfo(siteInfo, TEST_SITE_PRESET, "mySiteTest", TEST_TITLE, TEST_DESCRIPTION, true);     
+    }
+    
+    private void checkSiteInfo( SiteInfo siteInfo, String expectedSitePreset, String expectedShortName, String expectedTitle, 
+                                String expectedDescription, boolean expectedIsPublic)
+    {
+        assertNotNull(siteInfo);
+        assertEquals(expectedSitePreset, siteInfo.getSitePreset());
+        assertEquals(expectedShortName, siteInfo.getShortName());
+        assertEquals(expectedTitle, siteInfo.getTitle());
+        assertEquals(expectedDescription, siteInfo.getDescription());
+        assertEquals(expectedIsPublic, siteInfo.getIsPublic());
+    }
+    
+    public void testListSites() throws Exception
+    {
+        // TODO
+        // - check filters
+        // - check private excluded when not owner (or admin)
+        
+        // Check for no sites
+        List<SiteInfo> sites = this.siteService.listSites(null, null);
+        assertNotNull(sites);
+        assertTrue(sites.isEmpty());
+        
+        // Create some sites
+        this.siteService.createSite(TEST_SITE_PRESET, "mySiteOne", TEST_TITLE, TEST_DESCRIPTION, true);
+        this.siteService.createSite(TEST_SITE_PRESET, "mySiteTwo", TEST_TITLE, TEST_DESCRIPTION, false);
+        this.siteService.createSite(TEST_SITE_PRESET_2, "mySiteThree", TEST_TITLE, TEST_DESCRIPTION, true);
+        this.siteService.createSite(TEST_SITE_PRESET_2, "mySiteFour", TEST_TITLE, TEST_DESCRIPTION, false);
+        
+        // Get all the sites
+        sites = this.siteService.listSites(null, null);
+        assertNotNull(sites);
+        assertEquals(4, sites.size());
+        // Do detailed check of the site info objects
+        for (SiteInfo site : sites)
+        {
+            String shortName = site.getShortName();
+            if (shortName.equals("mySiteOne") == true)
+            {
+                checkSiteInfo(site, TEST_SITE_PRESET, "mySiteOne", TEST_TITLE, TEST_DESCRIPTION, true);
+            }
+            else if (shortName.equals("mySiteTwo") == true)
+            {
+                checkSiteInfo(site, TEST_SITE_PRESET, "mySiteTwo", TEST_TITLE, TEST_DESCRIPTION, false);
+            }
+            else if (shortName.equals("mySiteThree") == true)
+            {
+                checkSiteInfo(site, TEST_SITE_PRESET_2, "mySiteThree", TEST_TITLE, TEST_DESCRIPTION, true);
+            }
+            else if (shortName.equals("mySiteFour") == true)
+            {
+                checkSiteInfo(site, TEST_SITE_PRESET_2, "mySiteFour", TEST_TITLE, TEST_DESCRIPTION, false);                
+            }
+            else
+            {
+                fail("The shortname " + shortName + " is not recognised");
+            }
+        }
+        
+    }
+    
+    public void testJSAPI() throws Exception
+    {
+        ScriptLocation location = new ClasspathScriptLocation("org/alfresco/repo/site/script/test_siteService.js");
+        String result = (String)this.scriptService.executeScript(location, new HashMap<String, Object>(0));
+        
+        // Check the result and fail if message returned
+        if (result != null && result.length() != 0)
+        {
+            fail("The site service text JS script failed: " + result);
+        }
+    }
+
+}

source/java/org/alfresco/repo/site/script/ScriptSiteService.java

@@ -0,0 +1,93 @@
+/*
+ * Copyright (C) 2005-2007 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.repo.site.script;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.alfresco.repo.jscript.BaseScopableProcessorExtension;
+import org.alfresco.repo.site.SiteInfo;
+import org.alfresco.repo.site.SiteService;
+
+
+/**
+ * Script object representing the site service.
+ * 
+ * @author Roy Wetherall
+ */
+public class ScriptSiteService extends BaseScopableProcessorExtension
+{
+    /** The site service */
+    private SiteService siteService;
+    
+    /**
+     * Set the site service
+     * 
+     * @param siteService   the site service
+     */
+    public void setSiteService(SiteService siteService)
+    {
+        this.siteService = siteService;
+    }
+    
+    /**
+     * Create a new site.
+     * <p>
+     * The site short name will be used to uniquely identify the site so it must be unique.
+     * 
+     * @param sitePreset    site preset
+     * @param shortName     site short name
+     * @param title         site title
+     * @param descripion    site description
+     * @param isPublic      whether the site is public or not
+     * @return Site         the created site
+     */
+    public Site createSite(String sitePreset, String shortName, String title, String descripion, boolean isPublic)
+    {                
+        SiteInfo siteInfo = this.siteService.createSite(sitePreset, shortName, title, descripion, isPublic);
+        return new Site(siteInfo);
+    }
+    
+    /**
+     * List the sites available in the repository.  The returned list can optionally be filtered by name and site
+     * preset.
+     * <p>
+     * If no filters are specified then all the available sites are returned.
+     * 
+     * @param nameFilter        name filter
+     * @param sitePresetFilter  site preset filter
+     * @return List<Site>       a list of the site filtered as appropriate             
+     */
+    public List<Site> listSites(String nameFilter, String sitePresetFilter)
+    {
+        List<SiteInfo> siteInfos = this.siteService.listSites(nameFilter, sitePresetFilter);
+        List<Site> sites = new ArrayList<Site>(siteInfos.size());
+        for (SiteInfo siteInfo : siteInfos)
+        {
+            sites.add(new Site(siteInfo));
+        }
+        return sites;
+    }      
+}

source/java/org/alfresco/repo/site/script/Site.java

@@ -0,0 +1,75 @@
+/*
+ * Copyright (C) 2005-2007 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.repo.site.script;
+
+import java.io.Serializable;
+
+import org.alfresco.repo.site.SiteInfo;
+
+/**
+ * @author Roy Wetherall
+ */
+public class Site implements Serializable
+{
+    private static final long serialVersionUID = 8013569574120957923L;
+    
+    private SiteInfo siteInfo;
+    
+    public Site(SiteInfo siteInfo)
+    {
+        this.siteInfo = siteInfo;
+    }
+   
+    public String getSitePreset()
+    {
+        return this.siteInfo.getSitePreset();
+    }
+    
+    public String getShortName()
+    {
+        return this.siteInfo.getShortName();
+    }
+    
+    public String getTitle()
+    {
+        return this.siteInfo.getTitle();
+    }
+
+    // TODO set title
+    
+    public String getDescription()
+    {
+        return this.siteInfo.getDescription();
+    }
+    
+    // TODO set description
+    
+    public boolean getIsPublic()
+    {
+        return this.siteInfo.getIsPublic();
+    }
+    
+    // TODO set isPublic
+}

source/java/org/alfresco/repo/site/script/test_siteService.js

@@ -0,0 +1,29 @@
+var failure = "";
+
+// Try and create a site
+var site = siteService.createSite("sitePreset", "siteShortName", "siteTitle", "siteDescription", true);
+
+// Check that the site details are correct
+if (site.sitePreset != "sitePreset")
+{
+	failure += "\nSite preset is not set on created site";
+}
+if (site.shortName != "siteShortName")
+{
+	failure += "\nSite short name is not set on created site";
+}
+if (site.title != "siteTitle")
+{
+	failure += "\nSite title is not set on created site";
+}
+if (site.description != "siteDescription")
+{
+	failure += "\nSite description is not set on created site";
+}
+if (site.isPublic != true)
+{
+	failure += "\nCreated site should be marked public";
+}
+
+// Return the failure message
+failure;