Package org.ametys.plugins.userdirectory.page

Class VirtualUserDirectoryPageFactory

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.userdirectory.page.VirtualUserDirectoryPageFactory

All Implemented Interfaces:

AmetysObjectFactory<Page>, VirtualAmetysObjectFactory<Page>, LogEnabled, Component, Serviceable

public class VirtualUserDirectoryPageFactory
extends AbstractLogEnabled
implements VirtualAmetysObjectFactory<Page>, Serviceable

AmetysObjectFactory for handling "virtual" user directory page

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected UserDirectoryPageHandler	_userDirectoryPageHandler	The user directory root page handler.

Constructor Summary

Constructors

Constructor	Description
VirtualUserDirectoryPageFactory()

Method Summary

Modifier and Type	Method	Description
Page	getAmetysObjectById(String id)	Retrieves an AmetysObject, given its id. Id are like <protocol>://<protocol-specific-part>.
Page	getChild(JCRAmetysObject parent, String childName)	Returns a named AmetysObject.
AmetysObjectIterable<Page>	getChildren(JCRAmetysObject parent)	Returns the "root" objects of this virtual factory, hosted in the Ametys hierarchy under a TraversableAmetysObject, which is backed by a concrete JCR Node.
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.
boolean	hasChild(JCRAmetysObject parent, String childName)	Returns true if the named AmetysObject exists.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

_userDirectoryPageHandler

protected UserDirectoryPageHandler _userDirectoryPageHandler

The user directory root page handler.

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

Constructor Detail

VirtualUserDirectoryPageFactory

public VirtualUserDirectoryPageFactory()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getAmetysObjectById

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

Parameters:

id - the identifier.

Returns:

the corresponding AmetysObject.

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

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

Returns:

the protocol of this factory.

getChildren

public AmetysObjectIterable<Page> getChildren(JCRAmetysObject parent)

Description copied from interface: VirtualAmetysObjectFactory

Returns the "root" objects of this virtual factory, hosted in the Ametys hierarchy under a TraversableAmetysObject, which is backed by a concrete JCR Node.

Specified by:

getChildren in interface VirtualAmetysObjectFactory<Page>

Parameters:

parent - the JCRAmetysObject "hosting" this factory.

Returns:

the root objects of this virtual factory.

getChild

public Page getChild(JCRAmetysObject parent,
                     String childName)

Description copied from interface: VirtualAmetysObjectFactory

Returns a named AmetysObject.

Specified by:

getChild in interface VirtualAmetysObjectFactory<Page>

Parameters:

parent - the JCRAmetysObject "hosting" this factory.

childName - the name of the virtual child.

Returns:

the corresponding AmetysObject.

hasChild

public boolean hasChild(JCRAmetysObject parent,
                        String childName)

Description copied from interface: VirtualAmetysObjectFactory

Returns true if the named AmetysObject exists.

Specified by:

hasChild in interface VirtualAmetysObjectFactory<Page>

Parameters:

parent - the JCRAmetysObject "hosting" this factory.

childName - the name of the virtual child.

Returns:

true if the named AmetysObject exists.