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 org.apache.wiki.api.core.Engine; 022 023import javax.security.auth.callback.Callback; 024 025 026/** 027 * Callback for requesting and supplying the WikiEngine object required by a LoginModule. This Callback is used by LoginModules needing 028 * access to the external authorizer or group manager. 029 * 030 * @since 2.5 031 */ 032public class WikiEngineCallback implements Callback { 033 034 private Engine m_engine; 035 036 /** 037 * Sets the engine object. CallbackHandler objects call this method. 038 * 039 * @param engine the engine 040 */ 041 public void setEngine( final Engine engine ) { 042 m_engine = engine; 043 } 044 045 /** 046 * Returns the engine. LoginModules call this method after a CallbackHandler sets the engine. 047 * 048 * @return the engine 049 */ 050 public Engine getEngine() { 051 return m_engine; 052 } 053 054}