org.alfresco.solr.content

Class SolrContentUrlBuilder

java.lang.Object

org.alfresco.solr.content.SolrContentUrlBuilder

public class SolrContentUrlBuilder
extends Object

Utility class that wraps up the creation of SOLR content URLs given arbitrary, string-based metadata.

The URL is constructed from a 19 digit number (zero-padded long), which is built from the ACL ID, the DB ID or a CRC32 of the provided metadata, and a numerical version starting with "000".
For example, the DB ID "4775808" will generate "someprefix:///db/4775/808.gz"
The

Since:

5.0

Author:

Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_EXTENSION
static String	KEY_ACL_ID The key for the ACL ID
static String	KEY_DB_ID The key for the DB ID
static String	KEY_TENANT The key for the tenant name
protected static org.slf4j.Logger	logger
static String	SOLR_PROTOCOL solr is the prefix for SOLR content URLs
static String	SOLR_PROTOCOL_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SolrContentUrlBuilder() Protected constructor used by start()

Method Summary

Modifier and Type	Method and Description
SolrContentUrlBuilder	add(String key, String value) Add some metadata to the URL generator.
String	get() Get the final content URL using the supplied metadata.
org.alfresco.repo.content.ContentContext	getContentContext() Helper method to retrieve a ContentContext constructed using the final get() url.
static SolrContentUrlBuilder	start() Factory method to start building the SOLR content URL.

Methods inherited from class java.lang.Object

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

Field Detail

SOLR_PROTOCOL

public static final String SOLR_PROTOCOL

solr is the prefix for SOLR content URLs

See Also:

#isContentUrlSupported(String), Constant Field Values

SOLR_PROTOCOL_PREFIX

public static final String SOLR_PROTOCOL_PREFIX

See Also:

Constant Field Values

FILE_EXTENSION

public static final String FILE_EXTENSION

See Also:

Constant Field Values

KEY_TENANT

public static final String KEY_TENANT

The key for the tenant name

See Also:

Constant Field Values

KEY_DB_ID

public static final String KEY_DB_ID

The key for the DB ID

See Also:

Constant Field Values

KEY_ACL_ID

public static final String KEY_ACL_ID

The key for the ACL ID

See Also:

Constant Field Values

logger

protected static final org.slf4j.Logger logger

Constructor Detail

SolrContentUrlBuilder

protected SolrContentUrlBuilder()

Protected constructor used by start()

Method Detail

start

public static SolrContentUrlBuilder start()

Factory method to start building the SOLR content URL.

Returns:

an instance of the builder

add

public SolrContentUrlBuilder add(String key,
                                 String value)

Add some metadata to the URL generator. The order in which metadata is added is irrelevant.

Note that there are specific keys that are commonly used and, if provided, may not be null or empty.

• KEY_TENANT: The name of the tenant or 'default' if missing.
• KEY_DB_ID: The database ID.
• KEY_ACL_ID: The ACL ID.

Parameters:

key - an arbitrary metadata key (never null>

value - some metadata value (null is supported)

Returns:

this builder for more building

Throws:

IllegalArgumentException - if the key is null

IllegalStateException - if the key has been used already

get

public String get()

Get the final content URL using the supplied metadata.

Returns:

the SOLR content URL

Throws:

IllegalStateException - if no metadata has been added

getContentContext

public org.alfresco.repo.content.ContentContext getContentContext()

Helper method to retrieve a ContentContext constructed using the final get() url.