001/* 
002    Licensed to the Apache Software Foundation (ASF) under one
003    or more contributor license agreements.  See the NOTICE file
004    distributed with this work for additional information
005    regarding copyright ownership.  The ASF licenses this file
006    to you under the Apache License, Version 2.0 (the
007    "License"); you may not use this file except in compliance
008    with the License.  You may obtain a copy of the License at
009
010       http://www.apache.org/licenses/LICENSE-2.0
011
012    Unless required by applicable law or agreed to in writing,
013    software distributed under the License is distributed on an
014    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015    KIND, either express or implied.  See the License for the
016    specific language governing permissions and limitations
017    under the License.  
018 */
019package org.apache.wiki.auth.login;
020
021import javax.security.auth.callback.Callback;
022
023import org.apache.wiki.auth.user.UserDatabase;
024
025/**
026 * Callback for requesting and supplying a wiki UserDatabase. This callback is
027 * used by LoginModules that need access to a user database for looking up users
028 * by id.
029 * @since 2.3
030 */
031public class UserDatabaseCallback implements Callback
032{
033
034    private UserDatabase m_database;
035
036    /**
037     * Returns the user database object. LoginModules call this method after a
038     * CallbackHandler sets the user database.
039     * @return the user database
040     */
041    public UserDatabase getUserDatabase()
042    {
043        return m_database;
044    }
045
046    /**
047     * Sets the user database. CallbackHandler objects call this method..
048     * @param database the user database
049     */
050    public void setUserDatabase( UserDatabase database )
051    {
052        this.m_database = database;
053    }
054
055}