java.lang.Object
- org.alfresco.filesys.auth.ftp.FTPAuthenticatorBase

All Implemented Interfaces:

org.alfresco.jlan.ftp.FTPAuthenticator, ActivateableBean, org.springframework.beans.factory.DisposableBean

Direct Known Subclasses:

AbstractChainingFtpAuthenticator, AlfrescoFtpAuthenticator
```
public abstract class FTPAuthenticatorBase
extends java.lang.Object
implements org.alfresco.jlan.ftp.FTPAuthenticator, ActivateableBean, org.springframework.beans.factory.DisposableBean
```
Author:

gkspencer

Field Summary

Fields
Modifier and Type	Field	Description
`protected static org.apache.commons.logging.Log`	`logger`
`protected org.alfresco.jlan.server.config.ServerConfigurationAccessor`	`serverConfiguration`

Constructor Summary

Constructors
Constructor Description

FTPAuthenticatorBase()
Default constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract boolean`	`authenticateUser(org.alfresco.jlan.server.auth.ClientInfo info, org.alfresco.jlan.ftp.FTPSrvSession sess)`	Authenticate the user
`protected void`	`checkForAdminUserName(org.alfresco.jlan.server.auth.ClientInfo cInfo)`	Check if the user is an administrator user name
`void`	`closeAuthenticator()`	Close the authenticator, perform any cleanup
`protected javax.transaction.UserTransaction`	`createTransaction()`	Create a transaction, this will be a wrteable transaction unless the system is in read-only mode.
`void`	`destroy()`	Handle tidy up on container shutdown
`protected AuthenticationComponent`	`getAuthenticationComponent()`	Return the authentication componenet
`protected AuthenticationService`	`getAuthenticationService()`	Return the authentication service
`protected AuthorityService`	`getAuthorityService()`	Return the authority service
`protected TransactionService`	`getTransactionService()`	Return the transaction service
`void`	`initialize()`	Initialize the authenticator (after properties have been set)
`void`	`initialize(org.alfresco.jlan.server.config.ServerConfiguration config, org.springframework.extensions.config.ConfigElement params)`	Initialize the authenticator
`boolean`	`isActive()`	Determines whether this bean is active.
`void`	`setActive(boolean active)`	Activates or deactivates the bean.
`void`	`setAuthenticationComponent(AuthenticationComponent authenticationComponent)`
`void`	`setAuthenticationService(AuthenticationService authenticationService)`
`void`	`setAuthorityService(AuthorityService authorityService)`
`void`	`setConfig(org.alfresco.jlan.server.config.ServerConfigurationAccessor config)`
`void`	`setTransactionService(TransactionService transactionService)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
protected static final org.apache.commons.logging.Log logger
```
  - serverConfiguration
```
protected org.alfresco.jlan.server.config.ServerConfigurationAccessor serverConfiguration
```
- Constructor Detail
  - FTPAuthenticatorBase
```
public FTPAuthenticatorBase()
```
    Default constructor
- Method Detail
  - setConfig
```
public void setConfig(org.alfresco.jlan.server.config.ServerConfigurationAccessor config)
```
  - setAuthenticationComponent
```
public void setAuthenticationComponent(AuthenticationComponent authenticationComponent)
```
  - setAuthenticationService
```
public void setAuthenticationService(AuthenticationService authenticationService)
```
  - setTransactionService
```
public void setTransactionService(TransactionService transactionService)
```
  - setAuthorityService
```
public void setAuthorityService(AuthorityService authorityService)
```
  - isActive
```
public boolean isActive()
```
    Description copied from interface: ActivateableBean
    
    Determines whether this bean is active.
    
    Specified by:
    
    isActive in interface ActivateableBean
    
    Returns:
    
    true if this bean is active
  - setActive
```
public void setActive(boolean active)
```
    Activates or deactivates the bean.
    
    Parameters:
    
    active - true if the bean is active and initialization should complete
  - initialize
```
public void initialize(org.alfresco.jlan.server.config.ServerConfiguration config,
                       org.springframework.extensions.config.ConfigElement params)
                throws org.alfresco.jlan.server.config.InvalidConfigurationException
```
    Initialize the authenticator
    
    Specified by:
    
    initialize in interface org.alfresco.jlan.ftp.FTPAuthenticator
    
    Parameters:
    
    config - ServerConfiguration
    
    params - ConfigElement
    
    Throws:
    
    org.alfresco.jlan.server.config.InvalidConfigurationException
  - initialize
```
public void initialize()
                throws org.alfresco.jlan.server.config.InvalidConfigurationException
```
    Initialize the authenticator (after properties have been set)
    
    Throws:
    
    org.alfresco.jlan.server.config.InvalidConfigurationException
  - authenticateUser
```
public abstract boolean authenticateUser(org.alfresco.jlan.server.auth.ClientInfo info,
                                         org.alfresco.jlan.ftp.FTPSrvSession sess)
```
    Authenticate the user
    
    Specified by:
    
    authenticateUser in interface org.alfresco.jlan.ftp.FTPAuthenticator
    
    Parameters:
    
    info - ClientInfo
    
    sess - FTPSrvSession
    
    Returns:
    
    boolean
  - closeAuthenticator
```
public void closeAuthenticator()
```
    Close the authenticator, perform any cleanup
    
    Specified by:
    
    closeAuthenticator in interface org.alfresco.jlan.ftp.FTPAuthenticator
  - getAuthenticationComponent
```
protected final AuthenticationComponent getAuthenticationComponent()
```
    Return the authentication componenet
    
    Returns:
    
    AuthenticationComponent
  - getAuthenticationService
```
protected final AuthenticationService getAuthenticationService()
```
    Return the authentication service
    
    Returns:
    
    AuthenticationService
  - getTransactionService
```
protected final TransactionService getTransactionService()
```
    Return the transaction service
    
    Returns:
    
    TransactionService
  - getAuthorityService
```
protected final AuthorityService getAuthorityService()
```
    Return the authority service
    
    Returns:
    
    AuthorityService
  - checkForAdminUserName
```
protected final void checkForAdminUserName(org.alfresco.jlan.server.auth.ClientInfo cInfo)
```
    Check if the user is an administrator user name
    
    Parameters:
    
    cInfo - ClientInfo
  - createTransaction
```
protected final javax.transaction.UserTransaction createTransaction()
```
    Create a transaction, this will be a wrteable transaction unless the system is in read-only mode. return UserTransaction
  - destroy
```
public void destroy()
```
    Handle tidy up on container shutdown
    
    Specified by:
    
    destroy in interface org.springframework.beans.factory.DisposableBean

Class FTPAuthenticatorBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

serverConfiguration

Constructor Detail

FTPAuthenticatorBase

Method Detail

setConfig

setAuthenticationComponent

setAuthenticationService

setTransactionService

setAuthorityService

isActive

setActive

initialize

initialize

authenticateUser

closeAuthenticator

getAuthenticationComponent

getAuthenticationService

getTransactionService

getAuthorityService

checkForAdminUserName

createTransaction

destroy