org.ametys.plugins.repository.jcr

Class SimpleAmetysObjectFactory

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.repository.jcr.SimpleAmetysObjectFactory

All Implemented Interfaces:

AmetysObjectFactory<SimpleAmetysObject>, JCRAmetysObjectFactory<SimpleAmetysObject>, Component, Configurable, LogEnabled, Serviceable

Direct Known Subclasses:

AmetysObjectCollectionFactory, CatalogFactory, DefaultAliasFactory, DefaultAmetysObjectFactory, DefaultDefinitionFactory, DefaultThemeFactory, DefaultTraversableAmetysObjectFactory, DefaultZoneItemFactory

public class SimpleAmetysObjectFactory
extends AbstractLogEnabled
implements JCRAmetysObjectFactory<SimpleAmetysObject>, Configurable, Serviceable

Default implementation of an JCRAmetysObjectFactory, handling SimpleAmetysObject.
This implementation takes its scheme and nodetype through a configuration:
<extension point="org.ametys.plugins.repository.AmetysObjectFactoryExtensionPoint"
id="XXXX" class="org.ametys.plugins.repository.DefaultAmetysObjectFactory">
<scheme>your_scheme</scheme>
<nodetype>your:nodetype</nodetype>
[<nodetype>your:nodetype2</nodetype>]
[...]
</extension>
This implementation manages only one nodetype.

Field Summary

Fields

Modifier and Type	Field and Description
protected AmetysObjectFactoryExtensionPoint	_ametysFactoryExtensionPoint The AmetysObjectFactoryExtensionPoint
protected ServiceManager	_manager The Avalon ServiceManager
protected String	_nodetype The configured nodetype
protected Repository	_repository JCR Repository
protected AmetysObjectResolver	_resolver The application AmetysObjectResolver
protected String	_scheme The configured scheme

Constructor Summary

Constructors

Constructor and Description
SimpleAmetysObjectFactory()

Method Summary

Modifier and Type	Method and Description
(package private) AmetysObjectResolver	_getResolver()
void	configure(Configuration configuration)
SimpleAmetysObject	getAmetysObject(Node node, String parentPath) Creates a AmetysObject from a persistent JCR node.
SimpleAmetysObject	getAmetysObjectById(String id) Retrieves an AmetysObject, given its id. Id are like <protocol>://<protocol-specific-part>.
SimpleAmetysObject	getAmetysObjectById(String id, Session session) Retrieves an AmetysObject with the provided JCR Session, given its id. Id are like <protocol>://<protocol-specific-part>.
protected Node	getNode(String id, Session session) 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(SimpleAmetysObject object) Returns the parent of the given SimpleAmetysObject .
String	getScheme() Returns the protocol of this factory, used to construct unique ids.
protected Node	getWorkspaceNode(SimpleAmetysObject object) Returns the JCR node backing this SimpleAmetysObject in the JCR workspace.
boolean	hasAmetysObjectForId(String id) Return true if the specified id correspond to an existing AmetysObject.
void	service(ServiceManager manager)

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

_resolver

protected AmetysObjectResolver _resolver

The application AmetysObjectResolver

_ametysFactoryExtensionPoint

protected AmetysObjectFactoryExtensionPoint _ametysFactoryExtensionPoint

The AmetysObjectFactoryExtensionPoint

_scheme

protected String _scheme

The configured scheme

_nodetype

protected String _nodetype

The configured nodetype

_repository

protected Repository _repository

JCR Repository

_manager

protected ServiceManager _manager

The Avalon ServiceManager

Constructor Detail

SimpleAmetysObjectFactory

public SimpleAmetysObjectFactory()

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

_getResolver

AmetysObjectResolver _getResolver()

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<SimpleAmetysObject>

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<SimpleAmetysObject>

Returns:

the nodetypes of the Node.

getAmetysObject

public SimpleAmetysObject 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<SimpleAmetysObject>

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 SimpleAmetysObject 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<SimpleAmetysObject>

Parameters:

id - the identifier.

Returns:

the corresponding AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

getAmetysObjectById

public SimpleAmetysObject 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<SimpleAmetysObject>

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.

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<SimpleAmetysObject>

Parameters:

id - the identifier.

Returns:

true if the specified id correspond to an existing AmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

getNode

protected Node getNode(String id,
                       Session session)

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

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

Returns:

the JCR Node associated with the given id

getParent

public AmetysObject getParent(SimpleAmetysObject object)
                       throws AmetysRepositoryException

Returns the parent of the given SimpleAmetysObject .

Parameters:

object - a SimpleAmetysObject.

Returns:

the parent of the given SimpleAmetysObject.

Throws:

AmetysRepositoryException - if an error occurs.

getWorkspaceNode

protected Node getWorkspaceNode(SimpleAmetysObject object)

Returns the JCR node backing this SimpleAmetysObject in the JCR workspace. May be overridden to deal with e.g. versionning

Parameters:

object - a SimpleAmetysObject.

Returns:

the JCR node backing this SimpleAmetysObject.