CloudFile クラス

protected CloudFileClient fileServiceClient

ファイル サービス クライアントを表します。

protected CloudFileDirectory parent

ファイルのディレクトリ参照を表します。

protected int streamMinimumReadSizeInBytes= Constants.DEFAULT_MINIMUM_READ_SIZE_IN_BYTES

を使用する場合の最小読み取りサイズを FileInputStream保持します。

protected int streamWriteSizeInBytes= Constants.DEFAULT_STREAM_WRITE_IN_BYTES

への書き込み時にバッファーするバイト数を FileOutputStream保持します。

public CloudFile(final CloudFile otherFile)

別のクラウド ファイルから値をコピーして、 クラスのインスタンスを作成します。

Parameters:

public CloudFile(final StorageUri fileAbsoluteUri)

指定した絶対 StorageUri を使用して、 クラスのインスタンスを作成します。

Parameters:

Throws:

public CloudFile(final StorageUri fileAbsoluteUri, final StorageCredentials credentials)

指定した絶対 StorageUri と資格情報を使用して、 クラスのインスタンスを作成します。

Parameters:

Throws:

protected CloudFile(final StorageUri uri, final String fileName, final CloudFileShare share)

指定したアドレス、共有、およびクライアントを使用して、 クラスのインスタンスを作成します。

Parameters:

public CloudFile(final URI fileAbsoluteUri)

指定した絶対 URI を使用して、 クラスのインスタンスを作成します。

Parameters:

Throws:

public CloudFile(final URI fileAbsoluteUri, final StorageCredentials credentials)

指定した絶対 URI と資格情報を使用して、 クラスのインスタンスを作成します。

Parameters:

Throws:

public final void abortCopy(final String copyId)

進行中の Azure ファイルのコピー操作を中止します。

Parameters:

Throws:

