/**
*
* Copyright 2003-2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.geronimo.security.jaas;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.geronimo.gbean.GBeanInfo;
import org.apache.geronimo.gbean.GBeanInfoBuilder;
import org.apache.geronimo.j2ee.j2eeobjectnames.NameFactory;
import org.apache.geronimo.kernel.Kernel;
import org.apache.geronimo.system.serverinfo.ServerInfo;
import org.apache.geronimo.security.jaas.server.JaasLoginModuleConfiguration;
/**
* Holds a reference to a login module and the control flag. A linked list of these forms the list of login modules
* in a GenericSecurityRealm.
*
* @version $Rev: 391894 $ $Date: 2006-04-06 06:00:33 +0200 (Thu, 06 Apr 2006) $
*/
public class JaasLoginModuleUse implements JaasLoginModuleChain {
// See also http://java.sun.com/j2se/1.4.2/docs/guide/security/jaas/JAASLMDevGuide.html for more standard login module option keys
public final static String KERNEL_NAME_LM_OPTION = "org.apache.geronimo.security.realm.GenericSecurityRealm.KERNEL";
public final static String SERVERINFO_LM_OPTION = "org.apache.geronimo.security.realm.GenericSecurityRealm.SERVERINFO";
public final static String CLASSLOADER_LM_OPTION = "org.apache.geronimo.security.realm.GenericSecurityRealm.CLASSLOADER";
private final LoginModuleSettings loginModule;
private final JaasLoginModuleUse next;
private LoginModuleControlFlag controlFlag;
private final Kernel kernel;
//for reference.
public JaasLoginModuleUse() {
loginModule = null;
next = null;
controlFlag = null;
kernel = null;
}
public JaasLoginModuleUse(LoginModuleSettings loginModule, JaasLoginModuleUse next, String controlFlag, Kernel kernel) {
this.loginModule = loginModule;
this.next = next;
LoginModuleControlFlagEditor editor = new LoginModuleControlFlagEditor();
editor.setAsText(controlFlag);
this.controlFlag = (LoginModuleControlFlag) editor.getValue();
this.kernel = kernel;
}
public LoginModuleSettings getLoginModule() {
return loginModule;
}
public JaasLoginModuleChain getNext() {
return next;
}
public String getLoginModuleName() {
//TODO configId which is correct?
// return kernel.getAbstractNameFor(loginModule).getObjectName().getCanonicalName();
return kernel.getAbstractNameFor(loginModule).toURI().toString();
}
public String getNextName() {
if(next == null) {
return null;
}
//TODO configId which is correct?
// return kernel.getAbstractNameFor(next).getObjectName().getCanonicalName();
return kernel.getAbstractNameFor(next).toURI().toString();
}
public String getControlFlag() {
return controlFlag.toString();
}
public void setControlFlag(String controlFlag) {
LoginModuleControlFlagEditor ed = new LoginModuleControlFlagEditor();
ed.setAsText(controlFlag);
this.controlFlag = (LoginModuleControlFlag) ed.getValue();
}
public void configure(Set domainNames, List loginModuleConfigurations, Kernel kernel, ServerInfo serverInfo, ClassLoader classLoader) {
Map options = loginModule.getOptions();
if (options != null) {
options = new HashMap(options);
} else {
options = new HashMap();
}
if (kernel != null && !options.containsKey(KERNEL_NAME_LM_OPTION)) {
options.put(KERNEL_NAME_LM_OPTION, kernel.getKernelName());
}
if (serverInfo != null && !options.containsKey(SERVERINFO_LM_OPTION)) {
options.put(SERVERINFO_LM_OPTION, serverInfo);
}
if (classLoader != null && !options.containsKey(CLASSLOADER_LM_OPTION)) {
options.put(CLASSLOADER_LM_OPTION, classLoader);
}
if (loginModule.getLoginDomainName() != null) {
if (domainNames.contains(loginModule.getLoginDomainName())) {
throw new IllegalStateException("Error in realm: one security realm cannot contain multiple login modules for the same login domain");
} else {
domainNames.add(loginModule.getLoginDomainName());
}
}
JaasLoginModuleConfiguration config = new JaasLoginModuleConfiguration(loginModule.getLoginModuleClass(), controlFlag, options, loginModule.isServerSide(), loginModule.getLoginDomainName(), loginModule.isWrapPrincipals(), loginModule.getClassLoader());
loginModuleConfigurations.add(config);
if (next != null) {
next.configure(domainNames, loginModuleConfigurations, kernel, serverInfo, classLoader);
}
}
public static final GBeanInfo GBEAN_INFO;
static {
GBeanInfoBuilder infoBuilder = GBeanInfoBuilder.createStatic(JaasLoginModuleUse.class, "LoginModuleUse");
infoBuilder.addAttribute("controlFlag", String.class, true);
infoBuilder.addAttribute("kernel", Kernel.class, false, false);
infoBuilder.addReference("LoginModule", LoginModuleSettings.class, NameFactory.LOGIN_MODULE);
infoBuilder.addReference("Next", JaasLoginModuleUse.class);
infoBuilder.addOperation("configure", new Class[]{Set.class, List.class, Kernel.class, ServerInfo.class, ClassLoader.class});
infoBuilder.addInterface(JaasLoginModuleChain.class);
infoBuilder.setConstructor(new String[]{"LoginModule", "Next", "controlFlag", "kernel"});
GBEAN_INFO = infoBuilder.getBeanInfo();
}
public static GBeanInfo getGBeanInfo() {
return GBEAN_INFO;
}
}