org.deviceconnect.android.provider

クラス FileProvider

java.lang.Object

android.content.ContentProvider

org.deviceconnect.android.provider.FileProvider

すべての実装されたインタフェース:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2

public class FileProvider
extends android.content.ContentProvider

ファイル用のContentProvider. このクラスはデバイスプラグインで一時的にファイルを保持してdConnectManagerにファイルを 送信するためのContentProviderになる。 FileProfileを実装する場合には、必須となる。 AndroidManifest.xml に以下の記述を追加する必要がある。

 <provider
     android:name="org.deviceconnect.android.provider.FileProvider"
     android:authorities="com.mycompany.android.deviceplugin.provider"
     android:exported="true" />
 

android:authoritiesの部分には、各デバイスプラグインでauthoritiesを設定すること。

デフォルトでは、SDカードの直下にデバイスプラグインのパッケージ名のフォルダを作成して、その下にファイルが保存される。
保存場所を変えたい場合には、providerにメタデータを持たせることで変更できる。

 <provider
     android:name="org.deviceconnect.android.provider.FileProvider"
     android:authorities="com.mycompany.android.deviceplugin.provider"
     android:exported="true">
     <meta-data
              android:name="filelocation"
              android:resource="@xml/filelocation" />
 <provider>
 

res/xml/filelocation.xmlを用意する。
以下のようにexternal-locationタグを指定することで、SDカードに保存される。

 <file-locations xmlns:android="http://schemas.android.com/apk/res/android">
     <external-location path="sample" />
 </file-locations>
 

属性pathには、SDカードからのパスを指定することができる。

以下のようにinternal-locationタグを指定することで、端末内のアプリ領域に保存される。

 <file-locations xmlns:android="http://schemas.android.com/apk/res/android">
     <internal-location path="sample" />
 </file-locations>
 

属性pathには、/data/data/{アプリのパッケージ名}/filesからのパスを指定することができる。

なお、属性pathには絶対パス、相対パスのいずれかを指定できる。 絶対パスの先頭の / は省略可能。つまり、path="/path/to/file" と path="path/to/file" は同じ意味になる。

複数のexternal-location や internal-locationタグが記載された場合には、最後のタグが反映される。

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	FileProvider.FileCursor ファイルの情報を取得するためのCursor.

クラスから継承されたネストされたクラス/インタフェース android.content.ContentProvider

android.content.ContentProvider.CallingIdentity, android.content.ContentProvider.PipeDataWriter<T>

フィールドのサマリー

インタフェースから継承されたフィールド android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
FileProvider()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
int	delete(android.net.Uri uri, java.lang.String selection, java.lang.String[] selectionArgs)
java.io.File	getBasePath() ファイルを管理するためのベースとなるパスを取得する.
java.lang.String	getType(android.net.Uri uri)
android.net.Uri	insert(android.net.Uri uri, android.content.ContentValues values)
boolean	onCreate()
android.os.ParcelFileDescriptor	openFile(android.net.Uri uri, java.lang.String mode) ファイルを入出力用のメソッド.
android.database.Cursor	query(android.net.Uri uri, java.lang.String[] projection, java.lang.String selection, java.lang.String[] selectionArgs, java.lang.String sortOrder)
int	update(android.net.Uri uri, android.content.ContentValues values, java.lang.String selection, java.lang.String[] selectionArgs)

クラスから継承されたメソッド android.content.ContentProvider

applyBatch, applyBatch, attachInfo, bulkInsert, call, call, canonicalize, clearCallingIdentity, dump, getCallingPackage, getContext, getPathPermissions, getReadPermission, getStreamTypes, getWritePermission, isTemporary, onConfigurationChanged, onLowMemory, onTrimMemory, openAssetFile, openAssetFile, openFile, openFileHelper, openPipeHelper, openTypedAssetFile, openTypedAssetFile, query, query, refresh, restoreCallingIdentity, setPathPermissions, setReadPermission, setWritePermission, shutdown, uncanonicalize

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

FileProvider

public FileProvider()

メソッドの詳細

openFile

public android.os.ParcelFileDescriptor openFile(android.net.Uri uri,
                                                java.lang.String mode)
                                         throws java.io.FileNotFoundException

ファイルを入出力用のメソッド.

オーバーライド:

openFile クラス内 android.content.ContentProvider

パラメータ:

uri - ContentProviderのURL

mode - 書き込み読み込み時のモード

戻り値:

ファイルを読み書きするためのストリーム

例外:

java.io.FileNotFoundException - ファイルが見つからない場合に発生

getBasePath

public java.io.File getBasePath()

ファイルを管理するためのベースとなるパスを取得する.

戻り値:

パス

delete

public int delete(android.net.Uri uri,
                  java.lang.String selection,
                  java.lang.String[] selectionArgs)

定義:

delete クラス内 android.content.ContentProvider

getType

public java.lang.String getType(android.net.Uri uri)

定義:

getType クラス内 android.content.ContentProvider

insert

public android.net.Uri insert(android.net.Uri uri,
                              android.content.ContentValues values)

定義:

insert クラス内 android.content.ContentProvider

onCreate

public boolean onCreate()

定義:

onCreate クラス内 android.content.ContentProvider

query

public android.database.Cursor query(android.net.Uri uri,
                                     java.lang.String[] projection,
                                     java.lang.String selection,
                                     java.lang.String[] selectionArgs,
                                     java.lang.String sortOrder)

定義:

query クラス内 android.content.ContentProvider

update

public int update(android.net.Uri uri,
                  android.content.ContentValues values,
                  java.lang.String selection,
                  java.lang.String[] selectionArgs)

定義:

update クラス内 android.content.ContentProvider