Package com.yahoo.documentapi.local

Class LocalSyncSession

java.lang.Object

com.yahoo.documentapi.local.LocalSyncSession

All Implemented Interfaces:

Session, SyncSession

public class LocalSyncSession
extends Object
implements SyncSession

Author:

bratseth

Constructor Summary

Constructors

Constructor	Description
LocalSyncSession(LocalDocumentAccess access)

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroys this session and frees up any resources it has held.
com.yahoo.document.Document	get(com.yahoo.document.DocumentId id, String fieldSet, DocumentProtocol.Priority priority, Duration timeout)	Gets a document with timeout.
com.yahoo.document.Document	get(com.yahoo.document.DocumentId id, Duration timeout)	Gets a document with timeout.
Response	getNext()	Returns the next response of this session.
Response	getNext(int timeout)	Returns the next response of this session.
void	put(com.yahoo.document.DocumentPut documentPut)	Puts a document.
void	put(com.yahoo.document.DocumentPut documentPut, DocumentProtocol.Priority priority)	Puts a document.
boolean	remove(com.yahoo.document.DocumentRemove documentRemove)	Removes a document if it is present and condition is fulfilled.
boolean	remove(com.yahoo.document.DocumentRemove documentRemove, DocumentProtocol.Priority priority)	Removes a document if it is present.
boolean	update(com.yahoo.document.DocumentUpdate update)	Updates a document.
boolean	update(com.yahoo.document.DocumentUpdate update, DocumentProtocol.Priority pri)	Updates a document.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.documentapi.SyncSession

get, get, get, put, remove, update

Constructor Detail

LocalSyncSession

public LocalSyncSession(LocalDocumentAccess access)

Method Detail

put

public void put(com.yahoo.document.DocumentPut documentPut)

Description copied from interface: SyncSession

Puts a document. When this method returns, the document is safely received. This enables setting condition compared to using Document.

Specified by:

put in interface SyncSession

Parameters:

documentPut - the DocumentPut operation

put

public void put(com.yahoo.document.DocumentPut documentPut,
                DocumentProtocol.Priority priority)

Description copied from interface: SyncSession

Puts a document. When this method returns, the document is safely received.

Specified by:

put in interface SyncSession

Parameters:

documentPut - the DocumentPut operation

priority - the priority with which to perform this operation

get

public com.yahoo.document.Document get(com.yahoo.document.DocumentId id,
                                       Duration timeout)

Description copied from interface: SyncSession

Gets a document with timeout.

Specified by:

get in interface SyncSession

Parameters:

id - the id of the document to get

timeout - timeout. If timeout is null, an unspecified default will be used

Returns:

the document with this id, or null if there is none

get

public com.yahoo.document.Document get(com.yahoo.document.DocumentId id,
                                       String fieldSet,
                                       DocumentProtocol.Priority priority,
                                       Duration timeout)

Description copied from interface: SyncSession

Gets a document with timeout.

Specified by:

get in interface SyncSession

Parameters:

id - the id of the document to get

fieldSet - a comma-separated list of fields to retrieve

priority - the priority with which to perform this operation

timeout - timeout. If timeout is null, an unspecified default will be used

Returns:

the known document having this id, or null if there is no document having this id

remove

public boolean remove(com.yahoo.document.DocumentRemove documentRemove)

Description copied from interface: SyncSession

Removes a document if it is present and condition is fulfilled.

Specified by:

remove in interface SyncSession

Parameters:

documentRemove - document to delete

Returns:

true if the document with this id was removed, false otherwise

remove

public boolean remove(com.yahoo.document.DocumentRemove documentRemove,
                      DocumentProtocol.Priority priority)

Description copied from interface: SyncSession

Removes a document if it is present.

Specified by:

remove in interface SyncSession

Parameters:

documentRemove - document remove operation

priority - the priority with which to perform this operation

Returns:

true if the document with this id was removed, false otherwise.

update

public boolean update(com.yahoo.document.DocumentUpdate update)

Description copied from interface: SyncSession

Updates a document.

Specified by:

update in interface SyncSession

Parameters:

update - the updates to perform

Returns:

false if the updates could not be applied as the document does not exist and create-if-non-existent is not set.

update

public boolean update(com.yahoo.document.DocumentUpdate update,
                      DocumentProtocol.Priority pri)

Description copied from interface: SyncSession

Updates a document.

Specified by:

update in interface SyncSession

Parameters:

update - the updates to perform.

pri - the priority with which to perform this operation

Returns:

false if the updates could not be applied as the document does not exist and create-if-non-existent is not set.

getNext

public Response getNext()

Description copied from interface: Session

Returns the next response of this session. This method returns immediately.

Specified by:

getNext in interface Session

Returns:

the next response, or null if no response is ready at this time

getNext

public Response getNext(int timeout)

Description copied from interface: Session

Returns the next response of this session. This will block until a response is ready or until the given timeout is reached

Specified by:

getNext in interface Session

Parameters:

timeout - the max time to wait for a response.

Returns:

the next response, or null if no response becomes ready before the timeout expires

destroy

public void destroy()

Description copied from interface: Session

Destroys this session and frees up any resources it has held. Making further calls on a destroyed session causes a runtime exception.

Specified by:

destroy in interface Session