org.apache.ftpserver.ftplet
Interface User

All Known Implementing Classes:

BaseUser

public interface User

Basic user interface.

Author:

Apache MINA Project

Method Summary

AuthorizationRequest	authorize(AuthorizationRequest request) Authorize a AuthorizationRequest for this user
List<Authority>	getAuthorities() Get all authorities granted to this user
List<Authority>	getAuthorities(Class<? extends Authority> clazz) Get authorities of the specified type granted to this user
boolean	getEnabled() Get the user enable status.
String	getHomeDirectory() Get the user home directory
int	getMaxIdleTime() Get the maximum idle time in seconds.
String	getName() Get the user name.
String	getPassword() Get password.

Method Detail

getName

String getName()

Get the user name.

Returns:

The user name, the same used for login

getPassword

String getPassword()

Get password.

Returns:

The users password or null if the user manager can not provide the password

getAuthorities

List<Authority> getAuthorities()

Get all authorities granted to this user

Returns:

All authorities

getAuthorities

List<Authority> getAuthorities(Class<? extends Authority> clazz)

Get authorities of the specified type granted to this user

Parameters:

clazz - The type of Authority

Returns:

Authorities of the specified class

authorize

AuthorizationRequest authorize(AuthorizationRequest request)

Authorize a AuthorizationRequest for this user

Parameters:

request - The AuthorizationRequest to authorize

Returns:

A populated AuthorizationRequest if the user was authorized, null otherwise.

getMaxIdleTime

int getMaxIdleTime()

Get the maximum idle time in seconds. Zero or less idle time means no limit.

Returns:

The idle time in seconds

getEnabled

boolean getEnabled()

Get the user enable status.

Returns:

true if the user is enabled

getHomeDirectory

String getHomeDirectory()

Get the user home directory

Returns:

The path to the home directory for the user