/****************************************************************
* 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.james.remotemanager;
import org.apache.avalon.cornerstone.services.connection.ConnectionHandler;
import org.apache.avalon.excalibur.pool.DefaultPool;
import org.apache.avalon.excalibur.pool.HardResourceLimitingPool;
import org.apache.avalon.excalibur.pool.ObjectFactory;
import org.apache.avalon.excalibur.pool.Pool;
import org.apache.avalon.excalibur.pool.Poolable;
import org.apache.avalon.framework.activity.Initializable;
import org.apache.avalon.framework.service.ServiceException;
import org.apache.avalon.framework.service.ServiceManager;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.avalon.framework.logger.LogEnabled;
import org.apache.james.core.AbstractJamesService;
import org.apache.james.services.MailServer;
import org.apache.james.services.UsersRepository;
import org.apache.james.services.UsersStore;
import org.apache.james.util.watchdog.Watchdog;
import org.apache.james.util.watchdog.WatchdogFactory;
import java.util.HashMap;
/**
* Provides a really rude network interface to administer James.
* Allow to add accounts.
* TODO: -improve protocol
* -add remove user
* -much more...
* @version 1.0.0, 24/04/1999
*/
public class RemoteManager
extends AbstractJamesService implements RemoteManagerMBean {
/**
* A HashMap of (user id, passwords) for James administrators
*/
private HashMap adminAccounts = new HashMap();
/**
* The UsersStore that contains all UsersRepositories managed by this RemoteManager
*/
private UsersStore usersStore;
/**
* The current UsersRepository being managed/viewed/modified
*/
private UsersRepository users;
/**
* The service prompt to be displayed when waiting for input.
*/
private String prompt = "";
/**
* The reference to the internal MailServer service
*/
private MailServer mailServer;
/**
* The pool used to provide RemoteManager Handler objects
*/
private Pool theHandlerPool = null;
/**
* The pool used to provide RemoteManager Handler objects
*/
private ObjectFactory theHandlerFactory = new RemoteManagerHandlerFactory();
/**
* The factory used to generate Watchdog objects
*/
private WatchdogFactory theWatchdogFactory;
/**
* The configuration data to be passed to the handler
*/
private RemoteManagerHandlerConfigurationData theConfigData
= new RemoteManagerHandlerConfigurationDataImpl();
/**
* @see org.apache.avalon.framework.service.Serviceable#service(ServiceManager)
*/
public void service( final ServiceManager componentManager )
throws ServiceException {
super.service(componentManager);
mailServer = (MailServer)componentManager.
lookup( MailServer.ROLE );
usersStore = (UsersStore)componentManager.
lookup( UsersStore.ROLE );
users = (UsersRepository) componentManager.lookup(UsersRepository.ROLE);
if (users == null) {
throw new ServiceException("","The user repository could not be found.");
}
}
/**
* @see org.apache.avalon.framework.configuration.Configurable#configure(Configuration)
*/
public void configure( final Configuration configuration )
throws ConfigurationException {
super.configure(configuration);
if (isEnabled()) {
Configuration handlerConfiguration = configuration.getChild("handler");
Configuration admin = handlerConfiguration.getChild( "administrator_accounts" );
Configuration[] accounts = admin.getChildren( "account" );
for ( int i = 0; i < accounts.length; i++ ) {
adminAccounts.put( accounts[ i ].getAttribute( "login" ),
accounts[ i ].getAttribute( "password" ) );
}
Configuration promtConfiguration = handlerConfiguration.getChild("prompt", false);
if (promtConfiguration != null) prompt = promtConfiguration.getValue();
if (prompt == null) prompt = "";
else if (!prompt.equals("") && !prompt.endsWith(" ")) prompt += " ";
}
}
/**
* @see org.apache.avalon.framework.activity.Initializable#initialize()
*/
public void initialize() throws Exception {
super.initialize();
if (!isEnabled()) {
return;
}
if (connectionLimit != null) {
theHandlerPool = new HardResourceLimitingPool(theHandlerFactory, 5, connectionLimit.intValue());
getLogger().debug("Using a bounded pool for RemoteManager handlers with upper limit " + connectionLimit.intValue());
} else {
// NOTE: The maximum here is not a real maximum. The handler pool will continue to
// provide handlers beyond this value.
theHandlerPool = new DefaultPool(theHandlerFactory, null, 5, 30);
getLogger().debug("Using an unbounded pool for RemoteManager handlers.");
}
if (theHandlerPool instanceof LogEnabled) {
((LogEnabled)theHandlerPool).enableLogging(getLogger());
}
if (theHandlerPool instanceof Initializable) {
((Initializable)theHandlerPool).initialize();
}
theWatchdogFactory = getWatchdogFactory();
}
/**
* @see org.apache.james.core.AbstractJamesService#getDefaultPort()
*/
protected int getDefaultPort() {
return 4555;
}
/**
* @see org.apache.james.core.AbstractJamesService#getServiceType()
*/
public String getServiceType() {
return "Remote Manager Service";
}
/**
* @see org.apache.avalon.cornerstone.services.connection.AbstractHandlerFactory#newHandler()
*/
protected ConnectionHandler newHandler()
throws Exception {
RemoteManagerHandler theHandler = (RemoteManagerHandler)theHandlerPool.get();
theHandler.enableLogging(getLogger());
Watchdog theWatchdog = theWatchdogFactory.getWatchdog(theHandler.getWatchdogTarget());
theHandler.setConfigurationData(theConfigData);
theHandler.setWatchdog(theWatchdog);
return theHandler;
}
/**
* @see org.apache.avalon.cornerstone.services.connection.ConnectionHandlerFactory#releaseConnectionHandler(ConnectionHandler)
*/
public void releaseConnectionHandler( ConnectionHandler connectionHandler ) {
if (!(connectionHandler instanceof RemoteManagerHandler)) {
throw new IllegalArgumentException("Attempted to return non-RemoteManagerHandler to pool.");
}
theHandlerPool.put((Poolable)connectionHandler);
}
/**
* The factory for producing handlers.
*/
private static class RemoteManagerHandlerFactory
implements ObjectFactory {
/**
* @see org.apache.avalon.excalibur.pool.ObjectFactory#newInstance()
*/
public Object newInstance() throws Exception {
return new RemoteManagerHandler();
}
/**
* @see org.apache.avalon.excalibur.pool.ObjectFactory#getCreatedClass()
*/
public Class getCreatedClass() {
return RemoteManagerHandler.class;
}
/**
* @see org.apache.avalon.excalibur.pool.ObjectFactory#decommision(Object)
*/
public void decommission( Object object ) throws Exception {
return;
}
}
/**
* A class to provide RemoteManager handler configuration to the handlers
*/
private class RemoteManagerHandlerConfigurationDataImpl
implements RemoteManagerHandlerConfigurationData {
/**
* @see org.apache.james.remotemanager.RemoteManagerHandlerConfigurationData#getHelloName()
*/
public String getHelloName() {
return RemoteManager.this.helloName;
}
/**
* @see org.apache.james.remotemanager.RemoteManagerHandlerConfigurationData#getMailServer()
*/
public MailServer getMailServer() {
return RemoteManager.this.mailServer;
}
/**
* @see org.apache.james.remotemanager.RemoteManagerHandlerConfigurationData#getUsersRepository()
*/
public UsersRepository getUsersRepository() {
return RemoteManager.this.users;
}
/**
* @see org.apache.james.remotemanager.RemoteManagerHandlerConfigurationData#getUsersStore()
*/
public UsersStore getUserStore() {
return RemoteManager.this.usersStore;
}
/**
* @see org.apache.james.remotemanager.RemoteManagerHandlerConfigurationData#getAdministrativeAccountData()
*/
public HashMap getAdministrativeAccountData() {
return RemoteManager.this.adminAccounts;
}
/**
* @see org.apache.james.remotemanager.RemoteManagerHandlerConfigurationData#getPrompt()
*/
public String getPrompt() {
return RemoteManager.this.prompt;
}
}
}
|
