org.ametys.plugins.explorer.cmis

Class CMISTreeFactory

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.explorer.cmis.CMISTreeFactory

All Implemented Interfaces:

Observer, AmetysObjectFactory<AmetysObject>, JCRAmetysObjectFactory<AmetysObject>, Initializable, Component, Configurable, LogEnabled, Serviceable

public class CMISTreeFactory
extends AbstractLogEnabled
implements JCRAmetysObjectFactory<AmetysObject>, Configurable, Serviceable, Initializable, Observer

Create the Root of CMIS Resources Collections

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_nodetype The configured nodetype
private ObservationManager	_observationManager
protected Repository	_repository JCR Repository
protected AmetysObjectResolver	_resolver The application AmetysObjectResolver
protected String	_scheme The configured scheme
private Map<String,Session>	_sessionCache
static String	CMIS_ROOT_COLLECTION_NODETYPE Nodetype for resources collection

Fields inherited from interface org.ametys.core.observation.Observer

MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
CMISTreeFactory()

Method Summary

Modifier and Type	Method and Description
void	configure(Configuration configuration)
CMISRootResourcesCollection	getAmetysObject(Node node, String parentPath) Creates a AmetysObject from a persistent JCR node.
AmetysObject	getAmetysObjectById(String id) Retrieves an AmetysObject, given its id. Id are like <protocol>://<protocol-specific-part>.
AmetysObject	getAmetysObjectById(String id, Session session) Retrieves an AmetysObject with the provided JCR Session, given its id. Id are like <protocol>://<protocol-specific-part>.
Session	getAtomPubSession(CMISRootResourcesCollection root) Opening a Atom Pub Connection
protected CMISRootResourcesCollection	getCMISRootResourceCollection(String id) Retrieves an CMISRootResourcesCollection, given its id.
protected Node	getNode(String id) Returns the JCR Node associated with the given object id. This implementation assumes that the id is like <scheme>://<uuid>
Collection<String>	getNodetypes() Returns the nodetypes of the Node associated with this factory.
AmetysObject	getParent(CMISRootResourcesCollection object) Returns the parent of the given AmetysObject .
int	getPriority(Event event) Retrieves the priority to observe this event. This can be used to process a supported event before others observers.
String	getScheme() Returns the protocol of this factory, used to construct unique ids.
boolean	hasAmetysObjectForId(String id) Return true if the specified id correspond to an existing AmetysObject.
void	initialize()
void	observe(Event event, Map<String,Object> transientVars) Observes an event.
void	service(ServiceManager manager)
boolean	supports(Event event) Checks if the event is supported.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

CMIS_ROOT_COLLECTION_NODETYPE

public static final String CMIS_ROOT_COLLECTION_NODETYPE

Nodetype for resources collection

See Also:

Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

The application AmetysObjectResolver

_scheme

protected String _scheme

The configured scheme

_nodetype

protected String _nodetype

The configured nodetype

_repository

protected Repository _repository

JCR Repository

_observationManager

private ObservationManager _observationManager

_sessionCache

private Map<String,Session> _sessionCache

Constructor Detail

CMISTreeFactory

public CMISTreeFactory()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getAmetysObject

public CMISRootResourcesCollection getAmetysObject(Node node,
                                                   String parentPath)
                                            throws AmetysRepositoryException,
                                                   RepositoryException

Description copied from interface: JCRAmetysObjectFactory

Creates a AmetysObject from a persistent JCR node.

Specified by:

getAmetysObject in interface JCRAmetysObjectFactory<AmetysObject>

Parameters:

node - the JCR node to use.

parentPath - the parent Path in the Ametys hierarchy, may be null if not known yet.

Returns:

the object.

Throws:

AmetysRepositoryException - if an error occurs.

RepositoryException - if a JCR error occurs.

getAmetysObjectById

public AmetysObject getAmetysObjectById(String id)
                                 throws AmetysRepositoryException

Description copied from interface: AmetysObjectFactory

