com.evernote.client.android.asyncclient

Class EvernoteClientFactory

java.lang.Object

com.evernote.client.android.asyncclient.EvernoteClientFactory

public class EvernoteClientFactory
extends java.lang.Object

A factory to create async wrappers around a NoteStore.Client. Use the corresponding EvernoteClientFactory.Builder to create an instance.

Try to reuse a created instances. A factory caches created NoteStore.Clients, their wrappers and internal helper objects like the http client. The easiest way to get access to a factory is to call EvernoteSession.getEvernoteClientFactory().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EvernoteClientFactory.Builder A builder to construct an EvernoteClientFactory.

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteStore	mByteStore
protected EvernoteSession	mEvernoteSession
protected java.util.concurrent.ExecutorService	mExecutorService
protected java.util.Map<java.lang.String,java.lang.String>	mHeaders
protected OkHttpClient	mHttpClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EvernoteClientFactory(EvernoteSession session, OkHttpClient httpClient, ByteStore byteStore, java.util.Map<java.lang.String,java.lang.String> headers, java.util.concurrent.ExecutorService executorService)

Method Summary

Modifier and Type	Method and Description
protected void	authenticateToBusiness()
protected void	checkLoggedIn()
protected TBinaryProtocol	createBinaryProtocol(java.lang.String url)
protected EvernoteBusinessNotebookHelper	createBusinessNotebookHelper()
protected EvernoteNoteStoreClient	createEvernoteNoteStoreClient(java.lang.String url, java.lang.String authToken)
protected EvernoteSearchHelper	createEvernoteSearchHelper()
protected EvernoteHtmlHelper	createHtmlHelper(java.lang.String authToken)
protected java.lang.String	createKey(java.lang.String url, java.lang.String authToken)
protected EvernoteLinkedNotebookHelper	createLinkedNotebookHelper(LinkedNotebook linkedNotebook)
protected NoteStore.Client	createNoteStoreClient(java.lang.String url)
protected EvernoteUserStoreClient	createUserStoreClient(java.lang.String url, java.lang.String authToken)
EvernoteBusinessNotebookHelper	getBusinessNotebookHelper() Returns an async wrapper providing several helper methods for business notebooks.
java.util.concurrent.Future<EvernoteBusinessNotebookHelper>	getBusinessNotebookHelperAsync(EvernoteCallback<EvernoteBusinessNotebookHelper> callback)
EvernoteSearchHelper	getEvernoteSearchHelper()
EvernoteHtmlHelper	getHtmlHelperBusiness() Use this method, if you want to download a business note as HTML.
java.util.concurrent.Future<EvernoteHtmlHelper>	getHtmlHelperBusinessAsync(EvernoteCallback<EvernoteHtmlHelper> callback)
EvernoteHtmlHelper	getHtmlHelperDefault() Use this method, if you want to download a personal note as HTML.
EvernoteHtmlHelper	getLinkedHtmlHelper(LinkedNotebook linkedNotebook) Use this method, if you want to download a linked note as HTML.
java.util.concurrent.Future<EvernoteHtmlHelper>	getLinkedHtmlHelperAsync(LinkedNotebook linkedNotebook, EvernoteCallback<EvernoteHtmlHelper> callback)
EvernoteLinkedNotebookHelper	getLinkedNotebookHelper(LinkedNotebook linkedNotebook) Returns an async wrapper providing several helper methods for this LinkedNotebook.
java.util.concurrent.Future<EvernoteLinkedNotebookHelper>	getLinkedNotebookHelperAsync(LinkedNotebook linkedNotebook, EvernoteCallback<EvernoteLinkedNotebookHelper> callback)
EvernoteNoteStoreClient	getNoteStoreClient()
EvernoteNoteStoreClient	getNoteStoreClient(java.lang.String url, java.lang.String authToken)
EvernoteUserStoreClient	getUserStoreClient()
EvernoteUserStoreClient	getUserStoreClient(java.lang.String url, java.lang.String authToken)
protected boolean	isBusinessAuthExpired()

Methods inherited from class java.lang.Object

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

Field Detail

mEvernoteSession

protected final EvernoteSession mEvernoteSession

mHttpClient

protected final OkHttpClient mHttpClient

mByteStore

protected final ByteStore mByteStore

mHeaders

protected final java.util.Map<java.lang.String,java.lang.String> mHeaders

mExecutorService

protected final java.util.concurrent.ExecutorService mExecutorService

Constructor Detail

EvernoteClientFactory

protected EvernoteClientFactory(EvernoteSession session,
                                OkHttpClient httpClient,
                                ByteStore byteStore,
                                java.util.Map<java.lang.String,java.lang.String> headers,
                                java.util.concurrent.ExecutorService executorService)

Method Detail

getUserStoreClient

public EvernoteUserStoreClient getUserStoreClient()

Returns:

The default client for this session. It references the signed in user's user store.

See Also:

UserStore, UserStore.Client

getUserStoreClient

public EvernoteUserStoreClient getUserStoreClient(java.lang.String url,
                                                  java.lang.String authToken)

Returns:

An async wrapper for UserStore.Client with this specific url and authentication token combination.

See Also:

UserStore, UserStore.Client

createUserStoreClient

protected EvernoteUserStoreClient createUserStoreClient(java.lang.String url,
                                                        java.lang.String authToken)

getNoteStoreClient

public EvernoteNoteStoreClient getNoteStoreClient()

Returns:

The default client for this session. It references the user's private note store.

See Also:

getNoteStoreClient(String, String), AuthenticationResult.getNoteStoreUrl()

getNoteStoreClient

public EvernoteNoteStoreClient getNoteStoreClient(java.lang.String url,
                                                  java.lang.String authToken)

