inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-08-07 17:49:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merged V2.1 to HEAD

Browse Source 
6515: Fix for AWC-1362 (system error page when clicking on space that doesn't exist in navigator)
   6516: Fix for AR-1688 - Vista
   6518: Fix for AWC-1479, AWC-1199 and AWC-426 (javascript insertion into forum posts security related fixes) limit to subset of safe tags for posting
   6519: Fix AR-1690 Web Scripts url.args is missing even though it's documented in WIKI
   6520: Fix for AWC-1271 (component generator config ignored for associations)
   6521: Fix AWC-1492 Some included javascript files in template/webscripts use the wrong app context path i.e. /alfresco when the app is called /alfzip
   6522: Build fix
   6523: - Fix rendering of tasks with no description in office portlets
   6524: Added thread pool for index merging (AR-1633, AR-1579)
   6525: One more fix for rendering of tasks with no description in office portlets
   6527: Renamed axis jar to reflect version number.
   6528: WebServices query cache refactoring


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@6741 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Derek Hulley
2007-09-10 23:44:07 +00:00
parent 807349fab5
commit 0d728ed843
21 changed files with 1579 additions and 1378 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
source/java/org/alfresco/repo/webservice/AbstractQuery.java Normal file
View File

@@ -0,0 +1,87 @@
/*
* 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.webservice;
import java.util.Set;
import org.alfresco.repo.webservice.types.ResultSetRowNode;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.namespace.QName;
/**
* Abstract implementation of a QuerySession providing support for automatic id generation
* and provides support for paging through query results.
* <p>
* Before executing, all the services need to be set.
*
* @author gavinc
*/
public abstract class AbstractQuery<RESULTSET> implements ServerQuery<RESULTSET>
{
public AbstractQuery()
{
}
/**
* Override this method only if the query can limit the results without a post-query cut-off.
*
* {@inheritDoc}
*/
public RESULTSET execute(ServiceRegistry serviceRegistry, long maxResults)
{
return execute(serviceRegistry);
}
/**
* Create a result set row node object for the provided node reference
*
* @param nodeRef
* the node reference
* @param nodeService
* the node service
* @return
* the result set row node
*/
protected ResultSetRowNode createResultSetRowNode(NodeRef nodeRef, NodeService nodeService)
{
// Get the type
String type = nodeService.getType(nodeRef).toString();
// Get the aspects applied to the node
Set<QName> aspects = nodeService.getAspects(nodeRef);
String[] aspectNames = new String[aspects.size()];
int index = 0;
for (QName aspect : aspects)
{
aspectNames[index] = aspect.toString();
index++;
}
// Create and return the result set row node
return new ResultSetRowNode(nodeRef.getId(), type, aspectNames);
}
}

254
source/java/org/alfresco/repo/webservice/AbstractQuerySession.java Normal file
View File

@@ -0,0 +1,254 @@
/*
* 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.webservice;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.util.GUID;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* An abstract implementation of the query session that keeps track of the paging data.
* It provides support for paging of results of <code>Serializable[]</code> instances.
*
* @author Derek Hulley
* @since 2.1
*/
public abstract class AbstractQuerySession<RESULTSET, RESULTSETROW> implements QuerySession<RESULTSET>
{
private static Log logger = LogFactory.getLog(AbstractQuerySession.class);
private String id;
private long maxResults;
private long batchSize;
private ServerQuery<RESULTSET> query;
/** a transient cache of the query results */
private transient RESULTSET cachedResults;
/**
* A pointer to the first row to be returned. When the last result is returned, the
* position will be out of range of the current results by 1.
*/
private long position;
/**
* Keep track of whether the position has previously passed the end of a set of results.
*/
private boolean expectMoreResults;
/**
* Common constructor that initialises the session's id and batch size
*
* @param maxResults
* the maximum number of results to retrieve for the query. This is not the page
* size, which is normally significantly smaller.
* @param batchSize
* the batch size this session will use
* @param query
* the query that generates the results
*/
public AbstractQuerySession(long maxResults, long batchSize, ServerQuery<RESULTSET> query)
{
this.id = GUID.generate();
this.batchSize = batchSize;
this.maxResults = maxResults;
this.query = query;
this.position = 0;
this.expectMoreResults = true;
}
/**
* {@inheritDoc}
*/
public String getId()
{
return this.id;
}
/**
* {@inheritDoc}
*/
public ServerQuery getQuery()
{
return query;
}
/**
* Helper method to get the results. This may be a cached value or may be
* freshly retrieved from the query object.
*
* @param serviceRegistry the
* @return the query results, new or cached
*/
protected RESULTSET getQueryResults(ServiceRegistry serviceRegistry)
{
if (cachedResults != null)
{
return cachedResults;
}
// Get the results and cache them
cachedResults = query.execute(serviceRegistry, maxResults);
// Done
return cachedResults;
}
/**
* {@inheritDoc}
*/
public boolean haveMoreResults()
{
return expectMoreResults;
}
protected abstract RESULTSETROW[] makeArray(int size);
/**
* Helper method to page through the results. The task of retrieving, unwrapping and
* rewrapping the array of results (rows) is left up to the derived implementations.
*/
protected final RESULTSETROW[] getNextResults(RESULTSETROW[] allResults)
{
/*
* This class can't manipulate the query to get the results because each
* query implementation's results (the array of rows) is contained within
* a different type of object. This method helps
*/
long allResultsSize = allResults.length;
RESULTSETROW[] batchedResults = null;
if (position >= allResultsSize)
{
// We are already past the last result
batchedResults = makeArray(0);
// Position is after last
position = allResultsSize;
}
else if (position == 0 && batchSize >= allResultsSize)
{
// We can give back the original results
batchedResults = allResults;
// Position is after last
position = allResultsSize;
}
else if ((position + batchSize) >= allResultsSize)
{
// There isn't an excess of rows remaining, so copy to the last one
long lastResultIndex = allResultsSize - 1L;
long rowCopyCount = lastResultIndex - position;
batchedResults = makeArray((int)rowCopyCount);
System.arraycopy(allResults, (int)position, batchedResults, 0, (int)rowCopyCount);
// Position is after last
position = allResultsSize;
}
else
{
// There are an excess of rows remaining
batchedResults = makeArray((int)batchSize);
System.arraycopy(allResults, (int)position, batchedResults, 0, (int)batchSize);
// Position increases by the batch size
position += batchSize;
}
// Keep track of whether we expect more results
if (position >= allResultsSize)
{
expectMoreResults = false;
}
// Done
if (logger.isDebugEnabled())
{
logger.debug("\n" +
"Fetched next set of results: \n" +
" Total results count: " + allResultsSize + "\n" +
" Batch size: " + batchedResults.length + "\n" +
" New Position: " + position);
}
return batchedResults;
// long allResultsSize = allResults.getTotalRowCount();
//
// ResultSet batchedResults = null;
// if (position >= allResultsSize)
// {
// // We are already past the last result
// batchedResults = new ResultSet();
// batchedResults.setRows(new ResultSetRow[] {});
// batchedResults.setTotalRowCount(0);
// batchedResults.setMetaData(allResults.getMetaData());
// // Position is after last
// position = allResultsSize;
// }
// else if (position == 0 && batchSize >= allResultsSize)
// {
// // We can give back the original results
// batchedResults = allResults;
// // Position is after last
// position = allResultsSize;
// }
// else if ((position + batchSize) >= allResultsSize)
// {
// // There isn't an excess of rows remaining, so copy to the last one
// long lastResultIndex = allResultsSize - 1L;
// long rowCopyCount = lastResultIndex - position;
// ResultSetRow[] batchedRows = new ResultSetRow[(int)rowCopyCount];
// ResultSetRow[] allRows = allResults.getRows();
// System.arraycopy(allRows, (int)position, batchedRows, 0, (int)rowCopyCount);
// // Build the results
// batchedResults = new ResultSet();
// batchedResults.setRows(batchedRows);
// batchedResults.setTotalRowCount(rowCopyCount);
// batchedResults.setMetaData(allResults.getMetaData());
// // Position is after last
// position = allResultsSize;
// }
// else
// {
// // There are an excess of rows remaining
// ResultSetRow[] batchedRows = new ResultSetRow[(int)batchSize];
// ResultSetRow[] allRows = allResults.getRows();
// System.arraycopy(allRows, (int)position, batchedRows, 0, (int)batchSize);
// // Build the results
// batchedResults = new ResultSet();
// batchedResults.setRows(batchedRows);
// batchedResults.setTotalRowCount(batchSize);
// batchedResults.setMetaData(allResults.getMetaData());
// // Position increases by the batch size
// position += batchSize;
// }
// // Keep track of whether we expect more results
// if (position >= allResultsSize)
// {
// expectMoreResults = false;
// }
// // Done
// if (logger.isDebugEnabled())
// {
// logger.debug("\n" +
// "Fetched net set of results: \n" +
// " Total results count: " + allResultsSize + "\n" +
// " Batch size: " + batchedResults.getTotalRowCount() + "\n" +
// " New Position: " + position);
// }
// return batchedResults;
}
}

158
source/java/org/alfresco/repo/webservice/AbstractWebService.java
View File

@@ -1,77 +1,117 @@
/* /*
* Copyright (C) 2005-2007 Alfresco Software Limited. * Copyright (C) 2005-2007 Alfresco Software Limited.
* *
* Licensed under the GNU Lesser General Public License as * This program is free software; you can redistribute it and/or
* published by the Free Software Foundation; either version * modify it under the terms of the GNU General Public License
* 2.1 of the License, or (at your option) any later version. * as published by the Free Software Foundation; either version 2
* You may obtain a copy of the License at * of the License, or (at your option) any later version.
*
* http://www.gnu.org/licenses/lgpl.txt * This program is distributed in the hope that it will be useful,
* * but WITHOUT ANY WARRANTY; without even the implied warranty of
* Unless required by applicable law or agreed to in writing, * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* software distributed under the License is distributed on an * GNU General Public License for more details.
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific * You should have received a copy of the GNU General Public License
* language governing permissions and limitations under the * along with this program; if not, write to the Free Software
* License. * 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.webservice; package org.alfresco.repo.webservice;
import org.alfresco.repo.cache.SimpleCache;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.dictionary.DictionaryService;
import org.alfresco.service.cmr.repository.ContentService; import org.alfresco.service.cmr.repository.ContentService;
import org.alfresco.service.cmr.repository.NodeService; import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.search.SearchService; import org.alfresco.service.cmr.search.SearchService;
import org.alfresco.service.namespace.NamespaceService; import org.alfresco.service.namespace.NamespaceService;
/** /**
* Abstract base class for all web service implementations, provides support for common * Abstract base class for all web service implementations, provides support for common service injection
* service injection
* *
* @author gavinc * @author gavinc
*/ */
public abstract class AbstractWebService public abstract class AbstractWebService
{ {
protected NodeService nodeService; protected ServiceRegistry serviceRegistry;
protected ContentService contentService; protected DictionaryService dictionaryService;
protected SearchService searchService; protected NodeService nodeService;
protected NamespaceService namespaceService; protected ContentService contentService;
protected SearchService searchService;
/** protected NamespaceService namespaceService;
* Sets the instance of the NodeService to be used
* protected SimpleCache<String, QuerySession> querySessionCache;
* @param nodeService The NodeService
*/ public void setServiceRegistry(ServiceRegistry serviceRegistry)
public void setNodeService(NodeService nodeService) {
{ this.serviceRegistry = serviceRegistry;
this.nodeService = nodeService; }
}
/**
/** * Sets the instance of the DictionaryService to be used
* Sets the ContentService instance to use *
* * @param dictionaryService
* @param contentSvc The ContentService * The DictionaryService
*/ */
public void setContentService(ContentService contentSvc) public void setDictionaryService(DictionaryService dictionaryService)
{ {
this.contentService = contentSvc; this.dictionaryService = dictionaryService;
} }
/** /**
* Sets the instance of the SearchService to be used * Sets the instance of the NodeService to be used
* *
* @param searchService The SearchService * @param nodeService The NodeService
*/ */
public void setSearchService(SearchService searchService) public void setNodeService(NodeService nodeService)
{ {
this.searchService = searchService; this.nodeService = nodeService;
} }
/** /**
* Sets the instance of the NamespaceService to be used * Sets the ContentService instance to use
* *
* @param namespaceService The NamespaceService * @param contentSvc The ContentService
*/ */
public void setNamespaceService(NamespaceService namespaceService) public void setContentService(ContentService contentSvc)
{ {
this.namespaceService = namespaceService; this.contentService = contentSvc;
} }
/**
* Sets the instance of the SearchService to be used
*
* @param searchService The SearchService
*/
public void setSearchService(SearchService searchService)
{
this.searchService = searchService;
}
/**
* Sets the instance of the NamespaceService to be used
*
* @param namespaceService The NamespaceService
*/
public void setNamespaceService(NamespaceService namespaceService)
{
this.namespaceService = namespaceService;
}
/**
* Sets the cache to use for storing the the query session's paging information by query session ID.
*
* @param querySessionCache the cache. Cluster replication should be via serialization of
* the cache values.
*/
public void setQuerySessionCache(SimpleCache<String, QuerySession> querySessionCache)
{
this.querySessionCache = querySessionCache;
}
} }

67
source/java/org/alfresco/repo/webservice/QuerySession.java Normal file
View File

@@ -0,0 +1,67 @@
/*
* 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.webservice;
import java.io.Serializable;
import org.alfresco.service.ServiceRegistry;
/**
* An interface for objects that track the query and its results. The only commonality between
* the different types of results used in the WebServices return values is that they are
* Serializable.
*
* @author Derek Hulley
*/
public interface QuerySession<RESULTSET> extends Serializable
{
/**
* Retrieves the id this query session can be identified as
*
* @return Id of this query session
*/
public String getId();
/**
* Check if the session is expecting more results. This will be <tt>false</tt> if the
* cursor previously passed the end of a given set of results.
*/
public boolean haveMoreResults();
/**
* Get the next batch of results from the full set of available results. If there are no results
* available, then this session must go and fetch them. It is up to the implementation to provide
* a means for this to occur.
*
* @param serviceRegistry
* the services to perform a query
* @param allResults
* All available results. It may be necessary to requery to get the results.
* @return
* Returns the next batch of results based on the maximum fetch size. If there are no
* more results, the resultset will be empty.
*/
public RESULTSET getNextResults(ServiceRegistry serviceRegistry);
}

65
source/java/org/alfresco/repo/webservice/repository/QuerySession.java → source/java/org/alfresco/repo/webservice/ServerQuery.java
View File

@@ -22,53 +22,48 @@
* the FLOSS exception, and it is also available here: * the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing" * http://www.alfresco.com/legal/licensing"
*/ */
package org.alfresco.repo.webservice.repository; package org.alfresco.repo.webservice;
import java.io.Serializable; import java.io.Serializable;
import org.alfresco.service.cmr.dictionary.DictionaryService; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.search.SearchService;
import org.alfresco.service.namespace.NamespaceService;
/** /**
* Interface definition for a QuerySession. * Interface definition for a QuerySession.
* *
* @author gavinc * @author gavinc
*/ */
public interface QuerySession extends Serializable public interface ServerQuery<RESULTSET> extends Serializable
{ {
/** System column namess */ /** System column namess */
public static String SYS_COL_ASSOC_TYPE = "associationType"; public static String SYS_COL_ASSOC_TYPE = "associationType";
public static String SYS_COL_ASSOC_NAME = "associationName"; public static String SYS_COL_ASSOC_NAME = "associationName";
public static String SYS_COL_IS_PRIMARY = "isPrimary"; public static String SYS_COL_IS_PRIMARY = "isPrimary";
public static String SYS_COL_NTH_SIBLING = "nthSibling"; public static String SYS_COL_NTH_SIBLING = "nthSibling";
/** /**
* Retrieves the id this query session can be identified as * Executes the query and returns the <b>full query results</b>.
* *
* @return Id of this query session * @param
*/ * The services to help make the query
public String getId(); * @return
* The full set of query results.
/** * The results must be empty if there are no results.
* Returns a QueryResult object representing the next batch of results. */
* QueryResult will contain a maximum of items as determined by the public RESULTSET execute(ServiceRegistry serviceRegistry);
* <code>fetchSize</code> element of the QueryConfiguration SOAP header.
* /**
* When the last batch of results is being returned the querySession of * Executes the query and return all results up to given maximum number.
* QueryResult will be null. * Note that this is not the same as the page size, but rather is a total
* * upper limit to the number of results that can viewed.
* @see org.alfresco.repo.webservice.repository.QuerySession#getId() *
* @param searchService The SearchService to use for gathering the results * @param
* @param nodeService The NodeService to use for gathering the results * The services to help make the query
* @param namespaceService The NamespaceService to use * @param maxResults
* @return QueryResult containing the next batch of results or null if there * the total number of results to retrieve
* are no more results * @return
*/ * The full set of query results up to the maximum given.
public QueryResult getNextResultsBatch( * The results must be empty if there are no results.
SearchService searchService, */
NodeService nodeService, public RESULTSET execute(ServiceRegistry serviceRegistry, long maxResults);
NamespaceService namespaceService, }
DictionaryService dictionaryService);
}

7
source/java/org/alfresco/repo/webservice/Utils.java
View File

@@ -79,6 +79,8 @@ import org.springframework.web.context.support.WebApplicationContextUtils;
*/ */
public class Utils public class Utils
{ {
/** Default batch size for query results - 1000 */
public static final int DEFAULT_BATCH_SIZE = 1000;
public static final String REPOSITORY_SERVICE_NAMESPACE = "http://www.alfresco.org/ws/service/repository/1.0"; public static final String REPOSITORY_SERVICE_NAMESPACE = "http://www.alfresco.org/ws/service/repository/1.0";
/** Get the logger for this class */ /** Get the logger for this class */
@@ -384,8 +386,7 @@ public class Utils
} }
NodeRef rootNodeRef = nodeService.getRootNode(convertToStoreRef(store)); NodeRef rootNodeRef = nodeService.getRootNode(convertToStoreRef(store));
List<NodeRef> nodes = searchService.selectNodes(rootNodeRef, path, List<NodeRef> nodes = searchService.selectNodes(rootNodeRef, path, null, namespaceService, false);
null, namespaceService, false);
// make sure we only have one result // make sure we only have one result
if (nodes.size() != 1) if (nodes.size() != 1)
@@ -589,7 +590,7 @@ public class Utils
*/ */
public static int getBatchSize(MessageContext msgContext) public static int getBatchSize(MessageContext msgContext)
{ {
int batchSize = -1; int batchSize = DEFAULT_BATCH_SIZE;
Integer batchConfigSize = (Integer) MessageContext.getCurrentContext() Integer batchConfigSize = (Integer) MessageContext.getCurrentContext()
.getProperty(QueryConfigHandler.ALF_FETCH_SIZE); .getProperty(QueryConfigHandler.ALF_FETCH_SIZE);

246
source/java/org/alfresco/repo/webservice/administration/AdministrationWebService.java
View File

@@ -36,19 +36,19 @@ import java.util.Set;
import org.alfresco.error.AlfrescoRuntimeException; import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.model.ContentModel; import org.alfresco.model.ContentModel;
import org.alfresco.repo.cache.SimpleCache;
import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
import org.alfresco.repo.webservice.AbstractWebService; import org.alfresco.repo.webservice.AbstractWebService;
import org.alfresco.repo.webservice.Utils; import org.alfresco.repo.webservice.Utils;
import org.alfresco.repo.webservice.action.ActionFault; import org.alfresco.repo.webservice.action.ActionFault;
import org.alfresco.repo.webservice.repository.RepositoryFault;
import org.alfresco.repo.webservice.types.NamedValue; import org.alfresco.repo.webservice.types.NamedValue;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter; import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter;
import org.alfresco.service.cmr.security.AuthenticationService; import org.alfresco.service.cmr.security.AuthenticationService;
import org.alfresco.service.cmr.security.PersonService; import org.alfresco.service.cmr.security.PersonService;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
import org.alfresco.service.transaction.TransactionService; import org.alfresco.service.transaction.TransactionService;
import org.alfresco.util.GUID;
import org.apache.axis.MessageContext; import org.apache.axis.MessageContext;
import org.apache.commons.logging.Log; import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory; import org.apache.commons.logging.LogFactory;
@@ -74,9 +74,6 @@ public class AdministrationWebService extends AbstractWebService implements
/** A set of ignored properties */ /** A set of ignored properties */
private static Set<QName> ignoredProperties = new HashSet<QName>(3); private static Set<QName> ignoredProperties = new HashSet<QName>(3);
/** Simple cache used to store user query sessions */
private SimpleCache<String, UserQuerySession> querySessionCache;
/** /**
* Constructor * Constructor
*/ */
@@ -118,18 +115,6 @@ public class AdministrationWebService extends AbstractWebService implements
this.authenticationService = authenticationService; this.authenticationService = authenticationService;
} }
/**
* Sets the instance of the SimpleCache to be used
*
* @param querySessionCache
* The SimpleCache
*/
public void setQuerySessionCache(
SimpleCache<String, UserQuerySession> querySessionCache)
{
this.querySessionCache = querySessionCache;
}
/** /**
* @see org.alfresco.repo.webservice.administration.AdministrationServiceSoapPort#queryUsers(org.alfresco.repo.webservice.administration.UserFilter) * @see org.alfresco.repo.webservice.administration.AdministrationServiceSoapPort#queryUsers(org.alfresco.repo.webservice.administration.UserFilter)
*/ */
@@ -168,18 +153,33 @@ public class AdministrationWebService extends AbstractWebService implements
{ {
MessageContext msgContext = MessageContext.getCurrentContext(); MessageContext msgContext = MessageContext.getCurrentContext();
// Create the query
UserQuery query = new UserQuery(filter);
// Create a user query session // Create a user query session
UserQuerySession userQuerySession = new UserQuerySession(Utils.getBatchSize(msgContext), filter); UserQuerySession userQuerySession = new UserQuerySession(Long.MAX_VALUE, Utils.getBatchSize(msgContext), query);
UserQueryResults userQueryResults = userQuerySession.getNextBatch();
// Get the next batch of results
UserQueryResults userQueryResults = userQuerySession.getNextResults(serviceRegistry);
String querySessionId = userQuerySession.getId();
// add the session to the cache if there are more results to come // add the session to the cache if there are more results to come
if (userQueryResults.getQuerySession() != null) boolean haveMoreResults = userQuerySession.haveMoreResults();
if (haveMoreResults)
{ {
// this.querySessionCache.putQuerySession(querySession); querySessionCache.put(querySessionId, userQuerySession);
this.querySessionCache.put(userQueryResults.getQuerySession(), userQuerySession);
} }
return userQueryResults; // Construct the return value
// TODO: http://issues.alfresco.com/browse/AR-1689
// This looks odd, but I've chosen to be specific about when the ID is set on the return
// results and when it isn't.
UserQueryResults result = new UserQueryResults(
haveMoreResults ? querySessionId : null,
userQueryResults.getUserDetails());
// Done
return result;
} }
/** /**
@@ -212,20 +212,34 @@ public class AdministrationWebService extends AbstractWebService implements
/** /**
* *
* @param querySession * @param querySessionId
* @return * @return
*/ */
private UserQueryResults fetchMoreUsersImpl(String querySession) private UserQueryResults fetchMoreUsersImpl(String querySessionId) throws RepositoryFault
{ {
UserQueryResults queryResult = null; UserQuerySession session = null;
UserQuerySession session = this.querySessionCache.get(querySession); try
{
session = (UserQuerySession) querySessionCache.get(querySessionId);
}
catch (ClassCastException e)
{
if (logger.isDebugEnabled())
{
logger.debug("Query session was not generated by the AdministrationWebService: " + querySessionId);
}
throw new RepositoryFault(
4,
"querySession with id '" + querySessionId + "' is invalid");
}
UserQueryResults queryResult = null;
if (session != null) if (session != null)
{ {
queryResult = session.getNextBatch(); queryResult = session.getNextResults(serviceRegistry);
if (queryResult.getQuerySession() == null) if (!session.haveMoreResults())
{ {
this.querySessionCache.remove(querySession); this.querySessionCache.remove(querySessionId);
} }
} }
@@ -269,12 +283,13 @@ public class AdministrationWebService extends AbstractWebService implements
*/ */
private UserDetails getUserImpl(String userName) private UserDetails getUserImpl(String userName)
{ {
NodeService nodeService = serviceRegistry.getNodeService();
UserDetails userDetails = null; UserDetails userDetails = null;
if (this.personService.personExists(userName) == true) if (this.personService.personExists(userName) == true)
{ {
NodeRef nodeRef = this.personService.getPerson(userName); NodeRef nodeRef = this.personService.getPerson(userName);
userDetails = createUserDetails(userName, nodeRef); userDetails = createUserDetails(nodeService, userName, nodeRef);
} }
else else
{ {
@@ -291,7 +306,7 @@ public class AdministrationWebService extends AbstractWebService implements
* @param nodeRef the node reference * @param nodeRef the node reference
* @return the user details object populated with the appropriate property values * @return the user details object populated with the appropriate property values
*/ */
private UserDetails createUserDetails(String userName, NodeRef nodeRef) /* package */ static UserDetails createUserDetails(NodeService nodeService, String userName, NodeRef nodeRef)
{ {
// Create the user details object // Create the user details object
UserDetails userDetails = new UserDetails(); UserDetails userDetails = new UserDetails();
@@ -300,7 +315,7 @@ public class AdministrationWebService extends AbstractWebService implements
userDetails.setUserName(userName); userDetails.setUserName(userName);
// Set the various property values // Set the various property values
Map<QName, Serializable> properties = this.nodeService.getProperties(nodeRef); Map<QName, Serializable> properties = nodeService.getProperties(nodeRef);
List<NamedValue> namedValues = new ArrayList<NamedValue>(properties.size()); List<NamedValue> namedValues = new ArrayList<NamedValue>(properties.size());
for (Map.Entry<QName, Serializable> entry : properties.entrySet()) for (Map.Entry<QName, Serializable> entry : properties.entrySet())
{ {
@@ -364,6 +379,7 @@ public class AdministrationWebService extends AbstractWebService implements
*/ */
private UserDetails[] createUsersImpl(NewUserDetails[] newUsers) private UserDetails[] createUsersImpl(NewUserDetails[] newUsers)
{ {
NodeService nodeService = serviceRegistry.getNodeService();
UserDetails[] userDetails = new UserDetails[newUsers.length]; UserDetails[] userDetails = new UserDetails[newUsers.length];
int index = 0; int index = 0;
@@ -382,7 +398,7 @@ public class AdministrationWebService extends AbstractWebService implements
NodeRef personNodeRef = this.personService.createPerson(properties); NodeRef personNodeRef = this.personService.createPerson(properties);
// Add the details to the result // Add the details to the result
userDetails[index] = createUserDetails(newUser.getUserName(), personNodeRef); userDetails[index] = createUserDetails(nodeService, newUser.getUserName(), personNodeRef);
index++; index++;
} }
@@ -424,6 +440,7 @@ public class AdministrationWebService extends AbstractWebService implements
*/ */
private UserDetails[] updateUsersImpl(UserDetails[] users) private UserDetails[] updateUsersImpl(UserDetails[] users)
{ {
NodeService nodeService = serviceRegistry.getNodeService();
UserDetails[] userDetails = new UserDetails[users.length]; UserDetails[] userDetails = new UserDetails[users.length];
int index = 0; int index = 0;
@@ -442,7 +459,7 @@ public class AdministrationWebService extends AbstractWebService implements
// Add the details to the result // Add the details to the result
NodeRef nodeRef = this.personService.getPerson(user.getUserName()); NodeRef nodeRef = this.personService.getPerson(user.getUserName());
userDetails[index] = createUserDetails(user.getUserName(), nodeRef); userDetails[index] = createUserDetails(nodeService, user.getUserName(), nodeRef);
index++; index++;
} }
@@ -539,163 +556,4 @@ public class AdministrationWebService extends AbstractWebService implements
this.personService.deletePerson(userName); this.personService.deletePerson(userName);
} }
} }
/**
* User query session used to support batched user query
*
* @author Roy Wetherall
*/
private class UserQuerySession implements Serializable
{
private static final long serialVersionUID = -2960711874297744356L;
private int batchSize = -1;
private UserFilter filter;
protected int position = 0;
private String id;
/**
* Constructor
*
* @param batchSize
* @param filter
*/
public UserQuerySession(int batchSize, UserFilter filter)
{
this.batchSize = batchSize;
this.filter = filter;
this.id = GUID.generate();
}
/**
* @see org.alfresco.repo.webservice.repository.QuerySession#getId()
*/
public String getId()
{
return this.id;
}
/**
* Calculates the index of the last row to retrieve.
*
* @param totalRowCount The total number of rows in the results
* @return The index of the last row to return
*/
protected int calculateLastRowIndex(int totalRowCount)
{
int lastRowIndex = totalRowCount;
// set the last row index if there are more results available
// than the batch size
if ((this.batchSize != -1) && ((this.position + this.batchSize) < totalRowCount))
{
lastRowIndex = this.position + this.batchSize;
}
return lastRowIndex;
}
/**
* Calculates the value of the next position.
* If the end of the result set is reached the position is set to -1
*
* @param totalRowCount The total number of rows in the results
* @param queryResult The QueryResult object being returned to the client,
* if there are no more results the id is removed from the QueryResult instance
*/
protected void updatePosition(int totalRowCount, UserQueryResults queryResult)
{
if (this.batchSize == -1)
{
this.position = -1;
queryResult.setQuerySession(null);
}
else
{
this.position += this.batchSize;
if (this.position >= totalRowCount)
{
// signify that there are no more results
this.position = -1;
queryResult.setQuerySession(null);
}
}
}
/**
* Gets the next batch of user details
*
* @return user query results
*/
public UserQueryResults getNextBatch()
{
UserQueryResults queryResult = null;
if (this.position != -1)
{
if (logger.isDebugEnabled())
logger.debug("Before getNextBatch: " + toString());
Set<NodeRef> nodeRefs = AdministrationWebService.this.personService.getAllPeople();
// Filter the results
List<NodeRef> filteredNodeRefs = null;
if (filter != null && filter.getUserName() != null && filter.getUserName().length() != 0)
{
String userNameFilter = filter.getUserName();
if (logger.isDebugEnabled() == true)
{
logger.debug("Applying user query filter (" + userNameFilter + ")");
}
filteredNodeRefs = new ArrayList<NodeRef>(nodeRefs.size());
for (NodeRef nodeRef : nodeRefs)
{
String userName = (String)AdministrationWebService.this.nodeService.getProperty(nodeRef, ContentModel.PROP_USERNAME);
if (userName.matches(userNameFilter) == true)
{
filteredNodeRefs.add(nodeRef);
}
}
}
else
{
if (logger.isDebugEnabled() == true)
{
logger.debug("No user filter specified");
}
filteredNodeRefs = new ArrayList<NodeRef>(nodeRefs);
}
int totalRows = filteredNodeRefs.size();
int lastRow = calculateLastRowIndex(totalRows);
int currentBatchSize = lastRow - this.position;
if (logger.isDebugEnabled())
logger.debug("Total rows = " + totalRows + ", current batch size = " + currentBatchSize);
List<UserDetails> userDetailsList = new ArrayList<UserDetails>(currentBatchSize);
for (int x = this.position; x < lastRow; x++)
{
NodeRef nodeRef = (NodeRef)filteredNodeRefs.get(x);
String userName = (String)AdministrationWebService.this.nodeService.getProperty(nodeRef, ContentModel.PROP_USERNAME);
UserDetails userDetails = AdministrationWebService.this.createUserDetails(userName, nodeRef);
userDetailsList.add(userDetails);
}
queryResult = new UserQueryResults(getId(), (UserDetails[])userDetailsList.toArray(new UserDetails[userDetailsList.size()]));
// move the position on
updatePosition(totalRows, queryResult);
if (logger.isDebugEnabled())
logger.debug("After getNextBatch: " + toString());
}
return queryResult;
}
}
} }

114
source/java/org/alfresco/repo/webservice/administration/UserQuery.java Normal file
View File

@@ -0,0 +1,114 @@
/*
* 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.webservice.administration;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.webservice.AbstractQuery;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.security.PersonService;
/**
* A query to retrieve normal node associations.
*
* @author Derek Hulley
* @since 2.1
*/
public class UserQuery extends AbstractQuery<UserQueryResults>
{
private static final long serialVersionUID = -672399618512462040L;
private UserFilter userFilter;
/**
* @param userFilter
* The user filter
*/
public UserQuery(UserFilter userFilter)
{
this.userFilter = userFilter;
}
@Override
public String toString()
{
StringBuilder sb = new StringBuilder(128);
sb.append("AssociationQuery")
.append("[ userFilter=").append(userFilter.getUserName())
.append("]");
return sb.toString();
}
/**
* {@inheritDoc}
*/
public UserQueryResults execute(ServiceRegistry serviceRegistry)
{
PersonService personService = serviceRegistry.getPersonService();
NodeService nodeService = serviceRegistry.getNodeService();
Set<NodeRef> nodeRefs = personService.getAllPeople();
// Filter the results
List<NodeRef> filteredNodeRefs = null;
if (userFilter != null && userFilter.getUserName() != null && userFilter.getUserName().length() != 0)
{
String userNameFilter = userFilter.getUserName();
filteredNodeRefs = new ArrayList<NodeRef>(nodeRefs.size());
for (NodeRef nodeRef : nodeRefs)
{
String userName = (String) nodeService.getProperty(nodeRef, ContentModel.PROP_USERNAME);
if (userName.matches(userNameFilter) == true)
{
filteredNodeRefs.add(nodeRef);
}
}
}
else
{
filteredNodeRefs = new ArrayList<NodeRef>(nodeRefs);
}
UserDetails[] results = new UserDetails[filteredNodeRefs.size()];
int index = 0;
for (NodeRef nodeRef : filteredNodeRefs)
{
String userName = (String) nodeService.getProperty(nodeRef, ContentModel.PROP_USERNAME);
results[index] = AdministrationWebService.createUserDetails(nodeService, userName, nodeRef);
index++;
}
UserQueryResults queryResults = new UserQueryResults(null, results);
// Done
return queryResults;
}
}

41
source/java/org/alfresco/repo/webservice/administration/UserQuerySession.java Normal file
View File

@@ -0,0 +1,41 @@
package org.alfresco.repo.webservice.administration;
import org.alfresco.repo.webservice.AbstractQuerySession;
import org.alfresco.repo.webservice.ServerQuery;
import org.alfresco.service.ServiceRegistry;
/**
* A session for managing user-related queries.
*
* @author Derek Hulley
* @since 2.1
*/
public class UserQuerySession extends AbstractQuerySession<UserQueryResults, UserDetails>
{
private static final long serialVersionUID = 1823253197962982642L;
public UserQuerySession(long maxResults, long batchSize, ServerQuery<UserQueryResults> query)
{
super(maxResults, batchSize, query);
}
@Override
protected UserDetails[] makeArray(int size)
{
return new UserDetails[size];
}
public UserQueryResults getNextResults(ServiceRegistry serviceRegistry)
{
UserQueryResults queryResults = getQueryResults(serviceRegistry);
UserDetails[] allRows = queryResults.getUserDetails();
UserDetails[] batchedRows = getNextResults(allRows);
// Build the user query results
UserQueryResults batchedResults = new UserQueryResults();
// batchedResults.setQuerySession(getId()); TODO: http://issues.alfresco.com/browse/AR-1689
batchedResults.setUserDetails(batchedRows);
// Done
return batchedResults;
}
}

132
source/java/org/alfresco/repo/webservice/repository/AbstractQuerySession.java
View File

@@ -1,132 +0,0 @@
/*
* 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.webservice.repository;
import java.util.Set;
import org.alfresco.repo.webservice.types.ResultSetRowNode;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.GUID;
/**
* Abstract implementation of a QuerySession providing support
* for automatic id generation and provides support for
* paging through query results.
*
* @author gavinc
*/
public abstract class AbstractQuerySession implements QuerySession
{
protected int batchSize;
protected int position = 0;
private String id;
/**
* Common constructor that initialises the session's id and batch size
*
* @param batchSize The batch size this session will use
*/
public AbstractQuerySession(int batchSize)
{
this.id = GUID.generate();
this.batchSize = batchSize;
}
/**
* @see org.alfresco.repo.webservice.repository.QuerySession#getId()
*/
public String getId()
{
return this.id;
}
/**
* Calculates the index of the last row to retrieve.
*
* @param totalRowCount The total number of rows in the results
* @return The index of the last row to return
*/
protected int calculateLastRowIndex(int totalRowCount)
{
int lastRowIndex = totalRowCount;
// set the last row index if there are more results available
// than the batch size
if ((this.batchSize != -1) && ((this.position + this.batchSize) < totalRowCount))
{
lastRowIndex = this.position + this.batchSize;
}
return lastRowIndex;
}
/**
* Calculates the value of the next position.
* If the end of the result set is reached the position is set to -1
*
* @param totalRowCount The total number of rows in the results
* @param queryResult The QueryResult object being returned to the client,
* if there are no more results the id is removed from the QueryResult instance
*/
protected void updatePosition(int totalRowCount, QueryResult queryResult)
{
this.position += this.batchSize;
if (this.position >= totalRowCount)
{
// signify that there are no more results
this.position = -1;
queryResult.setQuerySession(null);
}
}
/**
* Create a result set row node object for the provided node reference
*
* @param nodeRef the node reference
* @param nodeService the node service
* @return the result set row node
*/
protected ResultSetRowNode createResultSetRowNode(NodeRef nodeRef, NodeService nodeService)
{
// Get the type
String type = nodeService.getType(nodeRef).toString();
// Get the aspects applied to the node
Set<QName> aspects = nodeService.getAspects(nodeRef);
String[] aspectNames = new String[aspects.size()];
int index = 0;
for (QName aspect : aspects)
{
aspectNames[index] = aspect.toString();
index ++;
}
// Create and return the result set row node
return new ResultSetRowNode(nodeRef.getId(), type, aspectNames);
}
}

196
source/java/org/alfresco/repo/webservice/repository/AssociatedQuerySession.java
View File

@@ -1,196 +0,0 @@
/*
* 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.webservice.repository;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import org.alfresco.repo.webservice.Utils;
import org.alfresco.repo.webservice.types.NamedValue;
import org.alfresco.repo.webservice.types.Reference;
import org.alfresco.repo.webservice.types.ResultSetRow;
import org.alfresco.repo.webservice.types.ResultSetRowNode;
import org.alfresco.service.cmr.dictionary.DictionaryService;
import org.alfresco.service.cmr.repository.AssociationRef;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.search.SearchService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.alfresco.service.namespace.QNamePattern;
import org.alfresco.service.namespace.RegexQNamePattern;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Implementation of a QuerySession that stores the results from a query for
* associations
*
* @author Roy Wetherall
*/
public class AssociatedQuerySession extends AbstractQuerySession
{
private static final long serialVersionUID = 6488008047324436124L;
private transient static Log logger = LogFactory
.getLog(AssociatedQuerySession.class);
private Reference node;
private Association association;
/**
* Constructs a AssociatedQuerySession
*
* @param batchSize
* The batch size to use for this session
* @param node
* The node to retrieve the associations
*/
public AssociatedQuerySession(int batchSize, Reference node, Association association)
{
super(batchSize);
this.node = node;
this.association = association;
}
/**
* @see org.alfresco.repo.webservice.repository.QuerySession#getNextResultsBatch(org.alfresco.service.cmr.search.SearchService,
* org.alfresco.service.cmr.repository.NodeService,
* org.alfresco.service.namespace.NamespaceService)
*/
public QueryResult getNextResultsBatch(SearchService searchService,
NodeService nodeService, NamespaceService namespaceService, DictionaryService dictionaryService)
{
QueryResult queryResult = null;
if (this.position != -1)
{
if (logger.isDebugEnabled())
logger.debug("Before getNextResultsBatch: " + toString());
// create the node ref and get the children from the repository
NodeRef nodeRef = Utils.convertToNodeRef(this.node, nodeService, searchService, namespaceService);
List<AssociationRef> assocs = null;
if (association != null)
{
assocs = nodeService.getTargetAssocs(nodeRef, RegexQNamePattern.MATCH_ALL);
}
else
{
QNamePattern name = RegexQNamePattern.MATCH_ALL;
String assocType = association.getAssociationType();
if (assocType != null)
{
name = QName.createQName(assocType);
}
if ("source".equals(association.getDirection()) == true)
{
assocs = nodeService.getSourceAssocs(nodeRef, name);
}
else
{
assocs = nodeService.getTargetAssocs(nodeRef, name);
}
}
int totalRows = assocs.size();
int lastRow = calculateLastRowIndex(totalRows);
int currentBatchSize = lastRow - this.position;
if (logger.isDebugEnabled())
logger.debug("Total rows = " + totalRows
+ ", current batch size = " + currentBatchSize);
org.alfresco.repo.webservice.types.ResultSet batchResults = new org.alfresco.repo.webservice.types.ResultSet();
org.alfresco.repo.webservice.types.ResultSetRow[] rows = new org.alfresco.repo.webservice.types.ResultSetRow[currentBatchSize];
int arrPos = 0;
for (int x = this.position; x < lastRow; x++)
{
AssociationRef assoc = assocs.get(x);
NodeRef childNodeRef = assoc.getTargetRef();
ResultSetRowNode rowNode = createResultSetRowNode(childNodeRef, nodeService);
// create columns for all the properties of the node
// get the data for the row and build up the columns structure
Map<QName, Serializable> props = nodeService
.getProperties(childNodeRef);
NamedValue[] columns = new NamedValue[props.size()+2];
int col = 0;
for (QName propName : props.keySet())
{
columns[col] = Utils.createNamedValue(dictionaryService, propName, props.get(propName));
col++;
}
// Now add the system columns containing the association details
columns[col] = new NamedValue(SYS_COL_ASSOC_TYPE, Boolean.FALSE, assoc.getTypeQName().toString(), null);
// Add one more column for the node's path
col++;
columns[col] = Utils.createNamedValue(dictionaryService, QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "path"), nodeService.getPath(childNodeRef).toString());
ResultSetRow row = new ResultSetRow();
row.setRowIndex(x);
row.setNode(rowNode);
row.setColumns(columns);
// add the row to the overall results
rows[arrPos] = row;
arrPos++;
}
// add the rows to the result set and set the total row count
batchResults.setRows(rows);
batchResults.setTotalRowCount(totalRows);
queryResult = new QueryResult(getId(), batchResults);
// move the position on
updatePosition(totalRows, queryResult);
if (logger.isDebugEnabled())
logger.debug("After getNextResultsBatch: " + toString());
}
return queryResult;
}
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString()
{
StringBuilder builder = new StringBuilder(super.toString());
builder.append(" (id=").append(getId());
builder.append(" batchSize=").append(this.batchSize);
builder.append(" position=").append(this.position);
builder.append(" node-id=").append(this.node.getUuid()).append(")");
return builder.toString();
}
}

168
source/java/org/alfresco/repo/webservice/repository/AssociationQuery.java Normal file
View File

@@ -0,0 +1,168 @@
/*
* 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.webservice.repository;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import org.alfresco.repo.webservice.AbstractQuery;
import org.alfresco.repo.webservice.Utils;
import org.alfresco.repo.webservice.types.NamedValue;
import org.alfresco.repo.webservice.types.Reference;
import org.alfresco.repo.webservice.types.ResultSet;
import org.alfresco.repo.webservice.types.ResultSetRow;
import org.alfresco.repo.webservice.types.ResultSetRowNode;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.dictionary.DictionaryService;
import org.alfresco.service.cmr.repository.AssociationRef;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.search.SearchService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.alfresco.service.namespace.QNamePattern;
import org.alfresco.service.namespace.RegexQNamePattern;
/**
* A query to retrieve normal node associations.
*
* @author Derek Hulley
* @since 2.1
*/
public class AssociationQuery extends AbstractQuery<ResultSet>
{
private static final long serialVersionUID = -672399618512462040L;
private Reference node;
private Association association;
/**
* @param node
* The node to query against
* @param association
* The association type to query or <tt>null</tt> to query all
*/
public AssociationQuery(Reference node, Association association)
{
this.node = node;
this.association = association;
}
@Override
public String toString()
{
StringBuilder sb = new StringBuilder(128);
sb.append("AssociationQuery")
.append("[ node=").append(node.getUuid())
.append(", association=").append(association)
.append("]");
return sb.toString();
}
/**
* {@inheritDoc}
*/
public ResultSet execute(ServiceRegistry serviceRegistry)
{
SearchService searchService = serviceRegistry.getSearchService();
NodeService nodeService = serviceRegistry.getNodeService();
DictionaryService dictionaryService = serviceRegistry.getDictionaryService();
NamespaceService namespaceService = serviceRegistry.getNamespaceService();
// create the node ref and get the children from the repository
NodeRef nodeRef = Utils.convertToNodeRef(node, nodeService, searchService, namespaceService);
List<AssociationRef> assocRefs = null;
if (association != null)
{
assocRefs = nodeService.getTargetAssocs(nodeRef, RegexQNamePattern.MATCH_ALL);
}
else
{
QNamePattern name = RegexQNamePattern.MATCH_ALL;
String assocType = association.getAssociationType();
if (assocType != null)
{
name = QName.createQName(assocType);
}
if ("source".equals(association.getDirection()) == true)
{
assocRefs = nodeService.getSourceAssocs(nodeRef, name);
}
else
{
assocRefs = nodeService.getTargetAssocs(nodeRef, name);
}
}
int totalRows = assocRefs.size();
ResultSet results = new ResultSet();
ResultSetRow[] rows = new ResultSetRow[totalRows];
int index = 0;
for (AssociationRef assocRef : assocRefs)
{
NodeRef childNodeRef = assocRef.getTargetRef();
ResultSetRowNode rowNode = createResultSetRowNode(childNodeRef, nodeService);
// create columns for all the properties of the node
// get the data for the row and build up the columns structure
Map<QName, Serializable> props = nodeService.getProperties(childNodeRef);
NamedValue[] columns = new NamedValue[props.size()+2];
int col = 0;
for (QName propName : props.keySet())
{
columns[col] = Utils.createNamedValue(dictionaryService, propName, props.get(propName));
col++;
}
// Now add the system columns containing the association details
columns[col] = new NamedValue(SYS_COL_ASSOC_TYPE, Boolean.FALSE, assocRef.getTypeQName().toString(), null);
// Add one more column for the node's path
col++;
columns[col] = Utils.createNamedValue(
dictionaryService,
QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "path"),
nodeService.getPath(childNodeRef).toString());
ResultSetRow row = new ResultSetRow();
row.setRowIndex(index);
row.setNode(rowNode);
row.setColumns(columns);
// add the row to the overall results
rows[index] = row;
index++;
}
// add the rows to the result set and set the total row count
results.setRows(rows);
results.setTotalRowCount(totalRows);
return results;
}
}

146
source/java/org/alfresco/repo/webservice/repository/ChildAssociationQuery.java Normal file
View File

@@ -0,0 +1,146 @@
/*
* 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.webservice.repository;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import org.alfresco.repo.webservice.AbstractQuery;
import org.alfresco.repo.webservice.Utils;
import org.alfresco.repo.webservice.types.NamedValue;
import org.alfresco.repo.webservice.types.Reference;
import org.alfresco.repo.webservice.types.ResultSet;
import org.alfresco.repo.webservice.types.ResultSetRow;
import org.alfresco.repo.webservice.types.ResultSetRowNode;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.dictionary.DictionaryService;
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.search.SearchService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
/**
* A query to retrieve all child associations on a node.
*
* @author Derek Hulley
* @since 2.1
*/
public class ChildAssociationQuery extends AbstractQuery<ResultSet>
{
private static final long serialVersionUID = -4965097420552826582L;
private Reference node;
/**
* @param node
* The node to query against
*/
public ChildAssociationQuery(Reference node)
{
this.node = node;
}
@Override
public String toString()
{
StringBuilder sb = new StringBuilder(128);
sb.append("ChildAssociationQuery")
.append("[ node=").append(node.getUuid())
.append("]");
return sb.toString();
}
/**
* {@inheritDoc}
*/
public ResultSet execute(ServiceRegistry serviceRegistry)
{
SearchService searchService = serviceRegistry.getSearchService();
NodeService nodeService = serviceRegistry.getNodeService();
DictionaryService dictionaryService = serviceRegistry.getDictionaryService();
NamespaceService namespaceService = serviceRegistry.getNamespaceService();
// create the node ref and get the children from the repository
NodeRef nodeRef = Utils.convertToNodeRef(node, nodeService, searchService, namespaceService);
List<ChildAssociationRef> assocRefs = nodeService.getChildAssocs(nodeRef);
int totalRows = assocRefs.size();
ResultSet results = new ResultSet();
ResultSetRow[] rows = new ResultSetRow[totalRows];
int index = 0;
for (ChildAssociationRef assocRef : assocRefs)
{
NodeRef childNodeRef = assocRef.getChildRef();
ResultSetRowNode rowNode = createResultSetRowNode(childNodeRef, nodeService);
// create columns for all the properties of the node
// get the data for the row and build up the columns structure
Map<QName, Serializable> props = nodeService.getProperties(childNodeRef);
NamedValue[] columns = new NamedValue[props.size()+5];
int col = 0;
for (QName propName : props.keySet())
{
columns[col] = Utils.createNamedValue(dictionaryService, propName, props.get(propName));
col++;
}
// Now add the system columns containing the association details
columns[col] = new NamedValue(SYS_COL_ASSOC_TYPE, Boolean.FALSE, assocRef.getTypeQName().toString(), null);
col++;
columns[col] = new NamedValue(SYS_COL_ASSOC_NAME, Boolean.FALSE, assocRef.getQName().toString(), null);
col++;
columns[col] = new NamedValue(SYS_COL_IS_PRIMARY, Boolean.FALSE, Boolean.toString(assocRef.isPrimary()), null);
col++;
columns[col] = new NamedValue(SYS_COL_NTH_SIBLING, Boolean.FALSE, Integer.toString(assocRef.getNthSibling()), null);
// Add one more column for the node's path
col++;
columns[col] = Utils.createNamedValue(
dictionaryService,
QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "path"),
nodeService.getPath(childNodeRef).toString());
ResultSetRow row = new ResultSetRow();
row.setRowIndex(index);
row.setNode(rowNode);
row.setColumns(columns);
// add the row to the overall results
rows[index] = row;
index++;
}
// add the rows to the result set and set the total row count
results.setRows(rows);
results.setTotalRowCount(totalRows);
return results;
}
}

168
source/java/org/alfresco/repo/webservice/repository/ChildrenQuerySession.java
View File

@@ -1,168 +0,0 @@
/*
* 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.webservice.repository;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import org.alfresco.repo.webservice.Utils;
import org.alfresco.repo.webservice.types.NamedValue;
import org.alfresco.repo.webservice.types.Reference;
import org.alfresco.repo.webservice.types.ResultSetRow;
import org.alfresco.repo.webservice.types.ResultSetRowNode;
import org.alfresco.service.cmr.dictionary.DictionaryService;
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.search.SearchService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Implementation of a QuerySession that stores the results from a query for children
*
* @author gavinc
*/
public class ChildrenQuerySession extends AbstractQuerySession
{
private static final long serialVersionUID = -5347036309571057074L;
private transient static Log logger = LogFactory.getLog(ChildrenQuerySession.class);
private Reference node;
/**
* Constructs a ChildrenQuerySession
*
* @param batchSize The batch size to use for this session
* @param node The node to retrieve the parents
*/
public ChildrenQuerySession(int batchSize, Reference node)
{
super(batchSize);
this.node = node;
}
/**
* @see org.alfresco.repo.webservice.repository.QuerySession#getNextResultsBatch(org.alfresco.service.cmr.search.SearchService, org.alfresco.service.cmr.repository.NodeService, org.alfresco.service.namespace.NamespaceService)
*/
public QueryResult getNextResultsBatch(SearchService searchService, NodeService nodeService, NamespaceService namespaceService, DictionaryService dictionaryService)
{
QueryResult queryResult = null;
if (this.position != -1)
{
if (logger.isDebugEnabled())
logger.debug("Before getNextResultsBatch: " + toString());
// create the node ref and get the children from the repository
NodeRef nodeRef = Utils.convertToNodeRef(this.node, nodeService, searchService, namespaceService);
List<ChildAssociationRef> kids = nodeService.getChildAssocs(nodeRef);
int totalRows = kids.size();
int lastRow = calculateLastRowIndex(totalRows);
int currentBatchSize = lastRow - this.position;
if (logger.isDebugEnabled())
logger.debug("Total rows = " + totalRows + ", current batch size = " + currentBatchSize);
org.alfresco.repo.webservice.types.ResultSet batchResults = new org.alfresco.repo.webservice.types.ResultSet();
org.alfresco.repo.webservice.types.ResultSetRow[] rows = new org.alfresco.repo.webservice.types.ResultSetRow[currentBatchSize];
int arrPos = 0;
for (int x = this.position; x < lastRow; x++)
{
ChildAssociationRef assoc = kids.get(x);
NodeRef childNodeRef = assoc.getChildRef();
ResultSetRowNode rowNode = createResultSetRowNode(childNodeRef, nodeService);
// create columns for all the properties of the node
// get the data for the row and build up the columns structure
Map<QName, Serializable> props = nodeService.getProperties(childNodeRef);
NamedValue[] columns = new NamedValue[props.size()+5];
int col = 0;
for (QName propName : props.keySet())
{
columns[col] = Utils.createNamedValue(dictionaryService, propName, props.get(propName));
col++;
}
// Now add the system columns containing the association details
columns[col] = new NamedValue(SYS_COL_ASSOC_TYPE, Boolean.FALSE, assoc.getTypeQName().toString(), null);
col++;
columns[col] = new NamedValue(SYS_COL_ASSOC_NAME, Boolean.FALSE, assoc.getQName().toString(), null);
col++;
columns[col] = new NamedValue(SYS_COL_IS_PRIMARY, Boolean.FALSE, Boolean.toString(assoc.isPrimary()), null);
col++;
columns[col] = new NamedValue(SYS_COL_NTH_SIBLING, Boolean.FALSE, Integer.toString(assoc.getNthSibling()), null);
// Add one more column for the node's path
col++;
columns[col] = Utils.createNamedValue(dictionaryService, QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "path"), nodeService.getPath(childNodeRef).toString());
ResultSetRow row = new ResultSetRow();
row.setRowIndex(x);
row.setNode(rowNode);
row.setColumns(columns);
// add the row to the overall results
rows[arrPos] = row;
arrPos++;
}
// add the rows to the result set and set the total row count
batchResults.setRows(rows);
batchResults.setTotalRowCount(totalRows);
queryResult = new QueryResult(getId(), batchResults);
// move the position on
updatePosition(totalRows, queryResult);
if (logger.isDebugEnabled())
logger.debug("After getNextResultsBatch: " + toString());
}
return queryResult;
}
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString()
{
StringBuilder builder = new StringBuilder(super.toString());
builder.append(" (id=").append(getId());
builder.append(" batchSize=").append(this.batchSize);
builder.append(" position=").append(this.position);
builder.append(" node-id=").append(this.node.getUuid()).append(")");
return builder.toString();
}
}

146
source/java/org/alfresco/repo/webservice/repository/ParentAssociationQuery.java Normal file
View File

@@ -0,0 +1,146 @@
/*
* 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.webservice.repository;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import org.alfresco.repo.webservice.AbstractQuery;
import org.alfresco.repo.webservice.Utils;
import org.alfresco.repo.webservice.types.NamedValue;
import org.alfresco.repo.webservice.types.Reference;
import org.alfresco.repo.webservice.types.ResultSet;
import org.alfresco.repo.webservice.types.ResultSetRow;
import org.alfresco.repo.webservice.types.ResultSetRowNode;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.dictionary.DictionaryService;
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.search.SearchService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
/**
* A query to retrieve all parent associations on a node.
*
* @author Derek Hulley
* @since 2.1
*/
public class ParentAssociationQuery extends AbstractQuery<ResultSet>
{
private static final long serialVersionUID = -4157476722256947274L;
private Reference node;
/**
* @param node
* The node to query against
*/
public ParentAssociationQuery(Reference node)
{
this.node = node;
}
@Override
public String toString()
{
StringBuilder sb = new StringBuilder(128);
sb.append("ParentAssociationQuery")
.append("[ node=").append(node.getUuid())
.append("]");
return sb.toString();
}
/**
* {@inheritDoc}
*/
public ResultSet execute(ServiceRegistry serviceRegistry)
{
SearchService searchService = serviceRegistry.getSearchService();
NodeService nodeService = serviceRegistry.getNodeService();
DictionaryService dictionaryService = serviceRegistry.getDictionaryService();
NamespaceService namespaceService = serviceRegistry.getNamespaceService();
// create the node ref and get the parent from the repository
NodeRef nodeRef = Utils.convertToNodeRef(node, nodeService, searchService, namespaceService);
List<ChildAssociationRef> assocRefs = nodeService.getParentAssocs(nodeRef);
int totalRows = assocRefs.size();
ResultSet results = new ResultSet();
ResultSetRow[] rows = new ResultSetRow[totalRows];
int index = 0;
for (ChildAssociationRef assocRef : assocRefs)
{
NodeRef parentNodeRef = assocRef.getParentRef();
ResultSetRowNode rowNode = createResultSetRowNode(parentNodeRef, nodeService);
// create columns for all the properties of the node
// get the data for the row and build up the columns structure
Map<QName, Serializable> props = nodeService.getProperties(parentNodeRef);
NamedValue[] columns = new NamedValue[props.size()+5];
int col = 0;
for (QName propName : props.keySet())
{
columns[col] = Utils.createNamedValue(dictionaryService, propName, props.get(propName));
col++;
}
// Now add the system columns containing the association details
columns[col] = new NamedValue(SYS_COL_ASSOC_TYPE, Boolean.FALSE, assocRef.getTypeQName().toString(), null);
col++;
columns[col] = new NamedValue(SYS_COL_ASSOC_NAME, Boolean.FALSE, assocRef.getQName().toString(), null);
col++;
columns[col] = new NamedValue(SYS_COL_IS_PRIMARY, Boolean.FALSE, Boolean.toString(assocRef.isPrimary()), null);
col++;
columns[col] = new NamedValue(SYS_COL_NTH_SIBLING, Boolean.FALSE, Integer.toString(assocRef.getNthSibling()), null);
// Add one more column for the node's path
col++;
columns[col] = Utils.createNamedValue(
dictionaryService,
QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "path"),
nodeService.getPath(parentNodeRef).toString());
ResultSetRow row = new ResultSetRow();
row.setRowIndex(index);
row.setNode(rowNode);
row.setColumns(columns);
// add the row to the overall results
rows[index] = row;
index++;
}
// add the rows to the result set and set the total row count
results.setRows(rows);
results.setTotalRowCount(totalRows);
return results;
}
}

