Package org.alfresco.solr.client

Class SOLRAPIClient

java.lang.Object

org.alfresco.solr.client.SOLRAPIClient

Direct Known Subclasses:

SOLRAPIQueueClient

public class SOLRAPIClient
extends java.lang.Object

Http client to handle SOLR-Alfresco remote calls.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	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	Description
protected static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

Constructor Detail

SOLRAPIClient

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

SOLRAPIClient

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

Method Detail

getAclChangeSets

public AclChangeSets getAclChangeSets(java.lang.Long fromCommitTime,
                                      java.lang.Long minAclChangeSetId,
                                      java.lang.Long toCommitTime,
                                      java.lang.Long maxAclChangeSetId,
                                      int maxResults)
                               throws org.alfresco.httpclient.AuthenticationException,
                                      java.io.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

java.io.IOException

org.json.JSONException

getAcls

public java.util.List<Acl> getAcls(java.util.List<AclChangeSet> aclChangeSets,
                                   java.lang.Long minAclId,
                                   int maxResults)
                            throws org.alfresco.httpclient.AuthenticationException,
                                   java.io.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

java.io.IOException

org.json.JSONException

getAclReaders

public java.util.List<AclReaders> getAclReaders(java.util.List<Acl> acls)
                                         throws org.alfresco.httpclient.AuthenticationException,
                                                java.io.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

java.io.IOException

org.json.JSONException

getTransactions

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

Throws:

org.alfresco.httpclient.AuthenticationException

java.io.IOException

org.json.JSONException

getTransactions

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

Throws:

org.alfresco.httpclient.AuthenticationException

java.io.IOException

org.json.JSONException

org.apache.commons.codec.EncoderException

getNodes

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

Throws:

org.alfresco.httpclient.AuthenticationException

java.io.IOException

org.json.JSONException

getNodesMetaData

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

Throws:

org.alfresco.httpclient.AuthenticationException

java.io.IOException

org.json.JSONException

getTextContent

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

Throws:

org.alfresco.httpclient.AuthenticationException

java.io.IOException

getModel

public AlfrescoModel getModel(java.lang.String coreName,
                              org.alfresco.service.namespace.QName modelName)
                       throws org.alfresco.httpclient.AuthenticationException,
                              java.io.IOException

Throws:

org.alfresco.httpclient.AuthenticationException

java.io.IOException

getModelsDiff

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

Throws:

org.alfresco.httpclient.AuthenticationException

java.io.IOException

org.json.JSONException

getNextTxCommitTime

public java.lang.Long getNextTxCommitTime(java.lang.String coreName,
                                          java.lang.Long fromCommitTime)
                                   throws org.alfresco.httpclient.AuthenticationException,
                                          java.io.IOException,
                                          java.lang.NoSuchMethodException

Returns the next commit time from a given commit time.

Parameters:

coreName - alfresco, archive

fromCommitTime - initial transaction commit time

Returns:

Time of the next transaction

Throws:

java.io.IOException

org.alfresco.httpclient.AuthenticationException

java.lang.NoSuchMethodException

getTxIntervalCommitTime

public org.alfresco.util.Pair<java.lang.Long,java.lang.Long> getTxIntervalCommitTime(java.lang.String coreName,
                                                                                           java.lang.Long fromNodeId,
                                                                                           java.lang.Long toNodeId)
                                                                                    throws org.alfresco.httpclient.AuthenticationException,
                                                                                           java.io.IOException,
                                                                                           java.lang.NoSuchMethodException

Returns the minimum and the maximum commit time for transactions in a node id range.

Parameters:

coreName - alfresco, archive

fromNodeId - Id of the initial node

toNodeId - Id of the final node

Returns:

Time of the first transaction, time of the last transaction

Throws:

java.io.IOException

org.alfresco.httpclient.AuthenticationException

java.lang.NoSuchMethodException

close

public void close()