org.apache.geronimo.security.realm.SecurityRealm Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geronimo-security Show documentation

The newest version!

/**
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You 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.realm;

import org.apache.geronimo.security.jaas.JaasLoginModuleChain;


/**
 * @version $Rev: 554977 $ $Date: 2007-07-10 23:32:56 +0800 (Tue, 10 Jul 2007) $
 */
public interface SecurityRealm extends org.apache.geronimo.management.geronimo.SecurityRealm {

    /**
     * If this attribute is true, then the principals will be wrapped in
     * realm principals.
     */
    public boolean isWrapPrincipals();

    /**
     * Gets a list of the login domains that make up this security realm.  A
     * particular LoginModule represents 0 or 1 login domains, and a realm is
     * composed of a number of login modules, so the realm may cover any
     * number of login domains, though typically that number will be 1.
     */
    public String[] getLoginDomains();

    /**
     * Gets the first JaasLoginModuleChain node in the chain of LoginModules
     * for this realm.
     */
    public JaasLoginModuleChain getLoginModuleChain();
}