167
source/java/org/alfresco/repo/webservice/repository/ParentsQuerySession.java
View File

@@ -1,167 +0,0 @@
/*
* 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.webservice.repository;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
import org.alfresco.repo.webservice.Utils;
import org.alfresco.repo.webservice.types.NamedValue;
import org.alfresco.repo.webservice.types.Reference;
import org.alfresco.repo.webservice.types.ResultSetRow;
import org.alfresco.repo.webservice.types.ResultSetRowNode;
import org.alfresco.service.cmr.dictionary.DictionaryService;
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.search.SearchService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Implementation of a QuerySession that stores the results from a query for parents
*
* @author gavinc
*/
public class ParentsQuerySession extends AbstractQuerySession
{
private static final long serialVersionUID = 2539375863409175463L;
private transient static Log logger = LogFactory.getLog(ParentsQuerySession.class);
private Reference node;
/**
* Constructs a ParentsQuerySession
*
* @param batchSize The batch size to use for this session
* @param node The node to retrieve the parents
*/
public ParentsQuerySession(int batchSize, Reference node)
{
super(batchSize);
this.node = node;
}
/**
* @see org.alfresco.repo.webservice.repository.QuerySession#getNextResultsBatch(org.alfresco.service.cmr.search.SearchService, org.alfresco.service.cmr.repository.NodeService, org.alfresco.service.namespace.NamespaceService)
*/
public QueryResult getNextResultsBatch(SearchService searchService, NodeService nodeService, NamespaceService namespaceService, DictionaryService dictionaryService)
{
QueryResult queryResult = null;
if (this.position != -1)
{
if (logger.isDebugEnabled())
logger.debug("Before getNextResultsBatch: " + toString());
// create the node ref and get the children from the repository
NodeRef nodeRef = Utils.convertToNodeRef(this.node, nodeService, searchService, namespaceService);
List<ChildAssociationRef> parents = nodeService.getParentAssocs(nodeRef);
int totalRows = parents.size();
int lastRow = calculateLastRowIndex(totalRows);
int currentBatchSize = lastRow - this.position;
if (logger.isDebugEnabled())
logger.debug("Total rows = " + totalRows + ", current batch size = " + currentBatchSize);
org.alfresco.repo.webservice.types.ResultSet batchResults = new org.alfresco.repo.webservice.types.ResultSet();
org.alfresco.repo.webservice.types.ResultSetRow[] rows = new org.alfresco.repo.webservice.types.ResultSetRow[currentBatchSize];
int arrPos = 0;
for (int x = this.position; x < lastRow; x++)
{
ChildAssociationRef assoc = parents.get(x);
NodeRef parentNodeRef = assoc.getParentRef();
ResultSetRowNode rowNode = createResultSetRowNode(parentNodeRef, nodeService);
// create columns for all the properties of the node
// get the data for the row and build up the columns structure
Map<QName, Serializable> props = nodeService.getProperties(parentNodeRef);
NamedValue[] columns = new NamedValue[props.size()+5];
int col = 0;
for (QName propName : props.keySet())
{
columns[col] = Utils.createNamedValue(dictionaryService, propName, props.get(propName));
col++;
}
// Now add the system columns containing the association details
columns[col] = new NamedValue(SYS_COL_ASSOC_TYPE, Boolean.FALSE, assoc.getTypeQName().toString(), null);
col++;
columns[col] = new NamedValue(SYS_COL_ASSOC_NAME, Boolean.FALSE, assoc.getQName().toString(), null);
col++;
columns[col] = new NamedValue(SYS_COL_IS_PRIMARY, Boolean.FALSE, Boolean.toString(assoc.isPrimary()), null);
col++;
columns[col] = new NamedValue(SYS_COL_NTH_SIBLING, Boolean.FALSE, Integer.toString(assoc.getNthSibling()), null);
// Add one more column for the node's path
col++;
columns[col] = Utils.createNamedValue(dictionaryService, QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "path"), nodeService.getPath(parentNodeRef).toString());
ResultSetRow row = new ResultSetRow();
row.setRowIndex(x);
row.setNode(rowNode);
row.setColumns(columns);
// add the row to the overall results
rows[arrPos] = row;
arrPos++;
}
// add the rows to the result set and set the total row count
batchResults.setRows(rows);
batchResults.setTotalRowCount(totalRows);
queryResult = new QueryResult(getId(), batchResults);
// move the position on
updatePosition(totalRows, queryResult);
if (logger.isDebugEnabled())
logger.debug("After getNextResultsBatch: " + toString());
}
return queryResult;
}
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString()
{
StringBuilder builder = new StringBuilder(super.toString());
builder.append(" (id=").append(getId());
builder.append(" batchSize=").append(this.batchSize);
builder.append(" position=").append(this.position);
builder.append(" node-id=").append(this.node.getUuid()).append(")");
return builder.toString();
}
}

