CloudFileDirectory Classe
- java.
lang. Object - ListFileItem
- com.
microsoft. azure. storage. file. CloudFileDirectory
- com.
public class CloudFileDirectory implements ListFileItem
Représente un répertoire virtuel de fichiers.
Les répertoires, qui sont encapsulés en tant qu’objets CloudFileDirectory , contiennent des fichiers et peuvent également contenir des sous-répertoires.
Récapitulatif du constructeur
Constructeur | Description |
---|---|
CloudFileDirectory(final StorageUri directoryAbsoluteUri) |
Crée un instance de la classe à l’aide d’un URI absolu dans le répertoire. |
CloudFileDirectory(final StorageUri directoryAbsoluteUri, final StorageCredentials credentials) |
Crée un instance de la classe à l’aide d’un URI absolu dans le répertoire et les informations d’identification. |
CloudFileDirectory(final StorageUri uri, final String directoryName, final CloudFileShare share) |
Crée une instance de la classe à l’aide de l’adresse, du partage et du client spécifiés. |
CloudFileDirectory(final URI directoryAbsoluteUri) |
Crée un instance de la classe à l’aide d’un URI absolu dans le répertoire. |
CloudFileDirectory(final URI directoryAbsoluteUri, final StorageCredentials credentials) |
Crée un instance de la classe à l’aide d’un URI absolu dans le répertoire et les informations d’identification. |
Résumé de la méthode
Modificateur et type | Méthode et description |
---|---|
void |
assertValidFilePermissionOrKey()
Vérifie que filePermission et properties.filePermissionKey du répertoire ne sont pas définis. |
Result |
closeAllHandlesSegmented()
Fermez tous les handles SMB de ce fichier. |
Result |
closeAllHandlesSegmented(final ResultContinuation continuationToken, boolean recursive, FileRequestOptions options, OperationContext opContext)
Fermez tous les handles SMB de ce fichier. |
Result |
closeHandleSegmented(String handleID)
Fermez tous les handles SMB de ce fichier. |
Result |
closeHandleSegmented(String handleID, ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
Fermez tous les handles SMB de ce fichier. |
void |
create()
Crée le répertoire. |
void |
create(FileRequestOptions options, OperationContext opContext)
Crée le répertoire à l’aide des options et du contexte d’opération spécifiés. |
boolean |
createIfNotExists()
Crée le répertoire s’il n’existe pas. |
boolean |
createIfNotExists(FileRequestOptions options, OperationContext opContext)
Crée le répertoire s’il n’existe pas, à l’aide des options de requête et du contexte d’opération spécifiés. |
void |
delete()
Supprime le répertoire. |
void |
delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Supprime le répertoire à l’aide des options de requête et du contexte d’opération spécifiés. |
boolean |
deleteIfExists()
Supprime le répertoire s’il existe. |
boolean |
deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Supprime le répertoire s’il existe à l’aide des options de requête et du contexte d’opération spécifiés. |
void |
downloadAttributes()
Télécharge les propriétés du répertoire. |
void |
downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Télécharge les propriétés du répertoire à l’aide des options de requête et du contexte d’opération spécifiés. |
boolean |
exists()
Retourne une valeur qui indique si le répertoire existe. |
boolean |
exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Retourne une valeur qui indique si le répertoire existe, à l’aide des options de requête et du contexte d’opération spécifiés. |
Cloud |
getDirectoryReference(final String itemName)
Retourne une référence à un CloudFileDirectory objet qui représente un répertoire dans ce répertoire. |
Cloud |
getFileReference(final String fileName)
Renvoie une référence à un CloudFile objet qui représente un fichier dans ce répertoire. |
HashMap<String, String> |
getMetadata()
Retourne les métadonnées du répertoire. Cette valeur est initialisée avec les métadonnées du répertoire par un appel à downloadAttributes(), et est définie sur le répertoire avec un appel à uploadMetadata(). |
String |
getName()
Retourne le nom de ce répertoire. |
Cloud |
getParent()
Retourne le CloudFileDirectory répertoire parent associé à ce répertoire. |
File |
getProperties()
Retourne l’objet FileDirectoryProperties qui contient les propriétés système du répertoire. |
Cloud |
getServiceClient()
Retourne le client de service de fichiers associé à ce répertoire. |
Cloud |
getShare()
Retourne le partage de ce répertoire. |
final Storage |
getStorageUri()
Retourne la liste des URI pour tous les emplacements. |
URI |
getUri()
Retourne l’URI de ce répertoire. |
Iterable<List |
listFilesAndDirectories()
Retourne une collection énumérable d’éléments de fichier et de répertoire pour le répertoire. |
Iterable<List |
listFilesAndDirectories(FileRequestOptions options, OperationContext opContext)
Retourne une collection énumérable d’éléments de fichier et de répertoire pour le répertoire. |
Iterable<List |
listFilesAndDirectories(String prefix, FileRequestOptions options, OperationContext opContext)
Retourne une collection énumérable d’éléments de fichier et de répertoire pour le répertoire. |
Result |
listFilesAndDirectoriesSegmented()
Retourne un segment de résultat d’une collection énumérable de fichiers et de répertoires pour ce client de service de fichiers. |
Result |
listFilesAndDirectoriesSegmented(final Integer maxResults, final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
Retourne un segment de résultat d’une collection énumérable de fichiers et de répertoires pour ce répertoire, à l’aide des options de détails de liste, des options de demande et du contexte d’opération spécifiés. |
Result |
listFilesAndDirectoriesSegmented(final String prefix, final Integer maxResults, final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
Retourne un segment de résultat d’une collection énumérable de fichiers et de répertoires pour ce répertoire, à l’aide des options de détails de liste, des options de demande et du contexte d’opération spécifiés. |
Iterable<File |
listHandles()
Obtient les handles SMB ouverts sur ce fichier. |
Iterable<File |
listHandles(boolean recursive, FileRequestOptions options, OperationContext opContext)
Obtient les handles SMB ouverts sur ce fichier. |
Result |
listHandlesSegmented()
Obtient les handles SMB ouverts sur ce fichier. |
Result |
listHandlesSegmented(final Integer maxResults, final boolean recursive, final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
Obtient les handles SMB ouverts sur ce fichier. |
void |
setFilePermission(String filePermission)
Définit l’autorisation de fichier du répertoire |
void |
setMetadata(HashMap<String, String> metadata)
Définit la collection de métadonnées des paires nom-valeur à définir sur le répertoire avec un uploadMetadata() appel. Cette collection remplace toutes les métadonnées de répertoire existantes. Si cette valeur est définie sur une collection vide, les métadonnées du répertoire sont effacées lors d’un uploadMetadata() appel. |
final void |
setProperties(final FileDirectoryProperties properties)
Définit les propriétés du répertoire. |
final void |
setShare(final CloudFileShare share)
Définit le partage pour le répertoire. |
void |
setStorageUri(final StorageUri storageUri)
Définit la liste des URI pour tous les emplacements. |
void |
uploadMetadata()
Charge les métadonnées du répertoire. |
void |
uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Charge les métadonnées du répertoire à l’aide des options de requête et du contexte d’opération spécifiés. |
final void |
uploadProperties()
Charge les propriétés du répertoire dans le service de stockage. Utilisez downloadAttributes() pour récupérer les valeurs les plus récentes pour les propriétés et métadonnées de l’annuaire à partir du service de stockage Microsoft Azure. |
final void |
uploadProperties(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Charge les propriétés du répertoire à l’aide de la condition d’accès, des options de demande et du contexte d’opération. Utilisez downloadAttributes() pour récupérer les valeurs les plus récentes pour les propriétés et métadonnées de l’annuaire à partir du service de stockage Microsoft Azure. |
Détails du constructeur
CloudFileDirectory
public CloudFileDirectory(final StorageUri directoryAbsoluteUri)
Crée un instance de la classe à l’aide d’un URI absolu dans le répertoire.
Parameters:
Throws:
CloudFileDirectory
public CloudFileDirectory(final StorageUri directoryAbsoluteUri, final StorageCredentials credentials)
Crée un instance de la classe à l’aide d’un URI absolu dans le répertoire et les informations d’identification.
Parameters:
Throws:
CloudFileDirectory
protected CloudFileDirectory(final StorageUri uri, final String directoryName, final CloudFileShare share)
Crée une instance de la classe à l’aide de l’adresse, du partage et du client spécifiés.
Parameters:
String
qui représente le nom du répertoire.
CloudFileDirectory
public CloudFileDirectory(final URI directoryAbsoluteUri)
Crée un instance de la classe à l’aide d’un URI absolu dans le répertoire.
Parameters:
Throws:
CloudFileDirectory
public CloudFileDirectory(final URI directoryAbsoluteUri, final StorageCredentials credentials)
Crée un instance de la classe à l’aide d’un URI absolu dans le répertoire et les informations d’identification.
Parameters:
Throws:
Détails de la méthode
assertValidFilePermissionOrKey
protected void assertValidFilePermissionOrKey()
Vérifie que filePermission et properties.filePermissionKey du répertoire ne sont pas définis.
closeAllHandlesSegmented
public ResultSegment
Fermez tous les handles SMB de ce fichier.
Returns:
Throws:
closeAllHandlesSegmented
public ResultSegment
Fermez tous les handles SMB de ce fichier.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
Throws:
closeHandleSegmented
public ResultSegment
Fermez tous les handles SMB de ce fichier.
Parameters:
Returns:
Throws:
closeHandleSegmented
public ResultSegment
Fermez tous les handles SMB de ce fichier.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
Throws:
create
public void create()
Crée le répertoire.
Throws:
create
public void create(FileRequestOptions options, OperationContext opContext)
Crée le répertoire à l’aide des options et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Throws:
createIfNotExists
public boolean createIfNotExists()
Crée le répertoire s’il n’existe pas.
Returns:
true
si le répertoire n'existait pas et a été créé ; sinon false
.
Throws:
createIfNotExists
public boolean createIfNotExists(FileRequestOptions options, OperationContext opContext)
Crée le répertoire s’il n’existe pas, à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé (CloudFileClient).
Returns:
true
si le répertoire n'existait pas et a été créé ; sinon false
.
Throws:
delete
public void delete()
Supprime le répertoire.
Throws:
delete
public void delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Supprime le répertoire à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Throws:
deleteIfExists
public boolean deleteIfExists()
Supprime le répertoire s’il existe.
Returns:
true
si le répertoire n'existait pas et a été créé ; sinon false
.
Throws:
deleteIfExists
public boolean deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Supprime le répertoire s’il existe à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
true
si le répertoire existait et a été supprimé ; sinon, false
.
Throws:
downloadAttributes
public void downloadAttributes()
Télécharge les propriétés du répertoire.
Throws:
downloadAttributes
public void downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Télécharge les propriétés du répertoire à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Throws:
exists
public boolean exists()
Retourne une valeur qui indique si le répertoire existe.
Returns:
true
si le répertoire existe, sinon false
.
Throws:
exists
public boolean exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Retourne une valeur qui indique si le répertoire existe, à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
true
si le répertoire existe, sinon false
.
Throws:
getDirectoryReference
public CloudFileDirectory getDirectoryReference(final String itemName)
Retourne une référence à un CloudFileDirectory objet qui représente un répertoire dans ce répertoire.
Parameters:
String
qui représente le nom du répertoire.
Returns:
Throws:
getFileReference
public CloudFile getFileReference(final String fileName)
Renvoie une référence à un CloudFile objet qui représente un fichier dans ce répertoire.
Parameters:
String
qui représente le nom du fichier.
Returns:
Throws:
getMetadata
public HashMap
Retourne les métadonnées du répertoire. Cette valeur est initialisée avec les métadonnées du répertoire par un appel à downloadAttributes(), et est définie sur le répertoire avec un appel à uploadMetadata().
Returns:
java.util.HashMap
qui représente les métadonnées du répertoire.getName
public String getName()
Retourne le nom de ce répertoire.
Returns:
String
qui représente le nom du répertoire.getParent
public CloudFileDirectory getParent()
Retourne le CloudFileDirectory répertoire parent associé à ce répertoire.
Overrides:
CloudFileDirectory.getParent()Returns:
Throws:
getProperties
public FileDirectoryProperties getProperties()
Retourne l’objet FileDirectoryProperties qui contient les propriétés système du répertoire.
Returns:
getServiceClient
public CloudFileClient getServiceClient()
Retourne le client de service de fichiers associé à ce répertoire.
Returns:
getShare
public CloudFileShare getShare()
Retourne le partage de ce répertoire.
Overrides:
CloudFileDirectory.getShare()Returns:
Throws:
getStorageUri
public final StorageUri getStorageUri()
Retourne la liste des URI pour tous les emplacements.
Overrides:
CloudFileDirectory.getStorageUri()Returns:
getUri
public URI getUri()
Retourne l’URI de ce répertoire.
Overrides:
CloudFileDirectory.getUri()Returns:
java.net.URI
qui représente l’URI de ce répertoire.listFilesAndDirectories
public Iterable
Retourne une collection énumérable d’éléments de fichier et de répertoire pour le répertoire.
Returns:
listFilesAndDirectories
public Iterable
Retourne une collection énumérable d’éléments de fichier et de répertoire pour le répertoire.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
listFilesAndDirectories
public Iterable
Retourne une collection énumérable d’éléments de fichier et de répertoire pour le répertoire.
Parameters:
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
listFilesAndDirectoriesSegmented
public ResultSegment
Retourne un segment de résultat d’une collection énumérable de fichiers et de répertoires pour ce client de service de fichiers.
Returns:
Throws:
listFilesAndDirectoriesSegmented
public ResultSegment
Retourne un segment de résultat d’une collection énumérable de fichiers et de répertoires pour ce répertoire, à l’aide des options de détails de liste, des options de demande et du contexte d’opération spécifiés.
Parameters:
null
ou supérieur à 5 000, le serveur retourne jusqu’à 5 000 éléments. Doit être au moins égal à 1.
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
Throws:
listFilesAndDirectoriesSegmented
public ResultSegment
Retourne un segment de résultat d’une collection énumérable de fichiers et de répertoires pour ce répertoire, à l’aide des options de détails de liste, des options de demande et du contexte d’opération spécifiés.
Parameters:
null
ou supérieur à 5 000, le serveur retourne jusqu’à 5 000 éléments. Doit être au moins égal à 1.
null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
Returns:
Throws:
listHandles
public Iterable
Obtient les handles SMB ouverts sur ce fichier.
Returns:
Itérable
</code> of the handles that will lazily request new segments. </p>
listHandles
public Iterable listHandles(boolean recursive, FileRequestOptions options, OperationContext opContext)
Obtient les handles SMB ouverts sur ce fichier.
Parameters:
recursive
- Spécifie si l’opération doit s’appliquer au répertoire spécifié dans l’URI, à ses fichiers, à ses sous-répertoires et à leurs fichiers.
options
- Objet FileRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
opContext
- Objet OperationContext qui représente le contexte de l’opération en cours. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.
Returns:
Itérable
</code> of the handles that will lazily request new segments. </p>
listHandlesSegmented
public ResultSegment listHandlesSegmented()
Obtient les handles SMB ouverts sur ce fichier.
Returns:
Objet ResultSegment<T> qui contient un segment de la collection énumérable d’objets ListFileItem qui représentent les fichiers et les répertoires.
Throws:
StorageException
listHandlesSegmented
public ResultSegment listHandlesSegmented(final Integer maxResults, final boolean recursive, final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)
Obtient les handles SMB ouverts sur ce fichier.
Parameters:
maxResults
- Nombre maximal de résultats à récupérer. Si null
ou supérieur à 5 000, le serveur retourne jusqu’à 5 000 éléments. Doit être au moins égal à 1.
recursive
- Spécifie si l’opération doit s’appliquer au répertoire spécifié dans l’URI, à ses fichiers, à ses sous-répertoires et à leurs fichiers.
continuationToken
- Objet ResultContinuation qui représente un jeton de continuation retourné par une opération de référencement précédente.
options
- Objet FileRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
opContext
- Objet OperationContext qui représente le contexte de l’opération en cours. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.
Returns:
Objet ResultSegment<T> qui contient un segment de la collection énumérable d’objets ListFileItem qui représentent les fichiers et les répertoires.
Throws:
StorageException
setFilePermission
public void setFilePermission(String filePermission)
Définit l’autorisation de fichier du répertoire
Parameters:
filePermission
- String
qui représente l’autorisation de fichier du répertoire.
setMetadata
public void setMetadata(HashMap metadata)
Définit la collection de métadonnées des paires nom-valeur à définir sur le répertoire avec un uploadMetadata() appel. Cette collection remplace toutes les métadonnées de répertoire existantes. Si cette valeur est définie sur une collection vide, les métadonnées du répertoire sont effacées lors d’un uploadMetadata() appel.
Parameters:
metadata
- Objet java.util.HashMap
qui représente les métadonnées affectées au répertoire.
setProperties
protected final void setProperties(final FileDirectoryProperties properties)
Définit les propriétés du répertoire.
Parameters:
properties
- Objet FileDirectoryProperties qui représente les propriétés affectées au répertoire.
setShare
protected final void setShare(final CloudFileShare share)
Définit le partage pour le répertoire.
Parameters:
share
- Objet CloudFileShare qui représente le partage affecté au répertoire.
setStorageUri
protected void setStorageUri(final StorageUri storageUri)
Définit la liste des URI pour tous les emplacements.
Parameters:
storageUri
- StorageUri qui représente la liste des URI de tous les emplacements.
uploadMetadata
public void uploadMetadata()
Charge les métadonnées du répertoire.
Throws:
StorageException
- Si une erreur de service de stockage s’est produite.
URISyntaxException
uploadMetadata
public void uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Charge les métadonnées du répertoire à l’aide des options de requête et du contexte d’opération spécifiés.
Parameters:
accessCondition
- Objet AccessCondition qui représente les conditions d’accès pour le répertoire.
options
- Objet FileRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
opContext
- Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.
Throws:
StorageException
- Si une erreur de service de stockage s’est produite.
URISyntaxException
uploadProperties
public final void uploadProperties()
Charge les propriétés du répertoire dans le service de stockage.
Utilisez downloadAttributes() pour récupérer les valeurs les plus récentes pour les propriétés et métadonnées de l’annuaire à partir du service de stockage Microsoft Azure.
Throws:
StorageException
- Si une erreur de service de stockage s’est produite.
URISyntaxException
uploadProperties
public final void uploadProperties(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)
Charge les propriétés du répertoire à l’aide de la condition d’accès, des options de demande et du contexte d’opération.
Utilisez downloadAttributes() pour récupérer les valeurs les plus récentes pour les propriétés et métadonnées de l’annuaire à partir du service de stockage Microsoft Azure.
Parameters:
accessCondition
- Objet AccessCondition qui représente les conditions d’accès pour le répertoire.
options
- Objet FileRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null
utilise les options de requête par défaut du client de service associé ( CloudFileClient).
opContext
- Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.
Throws:
StorageException
- Si une erreur de service de stockage s’est produite.
URISyntaxException
S’applique à
Azure SDK for Java