Package org.apache.sshd.common.file.nativefs

Class NativeFileSystemFactory

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.file.nativefs.NativeFileSystemFactory

All Implemented Interfaces:

FileSystemFactory

public class NativeFileSystemFactory
extends AbstractLoggingBean
implements FileSystemFactory

Native file system factory. It uses the OS file system.

Author:

Apache MINA Project

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_USERS_HOME
static NativeFileSystemFactory	INSTANCE

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor	Description
NativeFileSystemFactory()
NativeFileSystemFactory(boolean createHome)

Method Summary

Modifier and Type	Method	Description
FileSystem	createFileSystem(SessionContext session)	Create user specific file system.
Path	getUserHomeDir(SessionContext session)
String	getUsersHomeDir()
boolean	isCreateHome()	Should the home directories be created automatically
void	setCreateHome(boolean createHome)	Set if the home directories be created automatically
void	setUsersHomeDir(String usersHomeDir)	Set the root location where users home is to be created

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_USERS_HOME

public static final String DEFAULT_USERS_HOME

INSTANCE

public static final NativeFileSystemFactory INSTANCE

Constructor Detail

NativeFileSystemFactory

public NativeFileSystemFactory()

NativeFileSystemFactory

public NativeFileSystemFactory(boolean createHome)

Method Detail

getUsersHomeDir

public String getUsersHomeDir()

Returns:

The root location where users home is to be created - never null/empty.

setUsersHomeDir

public void setUsersHomeDir(String usersHomeDir)

Set the root location where users home is to be created

Parameters:

usersHomeDir - The root location where users home is to be created - never null/empty.

See Also:

isCreateHome()

isCreateHome

public boolean isCreateHome()

Should the home directories be created automatically

Returns:

true if the file system will create the home directory if not available

setCreateHome

public void setCreateHome(boolean createHome)

Set if the home directories be created automatically

Parameters:

createHome - true if the file system should create the home directory automatically if not available

See Also:

getUsersHomeDir()

getUserHomeDir

public Path getUserHomeDir(SessionContext session)
                    throws IOException

Specified by:

getUserHomeDir in interface FileSystemFactory

Parameters:

session - The session created for the user

Returns:

The recommended user home directory - null if none

Throws:

IOException - If failed to resolve user's home directory

createFileSystem

public FileSystem createFileSystem(SessionContext session)
                            throws IOException

Description copied from interface: FileSystemFactory

Create user specific file system.

Specified by:

createFileSystem in interface FileSystemFactory

Parameters:

session - The session created for the user

Returns:

The current FileSystem for the provided session

Throws:

IOException - if the file system can not be created