org.alfresco.web.bean.repository

Class Repository

java.lang.Object

org.alfresco.web.bean.repository.Repository

public final class Repository
extends Object

Helper class for accessing repository objects, convert values, escape values and service utilities.

Author:

gavinc, kevinr

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_EXISTS
static String	ERROR_GENERIC
static String	ERROR_NODEREF I18N error messages
static String	ERROR_NOHOME
static String	ERROR_QUERY
static String	ERROR_SEARCH

Method Summary

Modifier and Type	Method and Description
static String	escapeQName(org.alfresco.service.namespace.QName qName) Escape a QName value so it can be used in lucene search strings
static boolean	extractMetadata(FacesContext context, org.alfresco.service.cmr.repository.ContentReader reader, Map<org.alfresco.service.namespace.QName,Serializable> destination) Extracts the metadata of a "raw" piece of content into a map.
static org.alfresco.service.cmr.repository.NodeRef	getCompanyRoot(FacesContext context) Returns a company root node reference object.
static org.alfresco.service.cmr.repository.NodeRef	getCompanyRoot(org.alfresco.service.cmr.repository.NodeService nodeService, org.alfresco.service.cmr.search.SearchService searchService, org.alfresco.service.namespace.NamespaceService namespaceService, org.alfresco.service.cmr.repository.StoreRef storeRef, String rootPath) Returns a company root node reference object.
static ConfigurableService	getConfigurableService(FacesContext context) Return the Configurable Service
static String	getDisplayPath(org.alfresco.service.cmr.repository.Path path) Return the human readable form of the specified node Path.
static String	getDisplayPath(org.alfresco.service.cmr.repository.Path path, boolean showLeaf) Return the human readable form of the specified node Path.
static boolean	getIsGuest(FacesContext context)
static MetadataExtracterRegistry	getMetadataExtracterRegistry(FacesContext context) Return the Metadata Extracter Registry
static String	getMimeTypeForFile(FacesContext context, String filename, File file) Return the mimetype for the specified file, based on both the file name and the file's contents.
static String	getMimeTypeForFileName(FacesContext context, String filename) Return the mimetype for the specified file name.
static String	getNameForCategoryNode(org.alfresco.service.cmr.repository.NodeService nodeService, org.alfresco.service.cmr.repository.NodeRef ref) Helper to get the display name path for a category node.
static String	getNameForNode(org.alfresco.service.cmr.repository.NodeService nodeService, org.alfresco.service.cmr.repository.NodeRef ref) Helper to get the display name for a Node.
static String	getNamePath(org.alfresco.service.cmr.repository.NodeService nodeService, org.alfresco.service.cmr.repository.Path path, org.alfresco.service.cmr.repository.NodeRef rootNode, String separator, String prefix) Resolve a Path by converting each element into its display NAME attribute
static String	getNamePathEx(FacesContext context, org.alfresco.service.cmr.repository.Path path, org.alfresco.service.cmr.repository.NodeRef rootNode, String separator, String prefix) Resolve a Path by converting each element into its display NAME attribute.
static RetryingTransactionHelper	getRetryingTransactionHelper(FacesContext context) Returns the transaction helper that executes a unit of work.
static ServiceRegistry	getServiceRegistry(FacesContext context) Return the Repository Service Registry
static ServiceRegistry	getServiceRegistry(ServletContext context) Return the Repository Service Registry
static org.alfresco.service.cmr.repository.StoreRef	getStoreRef() Returns a store reference object
static org.alfresco.service.cmr.repository.StoreRef	getStoreRef(ServletContext context) Returns a store reference object.
static List<Node>	getUsers(FacesContext context, org.alfresco.service.cmr.repository.NodeService nodeService, PersonService personService) Query a list of Person type nodes from the repo It is currently assumed that all Person nodes exist below the Repository root node
static List<Node>	getUsers(FacesContext context, org.alfresco.service.cmr.repository.NodeService nodeService, org.alfresco.service.cmr.search.SearchService searchService) Deprecated. Use getUsers(FacesContext, NodeService, PersonService) instead
static UserTransaction	getUserTransaction(FacesContext context) Deprecated.
static UserTransaction	getUserTransaction(FacesContext context, boolean readonly) Return a UserTransaction instance
static String	guessEncoding(FacesContext context, InputStream is, String mimetype) Extract the characterset from the stream
static Boolean	isNodeLocked(Node node, LockService lockService) Return whether a Node is currently locked
static Boolean	isNodeOwnerLocked(Node node, LockService lockService) Return whether a Node is currently locked by the current user
static org.alfresco.service.namespace.QName	resolveToQName(String str) Creates a QName representation for the given String.
static String	resolveToQNameString(String str) Creates a string representation of a QName for the given string.
static String	safePropertyToString(Serializable value) Convert a property of unknown type to a String value.
static void	setupBreadcrumbLocation(FacesContext context, NavigationBean navBean, List<IBreadcrumbHandler> location, org.alfresco.service.cmr.repository.NodeRef node) Sets up the breadcrumb location representation for the given node in the given list.

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_NODEREF

public static final String ERROR_NODEREF

