|
|
FtpServerMBean documentation
Bean Description
>
List of attributes
>
List of operations
>
Attributes declaration
>
Operations declaration
Bean Description
Description : Management d'un serveur FTP
Type : net.sbbi.jafs.config.FtpServer
Domain : servers
ClassName : net.sbbi.jafs.management.FtpServerMBean
List of attributes
activeDownRangePort,
activeSessionsCount,
activeUpRangePort,
authenticationRealm,
closedMessage,
disclamerMessage,
loginMessage,
logoutMessage,
maxSessionsNumber,
maxSessionsNumberPerIP,
networkInterface,
open,
pasv,
pasvAllowFXP,
pasvDownRangePort,
pasvNATMappingsOnTheFly,
pasvUpRangePort,
pendingChanges,
reverseLookup,
serverFirewallPort,
serverPort,
serverRoot,
socketConnectTimeout,
SSLCertsConfName,
SSLDefaultProt,
SSLNeedCert,
SSLServer,
timeOutNotIdentified,
WANAccess,
warnClientsDuringShutdown
List of operations
applyChanges,
changePortsRange,
changeServerPort,
closeServer,
closeServerMsg,
deleteFileSystemEntry,
getAvailableCiphers,
getAvailableCommands,
getConfiguredCiphers,
getConfiguredCommands,
getConfiguredIPBlackListParsers,
getFileSystemEntries,
getIPBlackListParsers,
getUsers,
manageBlackList,
manageCipher,
manageCommand,
manageCommandSetting,
manageFileSystemEntry,
manageUser,
manageUserBindToFileSystem,
openServer,
stop
Attributes declaration
| pendingChanges |
|
| Description | Indique si certaines modifications apportées nécessitent un appel de l'opération "applyChanges" pour être validées. |
|
| Type | boolean |
|
| Writeable | false |
| open |
|
| Description | Indique si le serveur est ouvert |
|
| Type | java.lang.Boolean |
|
| Writeable | false |
| serverPort |
|
| Description | Le port d'écoute du serveur |
|
| Type | java.lang.Integer |
|
| Writeable | false |
| serverFirewallPort |
|
| Description | Le port d'écoute du serveur sur le firewall |
|
| Type | java.lang.Integer |
|
| Writeable | false |
| reverseLookup |
|
| Description | Recherche le nom d'ordinateur des clients qui se connectent |
|
| Type | java.lang.Boolean |
|
| Writeable | true |
| timeOutNotIdentified |
|
| Description | Le timeout en secondes de la connection pour les sessions de clients non identifiés |
|
| Type | int |
|
| Writeable | true |
| maxSessionsNumber |
|
| Description | Le nombre maximum de sessions sur le serveur |
|
| Type | int |
|
| Writeable | true |
| maxSessionsNumberPerIP |
|
| Description | Le nombre maximum de sessions par adresse IP |
|
| Type | int |
|
| Writeable | true |
| warnClientsDuringShutdown |
|
| Description | Avertis les clients connectés que leur transferts se termine à cause d'un arret du serveur |
|
| Type | java.lang.Boolean |
|
| Writeable | true |
| activeSessionsCount |
|
| Description | Le nombre de sessions actives sur le serveur |
|
| Type | int |
|
| Writeable | false |
| SSLNeedCert |
|
| Description | Réglage pour demander un certificat signé pour chaque connection SSL/TLS sur le serveur |
|
| Type | java.lang.Boolean |
|
| Writeable | true |
| SSLCertsConfName |
|
| Description | Définit quel élement de configuration (en utilisant son nom dans la configuration) concernant le certificat serveur/certificats CA/validation CRL définit dans la configuration du service doit être utilisée avec le serveur. Une valeur null prendra la première entrée de la configuration. |
|
| Type | java.lang.String |
|
| Writeable | true |
| SSLDefaultProt |
|
| Description | Le protocol par défaut utilisé pour les connections encryptées sur un serveur implicite, les valeurs dépendent du JRE mais normalement SSL et TLS fonctionnent |
|
| Type | java.lang.String |
|
| Writeable | true |
| SSLServer |
|
| Description | Définit si le serveur n'accepte que des liaisons sécurisée (true) ou non (false) |
|
| Type | java.lang.Boolean |
|
| Writeable | true |
| authenticationRealm |
|
| Description | Le module d'autentification JAAS du serveur, la valeur doit correspondre à une entrée de la configuration JAAS |
|
| Type | java.lang.String |
|
| Writeable | true |
| disclamerMessage |
|
| Description | Le message retourné au client après une autentification, utilisez \n pour les retours à la ligne |
|
| Type | java.lang.String |
|
| Writeable | true |
| loginMessage |
|
| Description | Le premier message retourné au client, utilisez \n pour les retours à la ligne |
|
| Type | java.lang.String |
|
| Writeable | true |
| logoutMessage |
|
| Description | Le message de sortie, utilisez \n pour les retours à la ligne |
|
| Type | java.lang.String |
|
| Writeable | true |
| networkInterface |
|
| Description | L'identificateur de l'interface réseau du serveur, ATTENTION : il faut appeler l'operation "applyChanges" pour valider la modification. |
|
| Type | java.lang.String |
|
| Writeable | true |
| closedMessage |
|
| Description | Le message retourné aux clients en cas de fermeture du serveur, utilisez \n pour les retours à la ligne |
|
| Type | java.lang.String |
|
| Writeable | true |
| serverRoot |
|
| Description | La racine du serveur, ATTENTION : il faut appeler l'operation "applyChanges" pour valider la modification. |
|
| Type | java.lang.String |
|
| Writeable | true |
| WANAccess |
|
| Description | Permet aux clients provenant du WAN(internet) d'avoir un accès sur le serveur |
|
| Type | java.lang.Boolean |
|
| Writeable | true |
| pasv |
|
| Description | Permet l'utilisation de la commande PASV ou non par les clients, ATTENTION : il faut appeler l'operation "applyChanges" pour valider la modification. |
|
| Type | java.lang.Boolean |
|
| Writeable | true |
| pasvAllowFXP |
|
| Description | Permet les transferts FXP ( inter-serveurs), une assignation à vrai peut créer des problèmes potentiels de sécurité en mode PASV. |
|
| Type | java.lang.Boolean |
|
| Writeable | true |
| socketConnectTimeout |
|
| Description | Le délai d'un client en secondes pour créer la connection de données. |
|
| Type | int |
|
| Writeable | true |
| pasvNATMappingsOnTheFly |
|
| Description | Si réglé à vrai et si un mapper NAT est definit dans l'interface réseau utilisée par ls serveur, les ports seront ouvert sur le routeur après chaque commandes PASV, si réglé à faux tous les ports seront ouverts lors du démarrage du serveur, ATTENTION : il faut appeler l'operation "applyChanges" pour valider la modification. |
|
| Type | java.lang.Boolean |
|
| Writeable | true |
| pasvUpRangePort |
|
| Description | Port de fin en mode passif |
|
| Type | int |
|
| Writeable | false |
| pasvDownRangePort |
|
| Description | Port de départ en mode passif |
|
| Type | int |
|
| Writeable | false |
| activeUpRangePort |
|
| Description | Port source de fin en mode actif |
|
| Type | java.lang.Integer |
|
| Writeable | false |
| activeDownRangePort |
|
| Description | Port source de départ en mode actif |
|
| Type | java.lang.Integer |
|
| Writeable | false |
Operations declaration
| applyChanges |
|
| Description | Cette opération valide tous les changement qui requièrent un redémarrage du serveur. |
|
| Return type | void |
|
| Impact | ACTION |
| changePortsRange |
|
| Description | Change les ports disponibles pour le mode passif et actif, ATTENTION : il faut appeler l'operation "applyChanges" pour valider la modification. |
|
| Return type | void |
|
| Impact | ACTION |
|
| Parameters |
| pasvDownRange | type: int | Le nouveau port de départ en mode passif |
| pasvUpRange | type: int | Le nouveau port de fin en mode passif |
| activeDownRange | type: int | Le nouveau port source de départ en mode actif, 0 pour une valeur libre |
| activeUpRange | type: int | Le nouveau port source de fin en mode actif, 0 pour une valeur libre |
|
| changeServerPort |
|
| Description | Changement du port d'écoute du serveur lors de son exécution. |
|
| Return type | void |
|
| Impact | ACTION |
|
| Parameters |
| port | type: int | Le nouveau port d'écoute. |
| firewallPort | type: int | Le port sur le firewall/router a mapper sur le port d'écoute du serveur, ne fonctionne que si UPNP is activé. |
|
| closeServer |
|
| Description | Ferme le serveur |
|
| Return type | void |
|
| Impact | ACTION |
| closeServerMsg |
|
| Description | Ferme le serveur et publie un message pour les clients |
|
| Return type | void |
|
| Impact | ACTION |
|
| Parameters |
| message | type: java.lang.String | Le message de fermeture à publier |
| closeSessions | type: java.lang.Boolean | Un booleen pour fermer les sessions actives (true) ou non (false) |
|
| deleteFileSystemEntry |
|
| Description | Efface une entrée de la configuration du système de fichiers, retourne vrai si l'entrée de configuration est enlevée, faux autrement |
|
| Return type | boolean |
|
| Impact | ACTION |
|
| Parameters |
| entryId | type: java.lang.String | L'identifiant de l'entrée de configuration maître |
| path | type: java.lang.String | Le chemin de l'entrée de configuration à enlever de l'élément maître de la configuration, insérez une valeur vide si vous voulez effacer l'entier de l'élément de configuration maître |
|
| getAvailableCiphers |
|
| Description | Retourne une liste de ciphers SSL ou TLS disponibles sur le serveur. |
|
| Return type | java.lang.String[] |
|
| Impact | INFO |
| getAvailableCommands |
|
| Description | Liste touts les noms de classe des commandes ou features FTP disponibles. |
|
| Return type | java.lang.String[] |
|
| Impact | INFO |
|
| Parameters |
| type | type: java.lang.String | Le type de commande FTP, C pour les commandes de base, F pour les features. |
|
| getConfiguredCiphers |
|
| Description | Liste les ciphers SSL/TLS permis sur le serveur |
|
| Return type | java.lang.String[] |
|
| Impact | INFO |
| getConfiguredCommands |
|
| Description | Liste touts les noms des commandes ou features FTP installées ur le serveur. |
|
| Return type | net.sbbi.jafs.config.CommandConfig[] |
|
| Impact | INFO |
|
| Parameters |
| type | type: java.lang.String | Le type de commande FTP, C pour les commandes de base, F pour les features. |
|
| getConfiguredIPBlackListParsers |
|
| Description | Retourne une liste de toute le parseurs de list noir d'IP configurés sur le serveur. |
|
| Return type | net.sbbi.jafs.config.BlackListConfig[] |
|
| Impact | INFO |
| getFileSystemEntries |
|
| Description | Retourne les entrées de la configuration du système de fichier |
|
| Return type | net.sbbi.jafs.config.FileSystemRights[] |
|
| Impact | INFO |
| getIPBlackListParsers |
|
| Description | Genère tous les noms de classes disponibles des parseurs de listes de blocage d'IP |
|
| Return type | java.lang.String[] |
|
| Impact | INFO |
| getUsers |
|
| Description | Retourne les configurations d'utilisateurs sur le serveur |
|
| Return type | net.sbbi.jafs.config.User[] |
|
| Impact | INFO |
| manageBlackList |
|
| Description | Opération pour la gestion des listes de blocage d'IP |
|
| Return type | boolean |
|
| Impact | ACTION |
|
| Parameters |
| operation | type: java.lang.String | Le type de l'opération, A pour ajouter, D pour supprimer, U pour mettre à jour l'entrée |
| name | type: java.lang.String | Le nom de l'entrée de la liste dans la configuration |
| location | type: java.lang.String | La location de la liste en URL |
| parserClassName | type: java.lang.String | Le nom de classe du parseur de liste (peut être recherché via la méthode getIPBlackListParsers) |
| rescantime | type: java.lang.Integer | Le temps de rechargement de la liste en heures |
|
| manageCipher |
|
| Description | Ajoute ou enlève un cipher de la liste des ciphers SSL/TLS acceptés sur le serveur. |
|
| Return type | boolean |
|
| Impact | ACTION |
|
| Parameters |
| operationType | type: java.lang.String | Le type d'opération, A pour ajouter et D pour supprimer. |
| cipherName | type: java.lang.String | Le nom du cipher à ajouter, EX SSL_RSA_WITH_RC4_128_MD5. Utilisez l'operation listCiphers pour rechercher les noms de ciphers disponibles avec le JRE. |
|
| manageCommand |
|
| Description | Cette opération permet d'ajouter/supprimer/mettre à jour des implementations de commandes ou features FTP, ATTENTION : il faut appeler l'operation "applyChanges" pour valider la modification. |
|
| Return type | boolean |
|
| Impact | ACTION |
|
| Parameters |
| operation | type: java.lang.String | Le type d'opération, A pour ajouter, D pour supprimer, U pour mettre à jour. |
| type | type: java.lang.String | Le type de commande, C pour une commande FTP générique, F pour une feature FTP. |
| commandName | type: java.lang.String | Le nom de la commande dans le protocole (ABOR,RETR,PORT...), c'est le nom qui va être utilisé par les clients FTP pour communiquer avec le serveur. |
| className | type: java.lang.String | Le nom de classe de la commande, qui implémente l'interface net.sbbi.jafs.commands.CommandInterface pour une commande FTP générique ou l'interface net.sbbi.jafs.commands.FeatCommandInterface pour une feature. Une liste des noms de classe disponibles peut être obtenue avec l'opération "listAvailableCommands". |
| location | type: java.lang.String | L'emplacement des binaires java (http://www.myhost.com/myCode.jar), fournissez une valeur null si les binaires sont dans le classpath local. |
|
| manageCommandSetting |
|
| Description | Cette opération permet d'ajouter/supprimer/mettre à jour des réglages de commandes ou features FTP, ATTENTION : il faut appeler l'operation "applyChanges" pour valider la modification. |
|
| Return type | boolean |
|
| Impact | ACTION |
|
| Parameters |
| operation | type: java.lang.String | Le type d'opération, A pour ajouter, D pour supprimer, U pour mettre à jour. |
| type | type: java.lang.String | Le type de commande, C pour une commande FTP générique, F pour une feature FTP. |
| commandName | type: java.lang.String | Le nom de la commande dans le protocole (ABOR,RETR,PORT...), c'est le nom qui va être utilisé par les clients FTP pour communiquer avec le serveur. |
| settingName | type: java.lang.String | Le nom du réglage. |
| settingValue | type: java.lang.String | La valeur du réglage. |
|
| manageFileSystemEntry |
|
| Description | Ajoute ou modifie une entrée de la configuration du système de fichier |
|
| Return type | void |
|
| Impact | ACTION |
|
| Parameters |
| entryId | type: java.lang.String | L'identifiant de l'entrée de la configuration |
| readFile | type: boolean | Droits de lecture de fichier |
| overwriteFile | type: boolean | Droits d'écriture sur un fichier déja existant |
| deleteFile | type: boolean | Droits d'effacement de fichier |
| renameFile | type: boolean | Droits de renommage de fichier |
| ratioDisabled | type: boolean | Désactive le ratio pour les téléchargements de fichier même si le compte utilisateur à le ratio activé |
| createFile | type: boolean | Droits de création de fichier |
| hiddenFile | type: boolean | Droits d'accès sur un fichier caché |
| deleteDirectory | type: boolean | Droits d'effacement de répertoire |
| createDirectory | type: boolean | Droits de création de répertoire |
| renameDirectory | type: boolean | Droits de renommage de répertoire |
| listDirectoryContent | type: boolean | Droits d'affichage du content d'un répertoire |
| path | type: java.lang.String | Le chemin sur le serveur ou les droits doivent être appliqués EX : /mydir , /, /mydir/myfile.txt, notez que le chemin n'inclut pas le chemin de la racine du serveur ( EX : /var/ftp/pub ) |
| fileType | type: java.lang.String | Le type des extensions de fichier permises pour le chemin donné lors d'un upload de fichier. Les extensions sont délimités par des virgules EX txt,jpeg,mp3. Insérer une valeur vide pour permettre tout type de fichiers. |
|
| manageUser |
|
| Description | Gestion des utilisateurs du serveur |
|
| Return type | boolean |
|
| Impact | ACTION |
|
| Parameters |
| operationType | type: java.lang.String | Le type de l'opération, A pour ajouter, D pour supprimer, U pour mettre à jour, retourne vrai ou faux si l'opération s'est bien déroulée |
| userName | type: java.lang.String | Le nom de l'utilisateur ( peut être une expression regulière) pour cet élément de configuration |
| ipAddress | type: java.lang.String | L'adresse IP ( 201.0 , 201.0.0.1 ... ) pour les restrictions d'accès de l'utilisateur, valeur vide pour ne pas faire de restrictions |
| account | type: java.lang.Boolean | Définit si l'utilisateur a un compte ou non. Si reglé à vrai, les crédits de bytes seront assigné au nom d'utilisateur, si réglé à faux, ils seront assigné à l'adresse IP du client connecté. |
| maxConnectionsNumber | type: int | Le nombre maximum de connections permise pour l'utilisateur, -1 pour une valeur infinie. |
| timeout | type: int | Le délai d'inactivité de la connection en secondes |
| maxUploadRate | type: int | Le taux de transfert en Kbytes/s maximum lors d'un upload, -1 pour une valeur infinie. |
| maxDownloadRate | type: int | Le taux de transfert en Kbytes/s maximum lors d'un téléchargement, -1 pour une valeur infinie. |
| isRatio | type: java.lang.Boolean | Active ou non l'utilisation des crédits pour le téléchargement des fichiers. |
| ratioScale | type: int | Le ratio du montant de bytes donné lorsque le ratio est activé, 2 signifie que pour chaque byte uploadé, 2 bytes pourront être téléchargés. |
| baseCredits | type: long | Le montant de base de crédit ( en octets ) disponible à l'utilisateur lors de sa première connection. |
| homeDir | type: java.lang.String | Le répertoire maison de l'utilisateur, donnez un chemin si vous ne voulez pas donner accès au repertoire racine du serveur à un utilisateur. Vous pouvez utiliser les mots clefs $USERHOME et $UNRE:$regexp:$UNRE pour évaluer le chemin avec le nom de l'utilisateur de la session. |
| secureControlTransport | type: java.lang.String | Fournissez "true" si l'utilisateur doit utiliser une connection de contrôle sécurisée, "false" si l'utilisation de connection de contrôle sécurisée est interdite, null ou "" pour laisser le choix à l'utilisateur. |
| secureDataTransport | type: java.lang.String | Fournissez "true" si l'utilisateur doit utiliser une connection de données sécurisée, "false" si l'utilisation de connection de données sécurisée est interdite, null ou "" pour laisser le choix à l'utilisateur. |
|
| manageUserBindToFileSystem |
|
| Description | Lie ou délie un utilisateur à une entrée de la configuration du système de fichiers. |
|
| Return type | boolean |
|
| Impact | ACTION |
|
| Parameters |
| operation | type: java.lang.String | Le type de l'operation, A pour ajouter un lien, D pour l'éffacer |
| userName | type: java.lang.String | Le nom d'utilisateur ( peut être une expression régulière ) à lier ou délier |
| entryId | type: java.lang.String | L'identifiant de l'entrée de la configuration du système de fichier |
|
| openServer |
|
| Description | Ouvre le serveur |
|
| Return type | void |
|
| Impact | ACTION |
| stop |
|
| Description | Arrête le serveur et l'enlève de la console d'administration |
|
| Return type | void |
|
| Impact | ACTION |
|
FtpServer