Parameters:

url - The note store URL.

authToken - The authentication token to get access to this note store.

Returns:

An async wrapper for NoteStore.Client with this specific url and authentication token combination.

See Also:

NoteStore, NoteStore.Client

getLinkedNotebookHelper

public EvernoteLinkedNotebookHelper getLinkedNotebookHelper(LinkedNotebook linkedNotebook)
                                                     throws EDAMUserException,
                                                            EDAMSystemException,
                                                            EDAMNotFoundException,
                                                            TException

Returns an async wrapper providing several helper methods for this LinkedNotebook. With EvernoteLinkedNotebookHelper.getClient() you can get access to the underlying EvernoteNoteStoreClient, which references the LinkedNotebook's note store URL.

Parameters:

linkedNotebook - The referenced LinkedNotebook. Its GUID and share key must not be null.

Returns:

An async wrapper providing several helper methods.

Throws:

EDAMUserException

EDAMSystemException

EDAMNotFoundException

TException

getLinkedNotebookHelperAsync

public java.util.concurrent.Future<EvernoteLinkedNotebookHelper> getLinkedNotebookHelperAsync(LinkedNotebook linkedNotebook,
                                                                                              EvernoteCallback<EvernoteLinkedNotebookHelper> callback)

See Also:

getLinkedNotebookHelper(LinkedNotebook)

createLinkedNotebookHelper

protected EvernoteLinkedNotebookHelper createLinkedNotebookHelper(LinkedNotebook linkedNotebook)
                                                           throws EDAMUserException,
                                                                  EDAMSystemException,
                                                                  EDAMNotFoundException,
                                                                  TException

Throws:

EDAMUserException

EDAMSystemException

EDAMNotFoundException

TException

getBusinessNotebookHelper

public EvernoteBusinessNotebookHelper getBusinessNotebookHelper()
                                                         throws TException,
                                                                EDAMUserException,
                                                                EDAMSystemException

Returns an async wrapper providing several helper methods for business notebooks. With EvernoteBusinessNotebookHelper.getClient() you can get access to the underlying EvernoteNoteStoreClient, which references the business note store URL.

Returns:

An async wrapper providing several helper methods.

Throws:

TException

EDAMUserException

EDAMSystemException

getBusinessNotebookHelperAsync

public java.util.concurrent.Future<EvernoteBusinessNotebookHelper> getBusinessNotebookHelperAsync(EvernoteCallback<EvernoteBusinessNotebookHelper> callback)

See Also:

getBusinessNotebookHelper()

createBusinessNotebookHelper

protected EvernoteBusinessNotebookHelper createBusinessNotebookHelper()
                                                               throws TException,
                                                                      EDAMUserException,
                                                                      EDAMSystemException

Throws:

TException

EDAMUserException

EDAMSystemException

getHtmlHelperDefault

public EvernoteHtmlHelper getHtmlHelperDefault()

Use this method, if you want to download a personal note as HTML.

Returns:

An async wrapper to load a note as HTML from the Evernote service.

getLinkedHtmlHelper

public EvernoteHtmlHelper getLinkedHtmlHelper(LinkedNotebook linkedNotebook)
                                       throws EDAMUserException,
                                              EDAMSystemException,
                                              EDAMNotFoundException,
                                              TException

Use this method, if you want to download a linked note as HTML.

Parameters:

linkedNotebook - The referenced LinkedNotebook. Its GUID and share key must not be null.

Returns:

An async wrapper to load a note as HTML from the Evernote service.

Throws:

EDAMUserException

EDAMSystemException

EDAMNotFoundException

TException

getLinkedHtmlHelperAsync

public java.util.concurrent.Future<EvernoteHtmlHelper> getLinkedHtmlHelperAsync(LinkedNotebook linkedNotebook,
                                                                                EvernoteCallback<EvernoteHtmlHelper> callback)

See Also:

getLinkedNotebookHelper(LinkedNotebook)

getHtmlHelperBusiness

public EvernoteHtmlHelper getHtmlHelperBusiness()
                                         throws TException,
                                                EDAMUserException,
                                                EDAMSystemException

Use this method, if you want to download a business note as HTML.

Returns:

An async wrapper to load a business note as HTML from the Evernote service.

Throws:

TException

EDAMUserException

EDAMSystemException

getHtmlHelperBusinessAsync

public java.util.concurrent.Future<EvernoteHtmlHelper> getHtmlHelperBusinessAsync(EvernoteCallback<EvernoteHtmlHelper> callback)

See Also:

getHtmlHelperBusiness()

createHtmlHelper

protected EvernoteHtmlHelper createHtmlHelper(java.lang.String authToken)

getEvernoteSearchHelper

public EvernoteSearchHelper getEvernoteSearchHelper()

Returns:

An async wrapper to search notes in multiple note stores.

createEvernoteSearchHelper

protected EvernoteSearchHelper createEvernoteSearchHelper()

createBinaryProtocol

protected TBinaryProtocol createBinaryProtocol(java.lang.String url)

createNoteStoreClient

protected NoteStore.Client createNoteStoreClient(java.lang.String url)

createEvernoteNoteStoreClient

protected EvernoteNoteStoreClient createEvernoteNoteStoreClient(java.lang.String url,
                                                                java.lang.String authToken)

createKey

protected final java.lang.String createKey(java.lang.String url,
                                           java.lang.String authToken)

authenticateToBusiness

protected final void authenticateToBusiness()
                                     throws TException,
                                            EDAMUserException,
                                            EDAMSystemException

Throws:

TException

EDAMUserException

EDAMSystemException

isBusinessAuthExpired

protected final boolean isBusinessAuthExpired()

checkLoggedIn

protected void checkLoggedIn()