Retrieves an AmetysObject, given its id.
Id are like <protocol>://<protocol-specific-part>.

Specified by:

getAmetysObjectById in interface AmetysObjectFactory<AmetysObject>

Parameters:

id - the identifier.

Returns:

the corresponding AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

getAmetysObjectById

public AmetysObject getAmetysObjectById(String id,
                                        Session session)
                                 throws AmetysRepositoryException,
                                        RepositoryException

Description copied from interface: JCRAmetysObjectFactory

Retrieves an AmetysObject with the provided JCR Session, given its id.
Id are like <protocol>://<protocol-specific-part>.

Specified by:

getAmetysObjectById in interface JCRAmetysObjectFactory<AmetysObject>

Parameters:

id - the identifier.

session - the JCR Session to use to retrieve the AmetysObject.

Returns:

the corresponding AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

RepositoryException - if a JCR error occurs.

getCMISRootResourceCollection

protected CMISRootResourcesCollection getCMISRootResourceCollection(String id)
                                                             throws AmetysRepositoryException

Retrieves an CMISRootResourcesCollection, given its id.

Parameters:

id - the identifier.

Returns:

the corresponding CMISRootResourcesCollection.

Throws:

AmetysRepositoryException - if an error occurs.

hasAmetysObjectForId

public boolean hasAmetysObjectForId(String id)
                             throws AmetysRepositoryException

Description copied from interface: AmetysObjectFactory

Return true if the specified id correspond to an existing AmetysObject. Id are like <protocol>://<protocol-specific-part>.

Specified by:

hasAmetysObjectForId in interface AmetysObjectFactory<AmetysObject>

Parameters:

id - the identifier.

Returns:

true if the specified id correspond to an existing AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

getScheme

public String getScheme()

Description copied from interface: AmetysObjectFactory

Returns the protocol of this factory, used to construct unique ids.

Specified by:

getScheme in interface AmetysObjectFactory<AmetysObject>

Returns:

the protocol of this factory.

getNodetypes

public Collection<String> getNodetypes()

Description copied from interface: JCRAmetysObjectFactory

Returns the nodetypes of the Node associated with this factory.

Specified by:

getNodetypes in interface JCRAmetysObjectFactory<AmetysObject>

Returns:

the nodetypes of the Node.

getParent

public AmetysObject getParent(CMISRootResourcesCollection object)
                       throws AmetysRepositoryException

Returns the parent of the given AmetysObject .

Parameters:

object - a AmetysObject.

Returns:

the parent of the given AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

getNode

protected Node getNode(String id)

Returns the JCR Node associated with the given object id.
This implementation assumes that the id is like <scheme>://<uuid>

Parameters:

id - the unique id of the object

Returns:

the JCR Node associated with the given id

getAtomPubSession

public Session getAtomPubSession(CMISRootResourcesCollection root)

Opening a Atom Pub Connection

Parameters:

root - the JCR root folder

Returns:

The created session or null if connection to CMIS server failed

getPriority

public int getPriority(Event event)

Description copied from interface: Observer

Retrieves the priority to observe this event.
This can be used to process a supported event before others observers.

Specified by:

getPriority in interface Observer

Parameters:

event - the event.

Returns:

the priority where 0 the max priority and Integer.MAX_VALUE the min priority.

supports

public boolean supports(Event event)

Description copied from interface: Observer

Checks if the event is supported. If true, the observe(Event) method will be called.

Specified by:

supports in interface Observer

Parameters:

event - the event.

Returns:

true for observing this event, false otherwise.

observe

public void observe(Event event,
                    Map<String,Object> transientVars)
             throws Exception

Description copied from interface: Observer

Observes an event.

Specified by:

observe in interface Observer

Parameters:

event - the event.

transientVars - transientVars passed from one Observer to another when processing a single Event. This may allow optimizations between observers.

Throws:

Exception - if an error occurs. All exceptions will be logged but not propagated, as the observation mechanism should never fail.