68
source/java/org/alfresco/repo/webservice/repository/RepositoryQuerySession.java Normal file
View File

@@ -0,0 +1,68 @@
/*
* 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.webservice.repository;
import org.alfresco.repo.webservice.AbstractQuerySession;
import org.alfresco.repo.webservice.ServerQuery;
import org.alfresco.repo.webservice.types.ResultSet;
import org.alfresco.repo.webservice.types.ResultSetRow;
import org.alfresco.service.ServiceRegistry;
/**
* A query session for use with {@linkplain RepositoryWebService node-related queries} against the
* repository.
*
* @author Derek Hulley
* @since 2.1
*/
public class RepositoryQuerySession extends AbstractQuerySession<ResultSet, ResultSetRow>
{
private static final long serialVersionUID = -3621997639261137000L;
public RepositoryQuerySession(long maxResults, long batchSize, ServerQuery<ResultSet> query)
{
super(maxResults, batchSize, query);
}
@Override
protected ResultSetRow[] makeArray(int size)
{
return new ResultSetRow[size];
}
public ResultSet getNextResults(ServiceRegistry serviceRegistry)
{
ResultSet queryResults = getQueryResults(serviceRegistry);
ResultSetRow[] allRows = queryResults.getRows();
ResultSetRow[] batchedRows = getNextResults(allRows);
// Build the resultset for the batched results
ResultSet batchedResults = new ResultSet();
batchedResults.setMetaData(queryResults.getMetaData());
batchedResults.setRows(batchedRows);
batchedResults.setTotalRowCount(batchedRows.length);
// Done
return batchedResults;
}
}

