org.alfresco.repo.webservice

Class Utils

java.lang.Object

org.alfresco.repo.webservice.Utils

public class Utils
extends Object

Helper class used by the web services

Author:

gavinc

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BATCH_SIZE Default batch size for query results - 1000
static String	QUERY_LANG_CQL
static String	QUERY_LANG_LUCENE Query language names
static String	QUERY_LANG_XPATH
static String	REPOSITORY_SERVICE_NAMESPACE

Method Summary

Methods

Modifier and Type	Method and Description
static NodeRef	convertToNodeRef(ParentReference parentRef, NodeService nodeService, SearchService searchService, org.alfresco.service.namespace.NamespaceService namespaceService) Converts the given ParentReference web service type into a repository NodeRef
static NodeRef	convertToNodeRef(Reference ref, NodeService nodeService, SearchService searchService, org.alfresco.service.namespace.NamespaceService namespaceService) Converts the given Reference web service type into a repository NodeRef
static Reference	convertToReference(NodeService nodeService, org.alfresco.service.namespace.NamespaceService namespaceService, NodeRef node) Converts the given repository NodeRef object into a web service Reference type
static Store	convertToStore(StoreRef ref) Converts a store reference ot a Store type
static StoreRef	convertToStoreRef(Store store) Converts the web service Store type to a StoreRef used by the repository
static Version	convertToVersion(NodeService nodeService, org.alfresco.service.namespace.NamespaceService namespaceService, Version version) Converts a repository version object into a web service version object.
static NamedValue	createNamedValue(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService, org.alfresco.service.namespace.QName propertyName, Serializable propertyValue) Create a named value object from the property name and value informaiton
static int	getBatchSize(org.apache.axis.MessageContext msgContext) Returns the value of the fetchSize from the QueryConfiguration SOAP header (if present)
static RetryingTransactionHelper	getRetryingTransactionHelper(org.apache.axis.MessageContext msgContext) Get the executer to wrap transactional callbacks in for better transaction behaviour.
static String	getSessionId() Gets the current http session id
static org.springframework.web.context.WebApplicationContext	getSpringContext(org.apache.axis.MessageContext msgContext) Returns the current Spring WebApplicationContext object
static UserTransaction	getUserTransaction(org.apache.axis.MessageContext msgContext) Deprecated. Use getRetryingTransactionHelper(MessageContext)
static Serializable	getValueFromNamedValue(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService, org.alfresco.service.namespace.QName propertyName, NamedValue namedValue) Utility method to convert from a string representation of a property value into the correct object representation.
static void	invalidateSession() Invalidates the current http session
static List<NodeRef>	resolvePredicate(Predicate predicate, NodeService nodeService, SearchService searchService, org.alfresco.service.namespace.NamespaceService namespaceService) Resolves the given predicate into a list of NodeRefs that can be acted upon
static NodeRef	resolveToNodeRef(Store store, String uuid, String path, NodeService nodeService, SearchService searchService, org.alfresco.service.namespace.NamespaceService namespaceService) Resolves the given parameters to a repository NodeRef
static AssociationDefinition	setupAssociationDefObject(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService, org.alfresco.service.cmr.dictionary.AssociationDefinition ddAssocDef) Creates an AssociationDefinition web service type object for the given repository AssociationDefinition
static ClassDefinition	setupClassDefObject(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService, org.alfresco.service.cmr.dictionary.ClassDefinition ddClassDef) Creates a ClassDefinition web service type object for the given repository ClassDefinition
static PropertyDefinition	setupPropertyDefObject(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService, org.alfresco.service.cmr.dictionary.PropertyDefinition ddPropDef) Creates a PropertyDefinition web service type object for the given repository PropertyDefinition

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BATCH_SIZE

public static final int DEFAULT_BATCH_SIZE

Default batch size for query results - 1000

See Also:

Constant Field Values

REPOSITORY_SERVICE_NAMESPACE

public static final String REPOSITORY_SERVICE_NAMESPACE

See Also:

Constant Field Values

QUERY_LANG_LUCENE

public static final String QUERY_LANG_LUCENE

Query language names

See Also:

Constant Field Values

QUERY_LANG_XPATH

public static final String QUERY_LANG_XPATH

See Also:

Constant Field Values

QUERY_LANG_CQL

public static final String QUERY_LANG_CQL

See Also:

Constant Field Values

Method Detail

getValueFromNamedValue

public static Serializable getValueFromNamedValue(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService,
                                  org.alfresco.service.namespace.QName propertyName,
                                  NamedValue namedValue)

Utility method to convert from a string representation of a property value into the correct object representation.

Parameters:

dictionaryService - the dictionary service

propertyName - the qname of the property in question

propertyValue - the property vlaue as a string

Returns:

the object value of the property

createNamedValue

public static NamedValue createNamedValue(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService,
                          org.alfresco.service.namespace.QName propertyName,
                          Serializable propertyValue)

Create a named value object from the property name and value informaiton

Parameters:

dictionaryService - the dictionary service

propertyName - the property qname

propertyValue - the property value

Returns:

the namedValue object

convertToStoreRef