I18N error messages

See Also:

Constant Field Values

ERROR_GENERIC

public static final String ERROR_GENERIC

See Also:

Constant Field Values

ERROR_NOHOME

public static final String ERROR_NOHOME

See Also:

Constant Field Values

ERROR_SEARCH

public static final String ERROR_SEARCH

See Also:

Constant Field Values

ERROR_QUERY

public static final String ERROR_QUERY

See Also:

Constant Field Values

ERROR_EXISTS

public static final String ERROR_EXISTS

See Also:

Constant Field Values

Method Detail

getStoreRef

public static org.alfresco.service.cmr.repository.StoreRef getStoreRef()

Returns a store reference object

Returns:

A StoreRef object

getStoreRef

public static org.alfresco.service.cmr.repository.StoreRef getStoreRef(ServletContext context)

Returns a store reference object. This method is used to setup the cached value by the ContextListener initialisation methods

Returns:

The StoreRef object

getCompanyRoot

public static org.alfresco.service.cmr.repository.NodeRef getCompanyRoot(FacesContext context)

Returns a company root node reference object.

Returns:

The NodeRef object

getCompanyRoot

public static org.alfresco.service.cmr.repository.NodeRef getCompanyRoot(org.alfresco.service.cmr.repository.NodeService nodeService,
                                                                         org.alfresco.service.cmr.search.SearchService searchService,
                                                                         org.alfresco.service.namespace.NamespaceService namespaceService,
                                                                         org.alfresco.service.cmr.repository.StoreRef storeRef,
                                                                         String rootPath)

Returns a company root node reference object.

Returns:

The NodeRef object

getNameForNode

public static String getNameForNode(org.alfresco.service.cmr.repository.NodeService nodeService,
                                    org.alfresco.service.cmr.repository.NodeRef ref)

Helper to get the display name for a Node. The method will attempt to use the "name" attribute, if not found it will revert to using the QName.getLocalName() retrieved from the primary parent relationship.

Parameters:

ref - NodeRef

Returns:

display name string for the specified Node.

getNameForCategoryNode

public static String getNameForCategoryNode(org.alfresco.service.cmr.repository.NodeService nodeService,
                                            org.alfresco.service.cmr.repository.NodeRef ref)

Helper to get the display name path for a category node.

Parameters:

nodeService - NodeService

ref - the category node ref

Returns:

display name string for the specified category node.

escapeQName

public static String escapeQName(org.alfresco.service.namespace.QName qName)

Escape a QName value so it can be used in lucene search strings

Parameters:

qName - QName to escape

Returns:

escaped value

isNodeLocked

public static Boolean isNodeLocked(Node node,
                                   LockService lockService)

Return whether a Node is currently locked

Parameters:

node - The Node wrapper to test against

lockService - The LockService to use

Returns:

whether a Node is currently locked

isNodeOwnerLocked

public static Boolean isNodeOwnerLocked(Node node,
                                        LockService lockService)

Return whether a Node is currently locked by the current user

Parameters:

node - The Node wrapper to test against

lockService - The LockService to use

Returns:

whether a Node is currently locked by the current user

getDisplayPath

public static String getDisplayPath(org.alfresco.service.cmr.repository.Path path)

Return the human readable form of the specified node Path. Fast version of the method that simply converts QName localname components to Strings.

Parameters:

path - Path to extract readable form from, excluding the final element

Returns:

human readable form of the Path excluding the final element

getDisplayPath

public static String getDisplayPath(org.alfresco.service.cmr.repository.Path path,
                                    boolean showLeaf)

Return the human readable form of the specified node Path. Fast version of the method that simply converts QName localname components to Strings.

Parameters:

path - Path to extract readable form from

showLeaf - Whether to process the final leaf element of the path

Returns:

human readable form of the Path excluding the final element

getNamePath

public static String getNamePath(org.alfresco.service.cmr.repository.NodeService nodeService,
                                 org.alfresco.service.cmr.repository.Path path,
                                 org.alfresco.service.cmr.repository.NodeRef rootNode,
                                 String separator,
                                 String prefix)

Resolve a Path by converting each element into its display NAME attribute

Parameters:

path - Path to convert

separator - Separator to user between path elements

prefix - To prepend to the path

Returns:

Path converted using NAME attribute on each element

setupBreadcrumbLocation

public static void setupBreadcrumbLocation(FacesContext context,
                                           NavigationBean navBean,
                                           List<IBreadcrumbHandler> location,
                                           org.alfresco.service.cmr.repository.NodeRef node)

Sets up the breadcrumb location representation for the given node in the given list.

Parameters:

context - FacesContext

navBean - NavigationBean instance

location - The location list to setup

node - The Node being navigated to

getNamePathEx

public static String getNamePathEx(FacesContext context,
                                   org.alfresco.service.cmr.repository.Path path,
                                   org.alfresco.service.cmr.repository.NodeRef rootNode,
                                   String separator,
                                   String prefix)

Resolve a Path by converting each element into its display NAME attribute. Note: This method resolves path regardless access permissions. Fixes the UI part of the ETWOONE-214 and ETWOONE-238 issues

Parameters:

path - Path to convert

separator - Separator to user between path elements

prefix - To prepend to the path

Returns:

Path converted using NAME attribute on each element

getMimeTypeForFileName

public static String getMimeTypeForFileName(FacesContext context,
                                            String filename)

Return the mimetype for the specified file name.

The file extension will be extracted from the filename and used to lookup the mimetype.

Parameters:

context - FacesContext

filename - Non-null filename to process

Returns:

mimetype for the specified filename - falls back to 'application/octet-stream' if not found.

getMimeTypeForFile

public static String getMimeTypeForFile(FacesContext context,
                                        String filename,
                                        File file)

Return the mimetype for the specified file, based on both the file name and the file's contents.

The file extension will be extracted from the filename and used along with the file contents to identify the mimetype.

Parameters:

context - FacesContext

filename - Non-null filename to process

file - The File object (used to read the contents)

Returns:

mimetype for the specified filename - falls back to 'application/octet-stream' if not found.

getUserTransaction

public static UserTransaction getUserTransaction(FacesContext context)

Deprecated.

Return a UserTransaction instance

Parameters:

context - FacesContext

Returns:

UserTransaction

See Also:

getRetryingTransactionHelper(FacesContext)

getRetryingTransactionHelper

public static RetryingTransactionHelper getRetryingTransactionHelper(FacesContext context)

Returns the transaction helper that executes a unit of work.

Parameters:

context - FacesContext

Returns:

Returns the transaction helper

getUserTransaction

public static UserTransaction getUserTransaction(FacesContext context,
                                                 boolean readonly)

Return a UserTransaction instance

Parameters:

context - FacesContext

readonly - Transaction readonly state

Returns:

UserTransaction

getServiceRegistry

public static ServiceRegistry getServiceRegistry(FacesContext context)

Return the Repository Service Registry

Parameters:

context - Faces Context

Returns:

the Service Registry

getServiceRegistry

public static ServiceRegistry getServiceRegistry(ServletContext context)

Return the Repository Service Registry

Parameters:

context - Servlet Context

Returns:

the Service Registry

getConfigurableService

public static ConfigurableService getConfigurableService(FacesContext context)

Return the Configurable Service

Returns:

the configurable service

getMetadataExtracterRegistry

public static MetadataExtracterRegistry getMetadataExtracterRegistry(FacesContext context)

Return the Metadata Extracter Registry

Parameters:

context - Faces Context

Returns:

the MetadataExtracterRegistry

extractMetadata

public static boolean extractMetadata(FacesContext context,
                                      org.alfresco.service.cmr.repository.ContentReader reader,
                                      Map<org.alfresco.service.namespace.QName,Serializable> destination)

Extracts the metadata of a "raw" piece of content into a map.

Parameters:

context - Faces Context

reader - Content reader for the source content to extract from

destination - Map of metadata to set metadata values into

Returns:

True if an extracter was found

guessEncoding

public static String guessEncoding(FacesContext context,
                                   InputStream is,
                                   String mimetype)

Extract the characterset from the stream

Parameters:

context - the Faces Context

is - the stream of characters or data

mimetype - the stream's mimetype, or null if unknown

Returns:

Returns the guessed characterset and never null

getUsers

public static List<Node> getUsers(FacesContext context,
                                  org.alfresco.service.cmr.repository.NodeService nodeService,
                                  org.alfresco.service.cmr.search.SearchService searchService)

Deprecated. Use getUsers(FacesContext, NodeService, PersonService) instead

Query a list of Person type nodes from the repo It is currently assumed that all Person nodes exist below the Repository root node

Parameters:

context - Faces Context

nodeService - The node service

searchService - The search service, which is ignored

Returns:

List of Person node objects

getUsers

public static List<Node> getUsers(FacesContext context,
                                  org.alfresco.service.cmr.repository.NodeService nodeService,
                                  PersonService personService)

Query a list of Person type nodes from the repo It is currently assumed that all Person nodes exist below the Repository root node

Parameters:

context - Faces Context

nodeService - The node service

personService - PersonService

Returns:

List of Person node objects

getIsGuest

public static boolean getIsGuest(FacesContext context)

Returns:

true if we are currently the special Guest user

safePropertyToString

public static String safePropertyToString(Serializable value)

Convert a property of unknown type to a String value. A native String value will be returned directly, else toString() will be executed, null is returned as null.

Parameters:

value - Property value

Returns:

value to String or null

resolveToQName

public static org.alfresco.service.namespace.QName resolveToQName(String str)

Creates a QName representation for the given String. If the String has no namespace the Alfresco namespace is added. If the String has a prefix an attempt to resolve the prefix to the full URI will be made.

Parameters:

str - The string to convert

Returns:

A QName representation of the given string

resolveToQNameString

public static String resolveToQNameString(String str)

Creates a string representation of a QName for the given string. If the given string already has a namespace, either a URL or a prefix, nothing the given string is returned. If it does not have a namespace the Alfresco namespace is added.

Parameters:

str - The string to convert

Returns:

A QName String representation of the given string