org.apache.ftpserver.usermanager
Class UserFactory

java.lang.Object
  extended by org.apache.ftpserver.usermanager.UserFactory

public class UserFactory
extends Object

Factory for User instances.

Author:
Apache MINA Project

Constructor Summary
UserFactory()
           
 
Method Summary
 User createUser()
          Creates a user based on the configuration set on the factory
 List<? extends Authority> getAuthorities()
          Get the authorities for users created by this factory
 String getHomeDirectory()
          Get the home directory for users created by this factory
 int getMaxIdleTime()
          Get the max idle time for users created by this factory
 String getName()
          Get the user name for users created by this factory
 String getPassword()
          Get the password for users created by this factory
 boolean isEnabled()
          Get the enabled status for users created by this factory
 void setAuthorities(List<Authority> authorities)
          Set the authorities for users created by this factory
 void setEnabled(boolean isEnabled)
          Get the enabled status for users created by this factory
 void setHomeDirectory(String homeDir)
          Set the user name for users created by this factory
 void setMaxIdleTime(int maxIdleTimeSec)
          Set the user name for users created by this factory
 void setName(String name)
          Set the user name for users created by this factory
 void setPassword(String password)
          Set the user name for users created by this factory
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserFactory

public UserFactory()
Method Detail

createUser

public User createUser()
Creates a user based on the configuration set on the factory

Returns:
The created user

getName

public String getName()
Get the user name for users created by this factory

Returns:
The user name

setName

public void setName(String name)
Set the user name for users created by this factory

Parameters:
name - The user name

getPassword

public String getPassword()
Get the password for users created by this factory

Returns:
The password

setPassword

public void setPassword(String password)
Set the user name for users created by this factory

Parameters:
password - The password

getMaxIdleTime

public int getMaxIdleTime()
Get the max idle time for users created by this factory

Returns:
The max idle time in seconds

setMaxIdleTime

public void setMaxIdleTime(int maxIdleTimeSec)
Set the user name for users created by this factory

Parameters:
maxIdleTimeSec - The max idle time in seconds

getHomeDirectory

public String getHomeDirectory()
Get the home directory for users created by this factory

Returns:
The home directory path

setHomeDirectory

public void setHomeDirectory(String homeDir)
Set the user name for users created by this factory

Parameters:
homeDir - The home directory path

isEnabled

public boolean isEnabled()
Get the enabled status for users created by this factory

Returns:
true if the user is enabled (allowed to log in)

setEnabled

public void setEnabled(boolean isEnabled)
Get the enabled status for users created by this factory

Parameters:
isEnabled - true if the user should be enabled (allowed to log in)

getAuthorities

public List<? extends Authority> getAuthorities()
Get the authorities for users created by this factory

Returns:
The authorities

setAuthorities

public void setAuthorities(List<Authority> authorities)
Set the authorities for users created by this factory

Parameters:
authorities - The authorities


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.