public static StoreRef convertToStoreRef(Store store)

Converts the web service Store type to a StoreRef used by the repository

Parameters:

store - The Store to convert

Returns:

The converted StoreRef

convertToStore

public static Store convertToStore(StoreRef ref)

Converts a store reference ot a Store type

Parameters:

ref - the store reference

Returns:

the store

convertToNodeRef

public static NodeRef convertToNodeRef(Reference ref,
                       NodeService nodeService,
                       SearchService searchService,
                       org.alfresco.service.namespace.NamespaceService namespaceService)

Converts the given Reference web service type into a repository NodeRef

Parameters:

ref - The Reference to convert

Returns:

The NodeRef representation of the Reference

convertToNodeRef

public static NodeRef convertToNodeRef(ParentReference parentRef,
                       NodeService nodeService,
                       SearchService searchService,
                       org.alfresco.service.namespace.NamespaceService namespaceService)

Converts the given ParentReference web service type into a repository NodeRef

Parameters:

parentRef - The ParentReference to convert

Returns:

The NodeRef representation of the ParentReference

convertToReference

public static Reference convertToReference(NodeService nodeService,
                           org.alfresco.service.namespace.NamespaceService namespaceService,
                           NodeRef node)

Converts the given repository NodeRef object into a web service Reference type

Parameters:

node - The node to create a Reference for

Returns:

The Reference

resolveToNodeRef

public static NodeRef resolveToNodeRef(Store store,
                       String uuid,
                       String path,
                       NodeService nodeService,
                       SearchService searchService,
                       org.alfresco.service.namespace.NamespaceService namespaceService)

Resolves the given parameters to a repository NodeRef

Parameters:

store - The Store to search within

uuid - The id of the required node.c

path - The path to the required node. If a uuid is given the uuid is used + * to find the node. Otherwise, the path is used.

nodeService - NodeService to use

searchService - SearchService to use

namespaceService - NamespaceService to use

Returns:

A repository NodeRef

resolvePredicate

public static List<NodeRef> resolvePredicate(Predicate predicate,
                             NodeService nodeService,
                             SearchService searchService,
                             org.alfresco.service.namespace.NamespaceService namespaceService)

Resolves the given predicate into a list of NodeRefs that can be acted upon

Parameters:

predicate - The predicate passed from the client

nodeService - NodeService to use

searchService - SearchService to use

namespaceService - NamespaceService to use

Returns:

A List of NodeRef objects

getSpringContext

public static org.springframework.web.context.WebApplicationContext getSpringContext(org.apache.axis.MessageContext msgContext)

Returns the current Spring WebApplicationContext object

Parameters:

msgContext - SOAP message context

Returns:

The Spring WebApplicationContext

getUserTransaction

public static UserTransaction getUserTransaction(org.apache.axis.MessageContext msgContext)

Deprecated. Use getRetryingTransactionHelper(MessageContext)

Returns a UserTransaction that can be used within a service call

Parameters:

msgContext - SOAP message context

Returns:

a UserTransaction

getRetryingTransactionHelper

public static RetryingTransactionHelper getRetryingTransactionHelper(org.apache.axis.MessageContext msgContext)

Get the executer to wrap transactional callbacks in for better transaction behaviour.

Parameters:

msgContext - SOAP message context

Returns:

a transactional, retrying, callback executer

getSessionId

public static String getSessionId()

Gets the current http session id

Returns:

the current http session id, null if none found

invalidateSession

public static void invalidateSession()

Invalidates the current http session

getBatchSize

public static int getBatchSize(org.apache.axis.MessageContext msgContext)

Returns the value of the fetchSize from the QueryConfiguration SOAP header (if present)

Parameters:

msgContext - The SOAP MessageContext

Returns:

The current batch size or -1 if the header is not present

convertToVersion

public static Version convertToVersion(NodeService nodeService,
                       org.alfresco.service.namespace.NamespaceService namespaceService,
                       Version version)

Converts a repository version object into a web service version object.

Parameters:

version - the repository version object

Returns:

the web service version object

setupClassDefObject

public static ClassDefinition setupClassDefObject(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService,
                                  org.alfresco.service.cmr.dictionary.ClassDefinition ddClassDef)

Creates a ClassDefinition web service type object for the given repository ClassDefinition

Parameters:

ddClassDef - The repository ClassDefinition to generate

Returns:

The web service ClassDefinition representation

setupPropertyDefObject

public static PropertyDefinition setupPropertyDefObject(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService,
                                        org.alfresco.service.cmr.dictionary.PropertyDefinition ddPropDef)

Creates a PropertyDefinition web service type object for the given repository PropertyDefinition

Parameters:

ddPropertyDef - The repository PropertyDefinition to generate

Returns:

The web service PropertyDefinition representation

setupAssociationDefObject

public static AssociationDefinition setupAssociationDefObject(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService,
                                              org.alfresco.service.cmr.dictionary.AssociationDefinition ddAssocDef)

Creates an AssociationDefinition web service type object for the given repository AssociationDefinition

Parameters:

ddAssociationDef - The repository AssociationDefinition to generate

Returns:

The web service AssociationDefinition representation