org.ametys.plugins.serverdirectory

Class ServerDirectoryEnumerator

java.lang.Object

org.ametys.plugins.serverdirectory.ServerDirectoryEnumerator

All Implemented Interfaces:

Enumerator, LogEnabled, Serviceable

public class ServerDirectoryEnumerator
extends Object
implements Serviceable, Enumerator<String>, Enumerator, LogEnabled

Enumerate sub-directories from root directories defined in configuration's parameters

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	_logger
private SourceResolver	_sourceResolver

Constructor Summary

Constructors

Constructor and Description
ServerDirectoryEnumerator()

Method Summary

Modifier and Type	Method and Description
private Map<String,I18nizableText>	_getDirectories(Source source)
void	enableLogging(Logger logger)
Map<String,Object>	getConfiguration() Get the configuration of this enumerator
Map<Object,I18nizableText>	getEntries() Provides the enumerated values with their optional label.
I18nizableText	getEntry(String value) Retrieves a single label from a value.
Map<String,I18nizableText>	getTypedEntries() Provides the enumerated values with their optional label.
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Field Detail

_sourceResolver

private SourceResolver _sourceResolver

_logger

private Logger _logger

Constructor Detail

ServerDirectoryEnumerator

public ServerDirectoryEnumerator()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

enableLogging

public void enableLogging(Logger logger)

Specified by:

enableLogging in interface LogEnabled

getEntry

public I18nizableText getEntry(String value)
                        throws Exception

Description copied from interface: Enumerator

Retrieves a single label from a value.

Specified by:

getEntry in interface Enumerator

Parameters:

value - the value.

Returns:

the label or null if not found.

Throws:

Exception - if an error occurs.

getTypedEntries

public Map<String,I18nizableText> getTypedEntries()
                                           throws Exception

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs. TODO NEWATTRIBUTEAPI: rename this method when Enumerator will be removed

_getDirectories

private Map<String,I18nizableText> _getDirectories(Source source)
                                            throws SourceException

Throws:

SourceException

getEntries

public Map<Object,I18nizableText> getEntries()
                                      throws Exception

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Specified by:

getEntries in interface Enumerator

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs.

getConfiguration

public Map<String,Object> getConfiguration()

Description copied from interface: Enumerator

Get the configuration of this enumerator

Specified by:

getConfiguration in interface Enumerator

Returns:

the configuration