public final void abortCopy(final String copyId, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

進行中の Azure ファイルのコピー操作を中止します。

Parameters:

Throws:

protected void assertValidFilePermissionOrKey()

ディレクトリの filePermission と properties.filePermissionKey の両方が設定されていないことを確認します。

public void clearRange(final long offset, final long length)

ファイルから範囲をクリアします。

を呼び出すと、指定した範囲で使用される記憶域領域が解放されます。 クリアされた範囲は、ファイルの一部として追跡されなくなります。

Parameters:

Throws:

public void clearRange(final long offset, final long length, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定したリース ID、要求オプション、および操作コンテキストを使用して、ファイルから範囲をクリアします。

を呼び出すと、指定した範囲で使用される記憶域領域が解放されます。 クリアされた範囲は、ファイルの一部として追跡されなくなります。

Parameters:

Throws:

public ResultSegment closeAllHandlesSegmented()

このファイルのすべての SMB ハンドルを閉じます。

Returns:

Throws:

public ResultSegment closeAllHandlesSegmented(final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)

このファイルのすべての SMB ハンドルを閉じます。

Parameters:

Returns:

Throws:

public ResultSegment closeHandleSegmented(String handleID)

このファイルのすべての SMB ハンドルを閉じます。

Parameters:

Returns:

Throws:

public ResultSegment closeHandleSegmented(String handleID, ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)

このファイルのすべての SMB ハンドルを閉じます。

Parameters:

Returns:

Throws:

public void create(final long size)

ファイルを作成します。 ファイルが既に存在する場合は、置き換えられます。

Parameters:

Throws:

public void create(final long size, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定したアクセス条件、要求オプション、操作コンテキストを使用してファイルを作成します。 ファイルが既に存在する場合は、置き換えられます。

Parameters:

Throws:

public final void delete()

ファイルを削除します。

Throws:

public final void delete(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定したアクセス条件、要求オプション、および操作コンテキストを使用してファイルを削除します。

Parameters:

Throws:

public final boolean deleteIfExists()

ファイルが存在する場合は削除します。

Returns:

Throws:

public final boolean deleteIfExists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定したアクセス条件、要求オプション、および操作コンテキストを使用して、ファイルが存在する場合は削除します。

Parameters:

Returns:

Throws:

public final void download(final OutputStream outStream)

ファイルの内容をストリームにダウンロードします。

Parameters:

Throws:

public final void download(final OutputStream outStream, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、ファイルの内容をストリームにダウンロードします。

Parameters:

Throws:

public final void downloadAttributes()

ファイルのプロパティとメタデータを設定します。

このメソッドは、ファイルのシステム プロパティとユーザー定義メタデータを設定します。 ファイルのプロパティまたはメタデータを読み取りまたは変更する前に、このメソッドまたはそのオーバーロードを呼び出して、Microsoft Azure ストレージ サービスからファイルのプロパティとメタデータの最新の値を取得します。

Throws:

public final void downloadAttributes(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、ファイルのプロパティとメタデータを設定します。

このメソッドは、ファイルのシステム プロパティとユーザー定義メタデータを設定します。 ファイルのプロパティまたはメタデータを読み取りまたは変更する前に、このメソッドまたはそのオーバーロードを呼び出して、Microsoft Azure ストレージ サービスからファイルのプロパティとメタデータの最新の値を取得します。

Parameters:

Throws:

public ArrayList downloadFileRanges()

ファイル範囲のコレクションと、その開始および終了バイト オフセットを返します。

各ファイル範囲の開始バイトオフセットと終了バイトオフセットは含まれます。

Returns:

Throws:

public ArrayList downloadFileRanges(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、ファイル範囲とその開始バイト オフセットと終了バイト オフセットのコレクションを返します。

Parameters:

Returns:

Throws:

public final void downloadRange(final long offset, final Long length, final OutputStream outStream)

ファイルの内容をストリームにダウンロードします。

Parameters:

Throws:

public final void downloadRange(final long offset, final Long length, final OutputStream outStream, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、ファイルの内容をストリームにダウンロードします。

Parameters:

Throws:

protected final int downloadRangeInternal(final long fileOffset, final Long length, final byte[] buffer, final int bufferOffset, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

ファイルから指定されたバイト バッファーにバイト範囲をダウンロードします。

Parameters:

Throws:

public final int downloadRangeToByteArray(final long offset, final Long length, final byte[] buffer, final int bufferOffset)

ファイルから指定されたバイト バッファーにバイト範囲をダウンロードします。

Parameters:

Throws:

public final int downloadRangeToByteArray(final long offset, final Long length, final byte[] buffer, final int bufferOffset, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、ファイルから指定されたバイト バッファーにバイト範囲をダウンロードします。

Parameters:

Throws:

public String downloadText()

プラットフォームの既定のエンコードを使用して、ファイルを文字列にダウンロードします。

Returns:

Throws:

public String downloadText(final String charsetName, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定したエンコードを使用して、ファイルを文字列にダウンロードします。

Parameters:

Returns:

Throws:

public final int downloadToByteArray(final byte[] buffer, final int bufferOffset)

ファイルから指定されたバイト バッファーにバイト範囲をダウンロードします。

Parameters:

Throws:

public final int downloadToByteArray(final byte[] buffer, final int bufferOffset, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、ファイルから指定されたバイト バッファーにバイト範囲をダウンロードします。

Parameters:

Throws:

public void downloadToFile(final String path)

ファイルをダウンロードします。

Parameters:

Throws:

public void downloadToFile(final String path, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

ファイルをダウンロードします。

Parameters:

Throws:

public final boolean exists()

ファイルが存在するかどうかを確認します。

Returns:

Throws:

public final boolean exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定したアクセス条件、要求オプション、および操作コンテキストを使用して、ファイルが存在するかどうかを確認します。

Parameters:

Returns:

Throws:

public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final SharedAccessFileHeaders headers, final String groupPolicyIdentifier)

指定したグループ ポリシー識別子と共有アクセス ファイル ヘッダーを使用して、ファイルの共有アクセス署名を返します。 これは先頭の "?"" を含まないことに注意してください。

Parameters:

Returns:

Throws:

public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final SharedAccessFileHeaders headers, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)

指定したグループ ポリシー識別子と共有アクセス ファイル ヘッダーを使用して、ファイルの共有アクセス署名を返します。 これは先頭の "?"" を含まないことに注意してください。

Parameters:

Returns:

Throws:

public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier)

指定したグループ ポリシー識別子と共有アクセス ファイル ヘッダーを使用して、ファイルの共有アクセス署名を返します。 これは先頭の "?"" を含まないことに注意してください。

Parameters:

Returns:

Throws:

public CopyState getCopyState()

Azure ファイルのコピー状態を返します。

Returns:

public final HashMap getMetadata()

ファイルのメタデータを返します。

Returns:

public final String getName()

ファイルの名前を返します。

Returns:

public final CloudFileDirectory getParent()

ファイル 項目の親を返します。

Overrides:

Returns:

Throws:

protected static String getParentNameFromURI(final StorageUri resourceAddress, final CloudFileShare share)

ファイル URI の親名を取得します。

Parameters:

Returns:

Throws:

public final FileProperties getProperties()

ファイルのプロパティを返します。

Returns:

public final CloudFileClient getServiceClient()

ファイルに関連付けられているファイル サービス クライアントを返します。

Returns:

public final CloudFileShare getShare()

ファイルの共有を返します。

Overrides:

Returns:

Throws:

public final StorageUri getStorageUri()

すべての場所の URI の一覧を返します。

Overrides:

Returns:

public final int getStreamMinimumReadSizeInBytes()

を使用する場合の最小読み取りサイズを FileInputStream返します。

Returns:

public final int getStreamWriteSizeInBytes()

に書き込むときにバッファーに格納するバイト数を FileOutputStream取得します。

Returns:

protected final StorageUri getTransformedAddress(final OperationContext opContext)

指定された資格情報に変換が必要な場合は、リソースの変換された URI を返します。

Parameters:

Returns:

Throws:

public final URI getUri()

このファイルの URI を返します。

Overrides:

Returns:

public Iterable listHandles()

このファイルで開いている SMB ハンドルを取得します。

Returns:

</code> of the handles that will lazily request new segments. </p>

public Iterable listHandles(FileRequestOptions options, OperationContext opContext)

このファイルで開いている SMB ハンドルを取得します。

Parameters:

Returns:

</code> of the handles that will lazily request new segments. </p>

public ResultSegment listHandlesSegmented()

このファイルで開いている SMB ハンドルを取得します。

Returns:

Throws:

public ResultSegment listHandlesSegmented(final Integer maxResults, final ResultContinuation continuationToken, FileRequestOptions options, OperationContext opContext)

このファイルで開いている SMB ハンドルを取得します。

Parameters:

Returns:

Throws:

public final FileInputStream openRead()

ファイル入力ストリームを開き、ファイルをダウンロードします。

を使用して setStreamMinimumReadSizeInBytes(final int minimumReadSize) 、読み取りサイズを構成します。

Returns:

Throws:

public final FileInputStream openRead(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

ファイル入力ストリームを開き、指定した要求オプションと操作コンテキストを使用してファイルをダウンロードします。

を使用して setStreamMinimumReadSizeInBytes(final int minimumReadSize) 、読み取りサイズを構成します。

Parameters:

Returns:

Throws:

public FileOutputStream openWriteExisting()

ファイルにデータを書き込む出力ストリーム オブジェクトを開きます。 ファイルは既に存在している必要があり、既存のデータは上書きされる可能性があります。

Returns:

Throws:

public FileOutputStream openWriteExisting(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、ファイルにデータを書き込む出力ストリーム オブジェクトを開きます。 ファイルは既に存在している必要があり、既存のデータは上書きされる可能性があります。

Parameters:

Returns:

Throws:

public FileOutputStream openWriteNew(final long length)

ファイルにデータを書き込む出力ストリーム オブジェクトを開きます。 ファイルはまだ存在せず、指定された長さで作成されます。 ファイルがサービスに既に存在する場合は、上書きされます。

上書きを回避し、代わりにエラーをスローするには、適切な AccessConditionでオーバーロードをopenWriteNew(final long length, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)使用してください。

Parameters:

Returns:

Throws:

public FileOutputStream openWriteNew(final long length, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定したリース ID、要求オプション、および操作コンテキストを使用して、ファイルにデータを書き込む出力ストリーム オブジェクトを開きます。 ファイルはまだ存在する必要はありません。長さを指定して作成されます。 ファイルがサービスに既に存在する場合は、上書きされます。

上書きを回避し、代わりにエラーをスローするには、 を使用してgenerateIfNotExistsCondition()生成された をAccessCondition渡してください。

Parameters:

Returns:

Throws:

public void putRangeFromURL(final long destOffset, final long length, final URI sourceUri, final long sourceOffset)

あるファイルから別のファイルに範囲をアップロードします。

Parameters:

Throws:

public void putRangeFromURL(final long destOffset, final long length, final URI sourceUri, final long sourceOffset, FileRequestOptions options, OperationContext opContext)

指定したリース ID、要求オプション、および操作コンテキストを使用して、あるファイルから別のファイルに範囲をアップロードします

Parameters:

Throws:

public void resize(long size)

指定したサイズにファイルのサイズを変更します。

Parameters:

Throws:

public void resize(long size, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定したサイズにファイルのサイズを変更します。

Parameters:

Throws:

public void setFilePermission(String filePermission)

設定するファイルのファイル権限を設定します

Parameters:

public final void setMetadata(final HashMap metadata)

ファイルのメタデータを設定します。

Parameters:

protected final void setProperties(final FileProperties properties)

ファイルのプロパティを設定します。

Parameters:

protected final void setShare(final CloudFileShare share)

ファイルの共有を設定します。

Parameters:

protected void setStorageUri(final StorageUri storageUri)

すべての場所の URI の一覧を設定します。

Parameters:

public void setStreamMinimumReadSizeInBytes(final int minimumReadSize)

を使用する場合の最小読み取りサイズを FileInputStream設定します。

Parameters:

Throws:

public void setStreamWriteSizeInBytes(final int streamWriteSizeInBytes)

に書き込むときにバッファーに格納するバイト数を FileOutputStream設定します。

Parameters:

Throws:

public final String startCopy(final CloudBlob sourceBlob)

BLOB の内容、プロパティ、およびメタデータの新しいファイルへのコピーを開始するようにサービスに要求します。

Parameters:

Returns:

Throws:

public final String startCopy(final CloudBlob sourceBlob, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, FileRequestOptions options, OperationContext opContext)

指定したアクセス条件、リース ID、要求オプション、および操作コンテキストを使用して、ファイルの内容、プロパティ、およびメタデータの新しいファイルへのコピーを開始するようにサービスに要求します。

Parameters:

Returns:

Throws:

public final String startCopy(final CloudFile sourceFile)

Azure ファイルの内容、プロパティ、メタデータの新しい Azure ファイルへのコピーを開始するようにサービスに要求します。

Parameters:

Returns:

Throws:

public final String startCopy(final CloudFile sourceFile, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, FileRequestOptions options, OperationContext opContext)

指定したアクセス条件、リース ID、要求オプション、操作コンテキストを使用して、サービスに対して、Azure ファイルの内容、プロパティ、およびメタデータの新しい Azure ファイルへのコピーを開始するように要求します。

Parameters:

Returns:

Throws:

public final String startCopy(final URI source)

URI の内容、プロパティ、メタデータの新しい Azure ファイルへのコピーを開始するようにサービスに要求します。

Parameters:

Returns:

Throws:

public final String startCopy(final URI source, final AccessCondition sourceAccessCondition, final AccessCondition destinationAccessCondition, FileRequestOptions options, OperationContext opContext)

指定したアクセス条件、リース ID、要求オプション、操作コンテキストを使用して、URI のコンテンツ、プロパティ、メタデータの新しい Azure ファイルへのコピーを開始するようにサービスに要求します。

Parameters:

Returns:

Throws:

protected void updateEtagAndLastModifiedFromResponse(HttpURLConnection request)

Parameters:

protected void updateLengthFromResponse(HttpURLConnection request)

Parameters:

public void upload(final InputStream sourceStream, final long length)

ソース ストリーム データをファイルにアップロードします。 ファイルがサービスに既に存在する場合は、上書きされます。

Parameters:

Throws:

public void upload(final InputStream sourceStream, final long length, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定したアクセス条件、要求オプション、および操作コンテキストを使用して、ソース ストリーム データをファイルにアップロードします。 ファイルがサービスに既に存在する場合は、上書きされます。

Parameters:

Throws:

public void uploadFromByteArray(final byte[] buffer, final int offset, final int length)

バイト配列内のデータからファイルをアップロードします。 ファイルがサービスに既に存在する場合は、上書きされます。

Parameters:

Throws:

public void uploadFromByteArray(final byte[] buffer, final int offset, final int length, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

バイト配列内のデータからファイルをアップロードします。 ファイルがサービスに既に存在する場合は、上書きされます。

Parameters:

Throws:

public void uploadFromFile(final String path)

ローカル ファイルをアップロードします。 ファイルがサービスに既に存在する場合は、上書きされます。

Parameters:

Throws:

public void uploadFromFile(final String path, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

ローカル ファイルからファイルをアップロードします。 ファイルがサービスに既に存在する場合は、上書きされます。

Parameters:

Throws:

public final void uploadMetadata()

ファイルのメタデータをストレージ サービスにアップロードします。

を使用して downloadAttributes() 、Microsoft Azure ストレージ サービスからファイルのプロパティとメタデータの最新の値を取得します。

Throws:

public final void uploadMetadata(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

アクセス条件、要求オプション、および操作コンテキストを使用して、ファイルのメタデータをストレージ サービスにアップロードします。

を使用して downloadAttributes() 、Microsoft Azure ストレージ サービスからファイルのプロパティとメタデータの最新の値を取得します。

Parameters:

Throws:

public final void uploadProperties()

ファイルのプロパティをストレージ サービスにアップロードします。

を使用して downloadAttributes() 、Microsoft Azure ストレージ サービスからファイルのプロパティとメタデータの最新の値を取得します。

Throws:

public final void uploadProperties(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

アクセス条件、要求オプション、および操作コンテキストを使用して、ファイルのプロパティをアップロードします。

を使用して downloadAttributes() 、Microsoft Azure ストレージ サービスからファイルのプロパティとメタデータの最新の値を取得します。

Parameters:

Throws:

public void uploadRange(final InputStream sourceStream, final long offset, final long length)

範囲をファイルにアップロードします。

Parameters:

Throws:

public void uploadRange(final InputStream sourceStream, final long offset, final long length, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定したリース ID、要求オプション、および操作コンテキストを使用して、範囲をファイルにアップロードします。

Parameters:

Throws:

public void uploadText(final String content)

プラットフォームの既定のエンコードを使用して、文字列からファイルをアップロードします。 ファイルがサービスに既に存在する場合は、上書きされます。

Parameters:

Throws:

public void uploadText(final String content, final String charsetName, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

指定したエンコードを使用して、文字列からファイルをアップロードします。 ファイルがサービスに既に存在する場合は、上書きされます。

Parameters:

Throws: