Interface UploadFileHandle

All Known Implementing Classes:
TestUploadFileHandle

public interface UploadFileHandle
アップロードされたファイルを表すインタフェース。
See Also:
RequestContext.getParamAsFile(String), RequestContext.getParamsAsFile(String)
  • Method Summary

    Modifier and Type Method Description
    java.nio.file.Path copyTo​(java.nio.file.Path target, java.nio.file.CopyOption... options)
    アップロードされたファイルを指定のtargetへコピーする。
    java.lang.String getFileName()  
    java.io.InputStream getInputStream()
    アップロードされたファイルのバイナリを読み込むためのInputStreamを取得。
    long getSize()  
    java.lang.String getType()  
    boolean isSizeOver()
    アップロードされたファイルのファイルサイズが上限値を超えていた場合true。
    java.nio.file.Path moveTo​(java.nio.file.Path target, java.nio.file.CopyOption... options)
    アップロードされたファイルを指定のtargetへ移動する。
    BinaryReference toBinaryReference()
    アップロードされたファイルをBinaryReferenceのインスタンスに変換。 変換されたBinaryReferenceはEntityの属性として保存されるまでは、 テンポラリLOBとしてアップロードしたユーザのみが参照可能な状態。
  • Method Details

    • toBinaryReference

      BinaryReference toBinaryReference()
      アップロードされたファイルをBinaryReferenceのインスタンスに変換。 変換されたBinaryReferenceはEntityの属性として保存されるまでは、 テンポラリLOBとしてアップロードしたユーザのみが参照可能な状態。
      Returns:
      Throws:
      UploadFileSizeOverException - アップロードされたファイルのファイルサイズが上限値を超えていた場合
    • getInputStream

      java.io.InputStream getInputStream()
      アップロードされたファイルのバイナリを読み込むためのInputStreamを取得。
      Returns:
      Throws:
      UploadFileSizeOverException - アップロードされたファイルのファイルサイズが上限値を超えていた場合
    • copyTo

      java.nio.file.Path copyTo​(java.nio.file.Path target, java.nio.file.CopyOption... options)
      アップロードされたファイルを指定のtargetへコピーする。
      Parameters:
      target -
      options -
      Returns:
      コピー先のpath
    • moveTo

      java.nio.file.Path moveTo​(java.nio.file.Path target, java.nio.file.CopyOption... options)
      アップロードされたファイルを指定のtargetへ移動する。
      Parameters:
      target -
      options -
      Returns:
      移動先のpath
    • getType

      java.lang.String getType()
    • getFileName

      java.lang.String getFileName()
    • getSize

      long getSize()
    • isSizeOver

      boolean isSizeOver()
      アップロードされたファイルのファイルサイズが上限値を超えていた場合true。
      Returns: