org.filesys.server.config.SecurityConfigSection Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfileserver Show documentation
Show all versions of jfileserver Show documentation
Java file server with SMB, FTP/FTPS and NFS support, virtual filesystems, database filesystems
/*
* Copyright (C) 2006-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see m_domainMappings;
/**
* Class constructor
*
* @param config ServerConfiguration
*/
public SecurityConfigSection(ServerConfiguration config) {
super(SectionName, config);
// Create the default users interface
m_usersInterface = new DefaultUsersInterface();
try {
m_usersInterface.initializeUsers(config, null);
}
catch (InvalidConfigurationException ex) {
}
// Create the default share mapper
m_shareMapper = new DefaultShareMapper();
try {
m_shareMapper.initializeMapper(config, new GenericConfigElement("shareMapper"));
}
catch (InvalidConfigurationException ex) {
}
}
/**
* Check if there is an access control manager configured
*
* @return boolean
*/
public final boolean hasAccessControlManager() {
return m_aclManager != null ? true : false;
}
/**
* Get the access control manager that is used to control per share access
*
* @return AccessControlManager
*/
public final AccessControlManager getAccessControlManager() {
return m_aclManager;
}
/**
* Check if the global access control list is configured
*
* @return boolean
*/
public final boolean hasGlobalAccessControls() {
return m_globalACLs != null ? true : false;
}
/**
* Return the global access control list
*
* @return AccessControlList
*/
public final AccessControlList getGlobalAccessControls() {
return m_globalACLs;
}
/**
* Return the access control manager initialization parameters
*
* @return ConfigElement
*/
public final ConfigElement getAccessControlManagerParameters() {
return m_aclParams;
}
/**
* Return the share mapper
*
* @return ShareMapper
*/
public final ShareMapper getShareMapper() {
return m_shareMapper;
}
/**
* Return the share mapper initialization parameters
*
* @return ConfigElement
*/
public final ConfigElement getShareMapperParameters() {
return m_mapperParams;
}
/**
* Return the user account list.
*
* @return UserAccountList
*/
public final UserAccountList getUserAccounts() {
return m_userList;
}
/**
* Return the users interface
*
* @return UsersInterface
*/
public final UsersInterface getUsersInterface() {
return m_usersInterface;
}
/**
* Return the JCE provider class name
*
* @return String
*/
public final String getJCEProvider() {
return m_jceProviderClass;
}
/**
* Determine if there are any user accounts defined.
*
* @return boolean
*/
public final boolean hasUserAccounts() {
if (m_userList != null && m_userList.numberOfUsers() > 0)
return true;
return false;
}
/**
* Check if there are any domain mappings defined
*
* @return boolean
*/
public final boolean hasDomainMappings() {
return m_domainMappings != null ? true : false;
}
/**
* Return the domain mappings
*
* @return List of domain mappings
*/
public final List getDomainMappings() {
return m_domainMappings;
}
/**
* Set the access control manager to be used to control per share access
*
* @param aclMgrClass String
* @param params ConfigElement
* @return int
* @exception InvalidConfigurationException Error setting the access control manager class
*/
public final int setAccessControlManager(String aclMgrClass, ConfigElement params)
throws InvalidConfigurationException {
// Validate the access control manager class
int sts = ConfigurationListener.StsIgnored;
AccessControlManager aclMgr = null;
try {
// Load the access control manager class
Object aclObj = Class.forName(aclMgrClass).newInstance();
if (aclObj instanceof AccessControlManager) {
// Set the ACL manager
aclMgr = (AccessControlManager) aclObj;
} else
throw new InvalidConfigurationException("Access control manager does not implement required interface");
}
catch (ClassNotFoundException ex) {
throw new InvalidConfigurationException("Access control manager class " + aclMgrClass + " not found");
}
catch (Exception ex) {
throw new InvalidConfigurationException("Access control manager class error");
}
// Initialize the access control manager using the parameter values
aclMgr.initialize(getServerConfiguration(), params);
// Inform listeners, validate the configuration change
sts = setAccessControlManager(aclMgr);
// Set initialization parameters
m_aclParams = params;
// Return the change status
return sts;
}
/**
* Set the access control manager to be used to control per share access
*
* @param aclMgr the access control manager to be used to control per share access
* @return int
* @exception InvalidConfigurationException Error setting the access control manager class
*/
public final int setAccessControlManager(AccessControlManager aclMgr)
throws InvalidConfigurationException {
// Inform listeners, validate the configuration change
int sts = fireConfigurationChange(ConfigId.SecurityACLManager, aclMgr);
// Set the server access control manager
m_aclManager = aclMgr;
// Return the change status
return sts;
}
/**
* Set the JCE provider
*
* @param providerClass String
* @return int
* @exception InvalidConfigurationException Error setting the JCE provider class
*/
public final int setJCEProvider(String providerClass)
throws InvalidConfigurationException {
// Validate the JCE provider class
int sts = ConfigurationListener.StsIgnored;
try {
// Load the JCE provider class and validate
Object jceObj = Class.forName(providerClass).newInstance();
if (jceObj instanceof java.security.Provider) {
// Inform listeners, validate the configuration change
Provider jceProvider = (Provider) jceObj;
sts = fireConfigurationChange(ConfigId.SecurityJCEProvider, jceProvider);
// Save the JCE provider class name
m_jceProviderClass = providerClass;
// Add the JCE provider
Security.addProvider(jceProvider);
} else
throw new InvalidConfigurationException("JCE provider class is not a valid Provider class");
}
catch (ClassNotFoundException ex) {
throw new InvalidConfigurationException("JCE provider class " + providerClass + " not found");
}
catch (Exception ex) {
throw new InvalidConfigurationException("JCE provider class error");
}
// Return the change status
return sts;
}
/**
* Set the share mapper
*
* @param mapperClass String
* @param params ConfigElement
* @return int
* @exception InvalidConfigurationException Error setting the share mapper class
*/
public final int setShareMapper(String mapperClass, ConfigElement params)
throws InvalidConfigurationException {
// Validate the share mapper class
int sts = ConfigurationListener.StsIgnored;
try {
// Load the share mapper class
Object mapperObj = Class.forName(mapperClass).newInstance();
if (mapperObj instanceof ShareMapper) {
// Initialize the share mapper
ShareMapper shareMapper = (ShareMapper) mapperObj;
shareMapper.initializeMapper(getServerConfiguration(), params);
// Inform listeners, validate the configuration change
sts = setShareMapper(shareMapper);
// Set the initialization parameters
m_mapperParams = params;
} else
throw new InvalidConfigurationException("Share mapper class is not implementation of ShareMapper interface");
}
catch (ClassNotFoundException ex) {
throw new InvalidConfigurationException("Share mapper class " + mapperClass + " not found");
}
catch (Exception ex) {
throw new InvalidConfigurationException("Share mapper class error");
}
// Return the change status
return sts;
}
/**
* Set the share mapper
*
* @param shareMapper pre-initialized share mapper
* @return int
* @exception InvalidConfigurationException Error setting the share mapper class
*/
public final int setShareMapper(ShareMapper shareMapper) throws InvalidConfigurationException {
// Inform listeners, validate the configuration change
int sts = fireConfigurationChange(ConfigId.ShareMapper, shareMapper);
// Set the share mapper
m_shareMapper = shareMapper;
// Return the change status
return sts;
}
/**
* Set the user account list.
*
* @param users UserAccountList
* @return int
* @exception InvalidConfigurationException Error setting the user account list
*/
public final int setUserAccounts(UserAccountList users)
throws InvalidConfigurationException {
// Inform listeners, validate the configuration change
int sts = fireConfigurationChange(ConfigId.UsersList, users);
m_userList = users;
// Return the change status
return sts;
}
/**
* Set the users interface to provide user account information
*
* @param usersClass String
* @param params ConfigElement
* @return int
* @exception InvalidConfigurationException Error setting the users interface class
*/
public final int setUsersInterface(String usersClass, ConfigElement params)
throws InvalidConfigurationException {
// Validate the users interface access class
int sts = ConfigurationListener.StsIgnored;
UsersInterface usersIface = null;
try {
// Load the users interface class
Object usersObj = Class.forName(usersClass).newInstance();
if (usersObj instanceof UsersInterface) {
// Set the users interface
usersIface = (UsersInterface) usersObj;
} else
throw new InvalidConfigurationException("Users interface class does not implement required interface");
}
catch (ClassNotFoundException ex) {
throw new InvalidConfigurationException("Users interface class " + usersClass + " not found");
}
catch (Exception ex) {
throw new InvalidConfigurationException("Users interface class error");
}
// Initialize the users interface using the parameter values
usersIface.initializeUsers(getServerConfiguration(), params);
// Inform listeners, validate the configuration change
sts = fireConfigurationChange(ConfigId.SecurityUsersInterface, usersIface);
// Set the users interface and initialization parameters
m_usersInterface = usersIface;
// Return the change status
return sts;
}
/**
* Set the users interface to provide user account information
*
* @param usersIface UsersInterface
* @return int
* @exception InvalidConfigurationException Error setting the users interface class
*/
public final int setUsersInterface( UsersInterface usersIface)
throws InvalidConfigurationException {
// Inform listeners, validate the configuration change
int sts = fireConfigurationChange(ConfigId.SecurityUsersInterface, usersIface);
// Set the users interface and initialization parameters
m_usersInterface = usersIface;
// Return the change status
return sts;
}
/**
* Set the global access control list
*
* @param acls AccessControlList
* @return int
* @exception InvalidConfigurationException Error setting the global access control list
*/
public final int setGlobalAccessControls(AccessControlList acls)
throws InvalidConfigurationException {
// Inform listeners, validate the configuration change
int sts = fireConfigurationChange(ConfigId.SecurityGlobalACLs, acls);
m_globalACLs = acls;
// Return the change status
return sts;
}
/**
* Add a domain mapping
*
* @param mapping DomainMapping
*/
public final void addDomainMapping(DomainMapping mapping) {
if (m_domainMappings == null)
m_domainMappings = new ArrayList();
m_domainMappings.add(mapping);
}
}