303
source/java/org/alfresco/repo/webservice/repository/RepositoryWebService.java
View File

@@ -31,10 +31,10 @@ import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import org.alfresco.repo.cache.SimpleCache;
import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback; import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
import org.alfresco.repo.webservice.AbstractWebService; import org.alfresco.repo.webservice.AbstractWebService;
import org.alfresco.repo.webservice.CMLUtil; import org.alfresco.repo.webservice.CMLUtil;
import org.alfresco.repo.webservice.ServerQuery;
import org.alfresco.repo.webservice.Utils; import org.alfresco.repo.webservice.Utils;
import org.alfresco.repo.webservice.types.CML; import org.alfresco.repo.webservice.types.CML;
import org.alfresco.repo.webservice.types.ClassDefinition; import org.alfresco.repo.webservice.types.ClassDefinition;
@@ -44,9 +44,9 @@ import org.alfresco.repo.webservice.types.NodeDefinition;
import org.alfresco.repo.webservice.types.Predicate; import org.alfresco.repo.webservice.types.Predicate;
import org.alfresco.repo.webservice.types.Query; import org.alfresco.repo.webservice.types.Query;
import org.alfresco.repo.webservice.types.Reference; import org.alfresco.repo.webservice.types.Reference;
import org.alfresco.repo.webservice.types.ResultSet;
import org.alfresco.repo.webservice.types.Store; import org.alfresco.repo.webservice.types.Store;
import org.alfresco.service.cmr.dictionary.AspectDefinition; import org.alfresco.service.cmr.dictionary.AspectDefinition;
import org.alfresco.service.cmr.dictionary.DictionaryService;
import org.alfresco.service.cmr.dictionary.TypeDefinition; import org.alfresco.service.cmr.dictionary.TypeDefinition;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.StoreRef; import org.alfresco.service.cmr.repository.StoreRef;
@@ -67,23 +67,8 @@ public class RepositoryWebService extends AbstractWebService implements
{ {
private static Log logger = LogFactory.getLog(RepositoryWebService.class); private static Log logger = LogFactory.getLog(RepositoryWebService.class);
private DictionaryService dictionaryService;
private CMLUtil cmlUtil; private CMLUtil cmlUtil;
private SimpleCache<String, QuerySession> querySessionCache;
/**
* Sets the instance of the DictionaryService to be used
*
* @param dictionaryService
* The DictionaryService
*/
public void setDictionaryService(DictionaryService dictionaryService)
{
this.dictionaryService = dictionaryService;
}
/** /**
* Sets the CML Util * Sets the CML Util
* *
@@ -94,18 +79,6 @@ public class RepositoryWebService extends AbstractWebService implements
this.cmlUtil = cmlUtil; this.cmlUtil = cmlUtil;
} }
/**
* Sets the instance of the SimpleCache to be used
*
* @param querySessionCache
* The SimpleCache
*/
public void setQuerySessionCache(
SimpleCache<String, QuerySession> querySessionCache)
{
this.querySessionCache = querySessionCache;
}
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
@@ -156,11 +129,58 @@ public class RepositoryWebService extends AbstractWebService implements
} }
} }
/**
* Executes the given query, caching the results as required.
*/
private QueryResult executeQuery(final MessageContext msgContext, final ServerQuery<ResultSet> query) throws RepositoryFault
{
try
{
RetryingTransactionCallback<QueryResult> callback = new RetryingTransactionCallback<QueryResult>()
{
public QueryResult execute() throws Throwable
{
// Construct a session to handle the iteration
long batchSize = Utils.getBatchSize(msgContext);
RepositoryQuerySession session = new RepositoryQuerySession(Long.MAX_VALUE, batchSize, query);
String sessionId = session.getId();
// Get the first batch of results
ResultSet batchedResults = session.getNextResults(serviceRegistry);
// Construct the result
// TODO: http://issues.alfresco.com/browse/AR-1689
boolean haveMoreResults = session.haveMoreResults();
QueryResult queryResult = new QueryResult(
haveMoreResults ? sessionId : null,
batchedResults);
// Cache the session
if (session.haveMoreResults())
{
querySessionCache.put(sessionId, session);
}
// Done
return queryResult;
}
};
return Utils.getRetryingTransactionHelper(MessageContext.getCurrentContext()).doInTransaction(callback, true);
}
catch (Throwable e)
{
if (logger.isDebugEnabled())
{
logger.error("Unexpected error occurred", e);
}
e.printStackTrace();
throw new RepositoryFault(0, e.toString());
}
}
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
public QueryResult query(final Store store, final Query query, final boolean includeMetaData) public QueryResult query(final Store store, final Query query, final boolean includeMetaData) throws RemoteException, RepositoryFault
throws RemoteException, RepositoryFault
{ {
String language = query.getLanguage(); String language = query.getLanguage();
if (language.equals(Utils.QUERY_LANG_LUCENE) == false) if (language.equals(Utils.QUERY_LANG_LUCENE) == false)
@@ -171,131 +191,52 @@ public class RepositoryWebService extends AbstractWebService implements
} }
final MessageContext msgContext = MessageContext.getCurrentContext(); final MessageContext msgContext = MessageContext.getCurrentContext();
try SearchQuery serverQuery = new SearchQuery(store, query);
{ QueryResult queryResult = executeQuery(msgContext, serverQuery);
RetryingTransactionCallback<QueryResult> callback = new RetryingTransactionCallback<QueryResult>() // Done
{ return queryResult;
public QueryResult execute() throws Throwable
{
// setup a query session and get the first batch of results
QuerySession querySession = new ResultSetQuerySession(Utils
.getBatchSize(msgContext), store, query, includeMetaData);
QueryResult queryResult = querySession
.getNextResultsBatch(searchService, nodeService, namespaceService, dictionaryService);
// add the session to the cache if there are more results to come
if (queryResult.getQuerySession() != null)
{
// this.querySessionCache.putQuerySession(querySession);
querySessionCache.put(queryResult.getQuerySession(), querySession);
}
return queryResult;
}
};
return Utils.getRetryingTransactionHelper(MessageContext.getCurrentContext()).doInTransaction(callback);
}
catch (Throwable e)
{
if (logger.isDebugEnabled())
{
logger.error("Unexpected error occurred", e);
}
e.printStackTrace();
throw new RepositoryFault(0, e.toString());
}
} }
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
public QueryResult queryChildren(final Reference node) throws RemoteException, public QueryResult queryChildren(final Reference node) throws RemoteException, RepositoryFault
RepositoryFault
{ {
try final MessageContext msgContext = MessageContext.getCurrentContext();
{ ChildAssociationQuery query = new ChildAssociationQuery(node);
RetryingTransactionCallback<QueryResult> callback = new RetryingTransactionCallback<QueryResult>() QueryResult queryResult = executeQuery(msgContext, query);
{ // Done
public QueryResult execute() throws Throwable return queryResult;
{
// setup a query session and get the first batch of results
QuerySession querySession = new ChildrenQuerySession(Utils
.getBatchSize(MessageContext.getCurrentContext()), node);
QueryResult queryResult = querySession
.getNextResultsBatch(searchService, nodeService, namespaceService, dictionaryService);
// add the session to the cache if there are more results to come
if (queryResult.getQuerySession() != null)
{
querySessionCache.put(queryResult.getQuerySession(), querySession);
}
if (logger.isDebugEnabled())
{
logger.debug("Method end ... queryChildren");
}
return queryResult;
}
};
return Utils.getRetryingTransactionHelper(MessageContext.getCurrentContext()).doInTransaction(callback);
}
catch (Throwable e)
{
if (logger.isDebugEnabled())
{
logger.error("Unexpected error occurred", e);
}
e.printStackTrace();
throw new RepositoryFault(0, e.toString());
}
} }
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
public QueryResult queryParents(final Reference node) throws RemoteException, RepositoryFault public QueryResult queryParents(final Reference node) throws RemoteException, RepositoryFault
{ {
try final MessageContext msgContext = MessageContext.getCurrentContext();
{ ParentAssociationQuery query = new ParentAssociationQuery(node);
RetryingTransactionCallback<QueryResult> callback = new RetryingTransactionCallback<QueryResult>() QueryResult queryResult = executeQuery(msgContext, query);
{ // Done
public QueryResult execute() throws Throwable return queryResult;
{
// setup a query session and get the first batch of results
QuerySession querySession = new ParentsQuerySession(Utils
.getBatchSize(MessageContext.getCurrentContext()), node);
QueryResult queryResult = querySession.getNextResultsBatch(
searchService, nodeService, namespaceService, dictionaryService);
// add the session to the cache if there are more results to come
if (queryResult.getQuerySession() != null)
{
// this.querySessionCache.putQuerySession(querySession);
querySessionCache.put(queryResult.getQuerySession(), querySession);
}
return queryResult;
}
};
return Utils.getRetryingTransactionHelper(MessageContext.getCurrentContext()).doInTransaction(callback);
}
catch (Throwable e)
{
if (logger.isDebugEnabled())
{
logger.error("Unexpected error occurred", e);
}
throw new RepositoryFault(0, e.toString());
}
} }
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
public QueryResult queryAssociated(final Reference node, final Association association) public QueryResult queryAssociated(final Reference node, final Association association) throws RemoteException, RepositoryFault
throws RemoteException, RepositoryFault {
final MessageContext msgContext = MessageContext.getCurrentContext();
AssociationQuery query = new AssociationQuery(node, association);
QueryResult queryResult = executeQuery(msgContext, query);
// Done
return queryResult;
}
/**
* {@inheritDoc}
*/
public QueryResult fetchMore(final String querySessionId) throws RemoteException, RepositoryFault
{ {
try try
{ {
@@ -303,76 +244,54 @@ public class RepositoryWebService extends AbstractWebService implements
{ {
public QueryResult execute() throws Throwable public QueryResult execute() throws Throwable
{ {
// setup a query session and get the first batch of results RepositoryQuerySession session = null;
QuerySession querySession = new AssociatedQuerySession(Utils.getBatchSize(MessageContext.getCurrentContext()), node, association); try
QueryResult queryResult = querySession.getNextResultsBatch(searchService, nodeService, namespaceService, dictionaryService);
// add the session to the cache if there are more results to come
if (queryResult.getQuerySession() != null)
{ {
// this.querySessionCache.putQuerySession(querySession); // try and get the QuerySession with the given id from the cache
querySessionCache.put(queryResult.getQuerySession(), querySession); session = (RepositoryQuerySession) querySessionCache.get(querySessionId);
}
catch (ClassCastException e)
{
if (logger.isDebugEnabled())
{
logger.debug("Query session was not generated by the RepositoryWebService: " + querySessionId);
}
throw new RepositoryFault(
4,
"querySession with id '" + querySessionId + "' is invalid");
} }
return queryResult;
}
};
return Utils.getRetryingTransactionHelper(MessageContext.getCurrentContext()).doInTransaction(callback);
}
catch (Throwable e)
{
if (logger.isDebugEnabled())
{
logger.error("Unexpected error occurred", e);
}
throw new RepositoryFault(0, e.toString());
}
}
/**
* {@inheritDoc}
*/
public QueryResult fetchMore(final String querySession) throws RemoteException, RepositoryFault
{
try
{
RetryingTransactionCallback<QueryResult> callback = new RetryingTransactionCallback<QueryResult>()
{
public QueryResult execute() throws Throwable
{
// try and get the QuerySession with the given id from the cache
QuerySession session = querySessionCache.get(querySession);
if (session == null) if (session == null)
{ {
if (logger.isDebugEnabled()) if (logger.isDebugEnabled())
{ {
logger.debug("Invalid querySession id requested: " + querySession); logger.debug("Invalid querySession id requested: " + querySessionId);
} }
throw new RepositoryFault( throw new RepositoryFault(
4, 4,
"querySession with id '" + querySession + "' is invalid"); "querySession with id '" + querySessionId + "' is invalid");
}
ResultSet moreResults = session.getNextResults(serviceRegistry);
// Drop the cache results if there are no more results expected
if (!session.haveMoreResults())
{
querySessionCache.remove(querySessionId);
} }
// get the next batch of results // get the next batch of results
QueryResult queryResult = session.getNextResultsBatch( // TODO: http://issues.alfresco.com/browse/AR-1689
searchService, boolean haveMoreResults = session.haveMoreResults();
nodeService, QueryResult queryResult = new QueryResult(
namespaceService, haveMoreResults ? querySessionId : null,
dictionaryService); moreResults);
// remove the QuerySession from the cache if there are no more
// results to come
if (queryResult.getQuerySession() == null)
{
querySessionCache.remove(querySession);
}
// Done
return queryResult; return queryResult;
} }
}; };
return Utils.getRetryingTransactionHelper(MessageContext.getCurrentContext()).doInTransaction(callback); return Utils.getRetryingTransactionHelper(MessageContext.getCurrentContext()).doInTransaction(callback, true);
} }
catch (Throwable e) catch (Throwable e)
{ {

208
source/java/org/alfresco/repo/webservice/repository/ResultSetQuerySession.java
View File

@@ -1,208 +0,0 @@
/*
* 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.webservice.repository;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import org.alfresco.repo.webservice.Utils;
import org.alfresco.repo.webservice.types.NamedValue;
import org.alfresco.repo.webservice.types.Query;
import org.alfresco.repo.webservice.types.ResultSetRowNode;
import org.alfresco.repo.webservice.types.Store;
import org.alfresco.service.cmr.dictionary.DictionaryService;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.Path;
import org.alfresco.service.cmr.search.ResultSet;
import org.alfresco.service.cmr.search.ResultSetRow;
import org.alfresco.service.cmr.search.SearchService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Implementation of a QuerySession that retrieves results from a repository ResultSet
*
* @author gavinc
*/
public class ResultSetQuerySession extends AbstractQuerySession
{
private static final long serialVersionUID = -9154514445963635138L;
private transient static Log logger = LogFactory.getLog(ResultSetQuerySession.class);
private Store store;
private Query query;
@SuppressWarnings("unused")
private boolean includeMetaData;
/**
* Constructs a ResultSetQuerySession
*
* @param batchSize The batch size to use for this session
* @param store The repository store to query against
* @param query The query to execute
* @param includeMetaData Whether to include metadata in the query results
*/
public ResultSetQuerySession(int batchSize, Store store, Query query, boolean includeMetaData)
{
super(batchSize);
this.store = store;
this.query = query;
this.includeMetaData = includeMetaData;
}
/**
* @see org.alfresco.repo.webservice.repository.QuerySession#getNextResultsBatch(org.alfresco.service.cmr.search.SearchService, org.alfresco.service.cmr.repository.NodeService, org.alfresco.service.namespace.NamespaceService)
*/
public QueryResult getNextResultsBatch(SearchService searchService, NodeService nodeService, NamespaceService namespaceService, DictionaryService dictionaryService)
{
QueryResult queryResult = null;
if (this.position != -1)
{
if (logger.isDebugEnabled())
logger.debug("Before getNextResultsBatch: " + toString());
// handle the special search string of * meaning, get everything
String statement = query.getStatement();
if (statement.equals("*"))
{
statement = "ISNODE:*";
}
ResultSet searchResults = null;
try
{
searchResults = searchService.query(Utils.convertToStoreRef(this.store),
this.query.getLanguage(), statement);
int totalRows = searchResults.length();
int lastRow = calculateLastRowIndex(totalRows);
int currentBatchSize = lastRow - this.position;
if (logger.isDebugEnabled())
logger.debug("Total rows = " + totalRows + ", current batch size = " + currentBatchSize);
org.alfresco.repo.webservice.types.ResultSet batchResults = new org.alfresco.repo.webservice.types.ResultSet();
List<org.alfresco.repo.webservice.types.ResultSetRow> rowList =
new ArrayList<org.alfresco.repo.webservice.types.ResultSetRow>();
for (int x = this.position; x < lastRow; x++)
{
ResultSetRow origRow = searchResults.getRow(x);
NodeRef nodeRef = origRow.getNodeRef();
// search can return nodes that no longer exist, so we need to ignore these
if(nodeService.exists(nodeRef) == false)
{
if(logger.isDebugEnabled())
{
logger.warn("Search returned node that doesn't exist: " + nodeRef);
}
continue;
}
ResultSetRowNode rowNode = createResultSetRowNode(nodeRef, nodeService);
// get the data for the row and build up the columns structure
Map<Path, Serializable> values = origRow.getValues();
NamedValue[] columns = new NamedValue[values.size() + 1];
int col = 0;
for (Path path : values.keySet())
{
// Get the attribute QName from the result path
String attributeName = path.last().toString();
if (attributeName.startsWith("@") == true)
{
attributeName = attributeName.substring(1);
}
columns[col] = Utils.createNamedValue(dictionaryService, QName.createQName(attributeName), values.get(path));
col++;
}
// add one extra column for the node's path
columns[col] = Utils.createNamedValue(dictionaryService, QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "path"), nodeService.getPath(nodeRef).toString());
org.alfresco.repo.webservice.types.ResultSetRow row = new org.alfresco.repo.webservice.types.ResultSetRow();
row.setColumns(columns);
row.setScore(origRow.getScore());
row.setRowIndex(x);
row.setNode(rowNode);
// add the row to the overall results list
rowList.add(row);
}
// TODO: build up the meta data data structure if we've been asked to
// add the rows to the result set and set the total row count
org.alfresco.repo.webservice.types.ResultSetRow[] rows =
rowList.toArray(new org.alfresco.repo.webservice.types.ResultSetRow[rowList.size()]);;
batchResults.setRows(rows);
batchResults.setTotalRowCount(totalRows);
queryResult = new QueryResult(getId(), batchResults);
// move the position on
updatePosition(totalRows, queryResult);
if (logger.isDebugEnabled())
logger.debug("After getNextResultsBatch: " + toString());
}
finally
{
if (searchResults != null)
{
searchResults.close();
}
}
}
return queryResult;
}
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString()
{
StringBuilder builder = new StringBuilder(super.toString());
builder.append(" (id=").append(getId());
builder.append(" batchSize=").append(this.batchSize);
builder.append(" position=").append(this.position);
builder.append(" store=").append(this.store.getScheme()).append(":").append(this.store.getAddress());
builder.append(" language=").append(this.query.getLanguage());
builder.append(" statement=").append(this.query.getStatement());
builder.append(")");
return builder.toString();
}
}

184
source/java/org/alfresco/repo/webservice/repository/SearchQuery.java Normal file
View File

@@ -0,0 +1,184 @@
/*
* 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.webservice.repository;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import org.alfresco.repo.webservice.AbstractQuery;
import org.alfresco.repo.webservice.Utils;
import org.alfresco.repo.webservice.types.NamedValue;
import org.alfresco.repo.webservice.types.Query;
import org.alfresco.repo.webservice.types.ResultSet;
import org.alfresco.repo.webservice.types.ResultSetRow;
import org.alfresco.repo.webservice.types.ResultSetRowNode;
import org.alfresco.repo.webservice.types.Store;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.dictionary.DictionaryService;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.Path;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.cmr.search.SearchService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
/**
* A query to using full search.
*
* @author Derek Hulley
* @since 2.1
*/
public class SearchQuery extends AbstractQuery<ResultSet>
{
private static final long serialVersionUID = 5429510102265380433L;
private Store store;
private Query query;
/**
* @param node The node to query against
* @param association The association type to query or <tt>null</tt> to query all
*/
public SearchQuery(Store store, Query query)
{
this.store = store;
this.query = query;
}
@Override
public String toString()
{
StringBuilder sb = new StringBuilder(128);
sb.append("SearchQuery")
.append("[ store=").append(this.store.getScheme()).append(":").append(this.store.getAddress())
.append(" language=").append(this.query.getLanguage())
.append(" statement=").append(this.query.getStatement())
.append("]");
return sb.toString();
}
/**
* {@inheritDoc}
*/
public ResultSet execute(ServiceRegistry serviceRegistry)
{
SearchService searchService = serviceRegistry.getSearchService();
NodeService nodeService = serviceRegistry.getNodeService();
DictionaryService dictionaryService = serviceRegistry.getDictionaryService();
// handle the special search string of * meaning, get everything
String statement = query.getStatement();
if (statement.equals("*"))
{
statement = "ISNODE:*";
}
org.alfresco.service.cmr.search.ResultSet searchResults = null;
try
{
StoreRef storeRef = Utils.convertToStoreRef(store);
searchResults = searchService.query(storeRef, query.getLanguage(), statement);
return convert(
nodeService,
dictionaryService,
searchResults);
}
finally
{
if (searchResults != null)
{
try
{
searchResults.close();
}
catch (Throwable e)
{
}
}
}
}
private ResultSet convert(
NodeService nodeService,
DictionaryService dictionaryService,
org.alfresco.service.cmr.search.ResultSet searchResults)
{
ResultSet results = new ResultSet();
List<ResultSetRow> rowsList = new ArrayList<org.alfresco.repo.webservice.types.ResultSetRow>();
int index = 0;
for (org.alfresco.service.cmr.search.ResultSetRow searchRow : searchResults)
{
NodeRef nodeRef = searchRow.getNodeRef();
// Search can return nodes that no longer exist, so we need to ignore these
if (!nodeService.exists(nodeRef))
{
continue;
}
ResultSetRowNode rowNode = createResultSetRowNode(nodeRef, nodeService);
// get the data for the row and build up the columns structure
Map<Path, Serializable> values = searchRow.getValues();
NamedValue[] columns = new NamedValue[values.size() + 1];
int col = 0;
for (Path path : values.keySet())
{
// Get the attribute QName from the result path
String attributeName = path.last().toString();
if (attributeName.startsWith("@") == true)
{
attributeName = attributeName.substring(1);
}
columns[col] = Utils.createNamedValue(dictionaryService, QName.createQName(attributeName), values.get(path));
col++;
}
// add one extra column for the node's path
columns[col] = Utils.createNamedValue(dictionaryService, QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "path"), nodeService.getPath(nodeRef).toString());
ResultSetRow row = new org.alfresco.repo.webservice.types.ResultSetRow();
row.setColumns(columns);
row.setScore(searchRow.getScore());
row.setRowIndex(index);
row.setNode(rowNode);
// add the row to the overall results list
rowsList.add(row);
index++;
}
// Convert list to array
int totalRows = rowsList.size();
ResultSetRow[] rows = rowsList.toArray(new org.alfresco.repo.webservice.types.ResultSetRow[totalRows]);
// add the rows to the result set and set the total row count
results.setRows(rows);
results.setTotalRowCount(totalRows);
return results;
}
}

32
source/java/web-services-application-context.xml
View File

@@ -10,28 +10,6 @@
</property> </property>
</bean> </bean>
<!-- Cache to use to store QuerySession instances -->
<bean id="querySessionCache" class="org.alfresco.repo.cache.EhCacheAdapter">
<property name="cache">
<bean class="org.springframework.cache.ehcache.EhCacheFactoryBean" >
<property name="cacheName">
<value>webservice.QuerySessionCache</value>
</property>
</bean>
</property>
</bean>
<!-- Cache to used to store UserQueryResults instances -->
<bean id="userQuerySessionCache" class="org.alfresco.repo.cache.EhCacheAdapter">
<property name="cache">
<bean class="org.springframework.cache.ehcache.EhCacheFactoryBean" >
<property name="cacheName">
<value>webservice.UserQuerySessionCache</value>
</property>
</bean>
</property>
</bean>
<!-- CLM Util bean --> <!-- CLM Util bean -->
<bean id="CMLUtil" class="org.alfresco.repo.webservice.CMLUtil"> <bean id="CMLUtil" class="org.alfresco.repo.webservice.CMLUtil">
<property name="nodeService"> <property name="nodeService">
@@ -63,6 +41,9 @@
</bean> </bean>
<bean id="repositoryWebService" class="org.alfresco.repo.webservice.repository.RepositoryWebService"> <bean id="repositoryWebService" class="org.alfresco.repo.webservice.repository.RepositoryWebService">
<property name="serviceRegistry">
<ref bean="ServiceRegistry"/>
</property>
<property name="nodeService"> <property name="nodeService">
<ref bean="NodeService"/> <ref bean="NodeService"/>
</property> </property>
@@ -79,7 +60,7 @@
<ref bean="DictionaryService"/> <ref bean="DictionaryService"/>
</property> </property>
<property name="querySessionCache"> <property name="querySessionCache">
<ref bean="querySessionCache"/> <ref bean="webServicesQuerySessionCache"/>
</property> </property>
<property name="cmlUtil"> <property name="cmlUtil">
<ref bean="CMLUtil"/> <ref bean="CMLUtil"/>
@@ -210,6 +191,9 @@
</bean> </bean>
<bean id="administrationWebService" class="org.alfresco.repo.webservice.administration.AdministrationWebService"> <bean id="administrationWebService" class="org.alfresco.repo.webservice.administration.AdministrationWebService">
<property name="serviceRegistry">
<ref bean="ServiceRegistry"/>
</property>
<property name="nodeService"> <property name="nodeService">
<ref bean="NodeService"/> <ref bean="NodeService"/>
</property> </property>
@@ -229,7 +213,7 @@
<ref bean="PersonService"/> <ref bean="PersonService"/>
</property> </property>
<property name="querySessionCache"> <property name="querySessionCache">
<ref bean="userQuerySessionCache"/> <ref bean="webServicesQuerySessionCache"/>
</property> </property>
</bean> </bean>