org.cyclos.impl.access

Interface ConfigurationHandler

public interface ConfigurationHandler

Provides access to configurations

Author:

luis

Method Summary

Modifier and Type	Method and Description
ConfigurationAccessor	getAccessor(Account account) Returns the configuration accessor for the given account.
ConfigurationAccessor	getAccessor(BasicGroup group) Returns a ConfigurationAccessor, which allows getting specific configurations, for the given group
ConfigurationAccessor	getAccessor(BasicUser user) Returns a ConfigurationAccessor, which allows getting specific configurations, for the given user
ConfigurationAccessor	getAccessor(BasicUser user, boolean resolveForLoggedUser) INTERNAL: This method is intended to be invoked only from SessionData.
ConfigurationAccessor	getAccessor(Configuration configuration) Returns a ConfigurationAccessor, for an specific configuration
ConfigurationAccessor	getAccessor(Configuration configuration, java.util.List<java.lang.String> locales) Returns a ConfigurationAccessor, for an specific configuration, using a preferred language and a list of preferred locales
ConfigurationAccessor	getAccessor(Network network) Returns the accessor for the given network's default configuration, or, if null, the global default configuration
java.util.List<Configuration>	getAncestors(Configuration configuration) Returns the configuration ancestors, where the first element is the given configuration, and subsequent elements are their ancestors
java.util.Set<java.lang.String>	getConfigurableProperties() Returns the property names which are configurable, that means, allows defining and locking
Configuration	getDefault() Returns either the global default or the network default configuration
ConfigurationAccessor	getDefaultAccessor() Returns the accessor for the default configuration
Configuration	getForGroup(BasicGroup group) Resolves the configuration for the given group
Configuration	getGlobalDefault() Returns the global default configuration

Method Detail

getAccessor

ConfigurationAccessor getAccessor(Account account)

Returns the configuration accessor for the given account. For user accounts, use the owner configuration. For system accounts, use the network default configuration.

getAccessor

ConfigurationAccessor getAccessor(BasicGroup group)

Returns a ConfigurationAccessor, which allows getting specific configurations, for the given group

getAccessor

ConfigurationAccessor getAccessor(BasicUser user)

Returns a ConfigurationAccessor, which allows getting specific configurations, for the given user

getAccessor

ConfigurationAccessor getAccessor(BasicUser user,
                                  boolean resolveForLoggedUser)
                           throws java.lang.IllegalArgumentException

INTERNAL: This method is intended to be invoked only from SessionData. Returns a ConfigurationAccessor, which allows getting specific configurations, for the given user

Parameters:

resolveForLoggedUser - if true the only valid value for user param is the logged user

Throws:

java.lang.IllegalArgumentException - if the user parameter is not the logged user in case of resolveForLoggedUser flag is true

getAccessor

ConfigurationAccessor getAccessor(Configuration configuration)

Returns a ConfigurationAccessor, for an specific configuration

getAccessor

ConfigurationAccessor getAccessor(Configuration configuration,
                                  java.util.List<java.lang.String> locales)

Returns a ConfigurationAccessor, for an specific configuration, using a preferred language and a list of preferred locales

getAccessor

ConfigurationAccessor getAccessor(Network network)

Returns the accessor for the given network's default configuration, or, if null, the global default configuration

getAncestors

java.util.List<Configuration> getAncestors(Configuration configuration)

Returns the configuration ancestors, where the first element is the given configuration, and subsequent elements are their ancestors

getConfigurableProperties

java.util.Set<java.lang.String> getConfigurableProperties()

Returns the property names which are configurable, that means, allows defining and locking

getDefault

Configuration getDefault()

Returns either the global default or the network default configuration

getDefaultAccessor

ConfigurationAccessor getDefaultAccessor()

Returns the accessor for the default configuration

getForGroup

Configuration getForGroup(BasicGroup group)

Resolves the configuration for the given group

getGlobalDefault

Configuration getGlobalDefault()

Returns the global default configuration