/*******************************************************************************
* Copyright 2009, 2010 Innovation Gate GmbH. All Rights Reserved.
*
* This file is part of the OpenWGA server platform.
*
* OpenWGA is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* In addition, a special exception is granted by the copyright holders
* of OpenWGA called "OpenWGA plugin exception". You should have received
* a copy of this exception along with OpenWGA in file COPYING.
* If not, see <http://www.openwga.com/gpl-plugin-exception>.
*
* OpenWGA is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with OpenWGA in file COPYING.
* If not, see <http://www.gnu.org/licenses/>.
******************************************************************************/
package de.innovationgate.wgpublisher.modules.auth;
import java.util.Locale;
import de.innovationgate.utils.WGUtils;
import de.innovationgate.webgate.api.WGDatabase;
import de.innovationgate.webgate.api.auth.AuthenticationModule;
import de.innovationgate.wga.common.beans.csconfig.v1.PluginConfig;
import de.innovationgate.wga.modules.AvailabilityTestableModuleDefinition;
import de.innovationgate.wga.modules.LocalisationBundleLoader;
import de.innovationgate.wga.modules.ModuleAvailabilityException;
import de.innovationgate.wga.modules.ModuleDefinition;
import de.innovationgate.wga.modules.ModuleDependencyException;
import de.innovationgate.wga.modules.ModuleRegistry;
import de.innovationgate.wga.modules.ModuleType;
import de.innovationgate.wga.modules.OptionDefinitionsMap;
import de.innovationgate.wga.modules.RegistryAwareModuleDefinition;
import de.innovationgate.wga.modules.options.LocalizedOptionDefinition;
import de.innovationgate.wga.modules.options.StringOptionType;
import de.innovationgate.wga.modules.types.AuthenticationSourceModuleType;
import de.innovationgate.wgpublisher.WGACore;
import de.innovationgate.wgpublisher.auth.CSAuthModule;
import de.innovationgate.wgpublisher.auth.PluginAuthModule;
import de.innovationgate.wgpublisher.modules.DatabasesOptionType;
import de.innovationgate.wgpublisher.modules.PluginsOptionType;
import de.innovationgate.wgpublisher.modules.TMLScriptCodeOptionType;
import de.innovationgate.wgpublisher.plugins.WGAPlugin;
public class PluginAuthModuleDefinition implements ModuleDefinition, RegistryAwareModuleDefinition, AvailabilityTestableModuleDefinition {
private LocalisationBundleLoader _bundleLoader = new LocalisationBundleLoader(WGUtils.getPackagePath(this.getClass()) + "/plugin", getClass().getClassLoader());
private ModuleRegistry _registry;
public String getDescription(Locale locale) {
return _bundleLoader.getBundle(locale).getString("auth.description");
}
public Class<? extends Object> getImplementationClass() {
return PluginAuthModule.class;
}
public Class<? extends ModuleType> getModuleType() {
return AuthenticationSourceModuleType.class;
}
public OptionDefinitionsMap getOptionDefinitions() {
OptionDefinitionsMap options = new OptionDefinitionsMap();
LocalizedOptionDefinition dbKey = new LocalizedOptionDefinition(CSAuthModule.COPTION_DBKEY, new PluginsOptionType(_registry, PluginsOptionType.USAGE_AUTHSOURCE), _bundleLoader);
options.addOption(dbKey);
return options;
}
public Object getProperties() {
return null;
}
public String getTitle(Locale locale) {
return _bundleLoader.getBundle(locale).getString("auth.title");
}
public void testDependencies() throws ModuleDependencyException {
}
public void injectRegistry(ModuleRegistry registry) {
_registry = registry;
}
public void testAvailability(ModuleRegistry reg) throws ModuleAvailabilityException {
WGACore core = (WGACore) reg.getContextObjects().get(WGACore.class);
if (core == null) {
throw new ModuleAvailabilityException("Cannot retrieve WGACore to test availability");
}
boolean pluginFound = false;
for (WGAPlugin plugin : core.getPluginSet().getPlugins()) {
if (plugin.isActive() && plugin.isValid() && plugin.getCsConfig().getPluginConfig().isUsageAsAuthSource()) {
pluginFound = true;
break;
}
}
if (!pluginFound) {
throw new ModuleAvailabilityException("No installed WGA Plugin offers authentication services");
}
}
}