Package com.attivio.sdk.client

Interface ExternalizableStore

All Known Subinterfaces:

SearchProfileApi, TransportDefinitionStore, TriggerApi

All Known Implementing Classes:

MockTransportDefinitionStore

public interface ExternalizableStore

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ExternalizableStore.ImportOption

Method Summary

Modifier and Type	Method	Description
long	exportStore(java.io.OutputStream output, java.lang.Long ifModifiedSince)	Export the model for the store to a jar file written to output.
java.lang.String	getStoreName()	Get the name of this store.
long	getStoreRevision()	Get the current revision number for this store.
void	importStore(java.io.InputStream input, java.lang.Long ifUnmodifiedSince, ExternalizableStore.ImportOption... options)	Import the model for the store from a jar file read from input.

Method Detail

getStoreName

java.lang.String getStoreName()

Get the name of this store.

This name will be the location that store configuration is synchronized to in the project's conf directory.

getStoreRevision

long getStoreRevision()
               throws AttivioException

Get the current revision number for this store.

NOTE: revision numbers are not guaranteed to follow any sequence and may represent arbitrary checksums of internal data.

Throws:

AttivioException

exportStore

long exportStore(java.io.OutputStream output,
                 java.lang.Long ifModifiedSince)
          throws AttivioException

Export the model for the store to a jar file written to output.

Parameters:

output - The OutputStream to write the jar export to.

ifModifiedSince - If non-null, will only write export to output if the store's current revision does not match this value.

Returns:

The store revision for the export.

Throws:

AttivioException

importStore

void importStore(java.io.InputStream input,
                 java.lang.Long ifUnmodifiedSince,
                 ExternalizableStore.ImportOption... options)
          throws AttivioException

Import the model for the store from a jar file read from input.

Parameters:

input - The inputstream that contains the jar.

ifUnmodifiedSince - If non-null, will only perform import if the store's current revision matches this value.

options - A list of ExternalizableStore.ImportOptions to use when importing to the store.

Throws:

AttivioException