no.nordicsemi.android.log.localprovider

Class LocalLogContentProvider

java.lang.Object

android.content.ContentProvider

no.nordicsemi.android.log.localprovider.LocalLogContentProvider

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2

public abstract class LocalLogContentProvider
extends android.content.ContentProvider

If the nRF Logger application is not installed an app may use the LocalLogContentProvider to show log entries locally, in the application. This provider is a limited version of the one in nRF Logger. It does not support different applications, marking log sessions with a star of a flag nor giving them description. nRF Connect makes use of this provider if nRF Logger is not installed. The log sessions are stored until user closes the connection to the device and removed afterwards, but you may keep them and make your own log viewer in the application.

Remember to add the <provider> tag to the AndroidManifest.xml file giving the same authority as you will return in the derived class.

Nested Class Summary

Nested classes/interfaces inherited from class android.content.ContentProvider

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	SLEEP_AFTER_YIELD_DELAY Duration in ms to sleep after successfully yielding the lock during a batch operation.

Fields inherited from interface 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

Constructor Summary

Constructors

Constructor and Description
LocalLogContentProvider()

Method Summary

Modifier and Type	Method and Description
android.content.ContentProviderResult[]	applyBatch(java.util.ArrayList<android.content.ContentProviderOperation> operations)
int	bulkInsert(android.net.Uri uri, android.content.ContentValues[] values)
int	delete(android.net.Uri uri, java.lang.String selection, java.lang.String[] selectionArgs)
protected abstract android.net.Uri	getAuthorityUri() Returns the provider authority.
protected no.nordicsemi.android.log.localprovider.LocalLogDatabaseHelper	getDatabaseHelper(android.content.Context context)
java.lang.String	getType(android.net.Uri uri)
android.net.Uri	insert(android.net.Uri uri, android.content.ContentValues values)
protected android.net.Uri	insertInTransaction(android.net.Uri uri, android.content.ContentValues values)
protected void	notifyChange(android.net.Uri uri)
boolean	onCreate()
android.database.Cursor	query(android.net.Uri uri, java.lang.String[] projection, java.lang.String selection, java.lang.String[] selectionArgs, java.lang.String sortOrder)
void	setDbHelperToSerializeOn(android.database.sqlite.SQLiteOpenHelper serializeOnDbHelper, java.lang.String tag) Specifies a database helper (and corresponding tag) to serialize all transactions on.
int	update(android.net.Uri uri, android.content.ContentValues values, java.lang.String selection, java.lang.String[] selectionArgs)
protected boolean	yield(no.nordicsemi.android.log.localprovider.LogTransaction transaction)

Methods inherited from class android.content.ContentProvider

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

Methods inherited from class java.lang.Object

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

Field Detail

SLEEP_AFTER_YIELD_DELAY

protected static final int SLEEP_AFTER_YIELD_DELAY

Duration in ms to sleep after successfully yielding the lock during a batch operation.

See Also:

Constant Field Values

Constructor Detail

LocalLogContentProvider

public LocalLogContentProvider()

Method Detail

getAuthorityUri

protected abstract android.net.Uri getAuthorityUri()

Returns the provider authority. Use one based on your custom package name, e.g. 'com.example.log'.

Returns:

The provider authority.

getDatabaseHelper

protected no.nordicsemi.android.log.localprovider.LocalLogDatabaseHelper getDatabaseHelper(android.content.Context context)

setDbHelperToSerializeOn

public void setDbHelperToSerializeOn(android.database.sqlite.SQLiteOpenHelper serializeOnDbHelper,
                                     java.lang.String tag)

Specifies a database helper (and corresponding tag) to serialize all transactions on.

onCreate

public boolean onCreate()

Specified by:

onCreate in class android.content.ContentProvider

getType

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

Specified by:

getType in class android.content.ContentProvider

query

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

Specified by:

query in class android.content.ContentProvider

bulkInsert

public int bulkInsert(@NonNull
                      android.net.Uri uri,
                      @NonNull
                      android.content.ContentValues[] values)

Overrides:

bulkInsert in class android.content.ContentProvider

applyBatch

@NonNull
public android.content.ContentProviderResult[] applyBatch(@NonNull
                                                                   java.util.ArrayList<android.content.ContentProviderOperation> operations)
                                                            throws android.content.OperationApplicationException

Overrides:

applyBatch in class android.content.ContentProvider

Throws:

android.content.OperationApplicationException

insert

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

Specified by:

insert in class android.content.ContentProvider

delete

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

Specified by:

delete in class android.content.ContentProvider

update

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

Specified by:

update in class android.content.ContentProvider

insertInTransaction

protected android.net.Uri insertInTransaction(@NonNull
                                              android.net.Uri uri,
                                              android.content.ContentValues values)

yield

protected boolean yield(no.nordicsemi.android.log.localprovider.LogTransaction transaction)

notifyChange

protected void notifyChange(android.net.Uri uri)