org.alfresco.solr.client

Class SOLRAPIClient

java.lang.Object

org.alfresco.solr.client.SOLRAPIClient

Direct Known Subclasses:

SOLRAPIQueueClient

public class SOLRAPIClient
extends Object

Http client to handle SOLR-Alfresco remote calls.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SOLRAPIClient.GetNodesMetaDataResponse
static class	SOLRAPIClient.GetNodesResponse
static class	SOLRAPIClient.GetTextContentResponse
static class	SOLRAPIClient.GetTransactionsResponse
static class	SOLRAPIClient.SolrApiContentStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
SOLRAPIClient(org.alfresco.httpclient.AlfrescoHttpClient repositoryHttpClient, org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService, org.alfresco.repo.dictionary.NamespaceDAO namespaceDAO)

Method Summary

Modifier and Type	Method and Description
void	close()
AclChangeSets	getAclChangeSets(Long fromCommitTime, Long minAclChangeSetId, Long toCommitTime, Long maxAclChangeSetId, int maxResults) Get the ACL ChangeSets
List<AclReaders>	getAclReaders(List<Acl> acls) Get the ACL readers for a given list of ACLs
List<Acl>	getAcls(List<AclChangeSet> aclChangeSets, Long minAclId, int maxResults) Get the ACLs associated with a given list of ACL ChangeSets.
AlfrescoModel	getModel(String coreName, org.alfresco.service.namespace.QName modelName)
List<AlfrescoModelDiff>	getModelsDiff(String coreName, List<AlfrescoModel> currentModels)
List<Node>	getNodes(GetNodesParameters parameters, int maxResults)
List<NodeMetaData>	getNodesMetaData(NodeMetaDataParameters params, int maxResults)
SOLRAPIClient.GetTextContentResponse	getTextContent(Long nodeId, org.alfresco.service.namespace.QName propertyQName, Long modifiedSince)
Transactions	getTransactions(Long fromCommitTime, Long minTxnId, Long toCommitTime, Long maxTxnId, int maxResults)
Transactions	getTransactions(Long fromCommitTime, Long minTxnId, Long toCommitTime, Long maxTxnId, int maxResults, org.alfresco.repo.index.shard.ShardState shardState)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static final org.slf4j.Logger log

Constructor Detail

SOLRAPIClient

public SOLRAPIClient(org.alfresco.httpclient.AlfrescoHttpClient repositoryHttpClient,
                     org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService,
                     org.alfresco.repo.dictionary.NamespaceDAO namespaceDAO)

Method Detail

getAclChangeSets

public AclChangeSets getAclChangeSets(Long fromCommitTime,
                                      Long minAclChangeSetId,
                                      Long toCommitTime,
                                      Long maxAclChangeSetId,
                                      int maxResults)
                               throws org.alfresco.httpclient.AuthenticationException,
                                      IOException,
                                      org.json.JSONException

Get the ACL ChangeSets

Parameters:

fromCommitTime - the lowest commit time (optional)

minAclChangeSetId - the lowest ChangeSet ID (optional)

maxResults - the maximum number of results (a reasonable value only)

Returns:

the ACL ChangeSets in order of commit time and ID

Throws:

org.alfresco.httpclient.AuthenticationException

IOException

org.json.JSONException

getAcls

public List<Acl> getAcls(List<AclChangeSet> aclChangeSets,
                         Long minAclId,
                         int maxResults)
                  throws org.alfresco.httpclient.AuthenticationException,
                         IOException,
                         org.json.JSONException

Get the ACLs associated with a given list of ACL ChangeSets. The ACLs may be truncated for the last ACL ChangeSet in the return values - the ACL count from the ACL ChangeSets.

Parameters:

aclChangeSets - the ACL ChangeSets to include

minAclId - the lowest ACL ID (may be null)

maxResults - the maximum number of results to retrieve

Returns:

the ACLs (includes ChangeSet ID)

Throws:

org.alfresco.httpclient.AuthenticationException

IOException

org.json.JSONException

getAclReaders

public List<AclReaders> getAclReaders(List<Acl> acls)
                               throws org.alfresco.httpclient.AuthenticationException,
                                      IOException,
                                      org.json.JSONException

Get the ACL readers for a given list of ACLs

Parameters:

acls - the ACLs

Returns:

the readers for the ACLs

Throws:

org.alfresco.httpclient.AuthenticationException

IOException

org.json.JSONException

getTransactions

public Transactions getTransactions(Long fromCommitTime,
                                    Long minTxnId,
                                    Long toCommitTime,
                                    Long maxTxnId,
                                    int maxResults)
                             throws org.alfresco.httpclient.AuthenticationException,
                                    IOException,
                                    org.json.JSONException

Throws:

org.alfresco.httpclient.AuthenticationException

IOException

org.json.JSONException

getTransactions

public Transactions getTransactions(Long fromCommitTime,
                                    Long minTxnId,
                                    Long toCommitTime,
                                    Long maxTxnId,
                                    int maxResults,
                                    org.alfresco.repo.index.shard.ShardState shardState)
                             throws org.alfresco.httpclient.AuthenticationException,
                                    IOException,
                                    org.json.JSONException,
                                    org.apache.commons.codec.EncoderException

Throws:

org.alfresco.httpclient.AuthenticationException

IOException

org.json.JSONException

org.apache.commons.codec.EncoderException

getNodes

public List<Node> getNodes(GetNodesParameters parameters,
                           int maxResults)
                    throws org.alfresco.httpclient.AuthenticationException,
                           IOException,
                           org.json.JSONException

Throws:

org.alfresco.httpclient.AuthenticationException

IOException

org.json.JSONException

getNodesMetaData

public List<NodeMetaData> getNodesMetaData(NodeMetaDataParameters params,
                                           int maxResults)
                                    throws org.alfresco.httpclient.AuthenticationException,
                                           IOException,
                                           org.json.JSONException

Throws:

org.alfresco.httpclient.AuthenticationException

IOException

org.json.JSONException

getTextContent

public SOLRAPIClient.GetTextContentResponse getTextContent(Long nodeId,
                                                           org.alfresco.service.namespace.QName propertyQName,
                                                           Long modifiedSince)
                                                    throws org.alfresco.httpclient.AuthenticationException,
                                                           IOException

Throws:

org.alfresco.httpclient.AuthenticationException

IOException

getModel

public AlfrescoModel getModel(String coreName,
                              org.alfresco.service.namespace.QName modelName)
                       throws org.alfresco.httpclient.AuthenticationException,
                              IOException,
                              org.json.JSONException

Throws:

org.alfresco.httpclient.AuthenticationException

IOException

org.json.JSONException

getModelsDiff

public List<AlfrescoModelDiff> getModelsDiff(String coreName,
                                             List<AlfrescoModel> currentModels)
                                      throws org.alfresco.httpclient.AuthenticationException,
                                             IOException,
                                             org.json.JSONException

Throws:

org.alfresco.httpclient.AuthenticationException

IOException

org.json.JSONException

close

public void close()