com.exalead.papi.framework.source.adapter

Class SourceAdapter<Skey extends Key>

java.lang.Object

com.exalead.papi.framework.source.adapter.SourceAdapter<Skey>

Direct Known Subclasses:

FilesystemConnectorSourceAdapter, com.exalead.papi.connectors.filesystem.FilesystemSourceAdapter, SpecializedSourceAdapter

public abstract class SourceAdapter<Skey extends Key>
extends java.lang.Object

A SourceAdapter is a class which is used to retrieve document from source, you have to implement all abstract methods.

Field Summary

Fields

Modifier and Type	Field and Description
protected GenericMultiThreadedConnector<Skey>	connector

Constructor Summary

Constructors

Constructor and Description
SourceAdapter()

Method Summary

Modifier and Type	Method and Description
MetaContainer	getAllMetaContainer(Skey key) Get all metas associated to the key (non security meta + security meta)
GenericMultiThreadedConnector<Skey>	getConnector()
abstract MetaContainer	getNonSecurityMetaContainer(Skey key) This method is used to retrieve all meta data of a document
abstract PartContainer	getPartContainer(Skey key) This method is used to retrieve document part
abstract MetaContainer	getSecurityMetaContainer(Skey key) This method is used to retrieve security tokens of a document.
java.lang.String	getSecurityMetaHash(MetaContainer metas) Get a hash corresponding to 'meta' security metadata.
java.lang.String	getSecurityMetaHash(Skey key) Get a hash corresponding to the key's security metadata.
abstract java.lang.String	getStamp(Skey key) This method is used to determine if a document has changed (if stamps are equals, the document is considered unchanged)
void	setConnector(GenericMultiThreadedConnector<Skey> connector)

Methods inherited from class java.lang.Object

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

Field Detail

connector

protected GenericMultiThreadedConnector<Skey extends Key> connector

Constructor Detail

SourceAdapter

public SourceAdapter()

Method Detail

setConnector

public void setConnector(GenericMultiThreadedConnector<Skey> connector)

getConnector

public GenericMultiThreadedConnector<Skey> getConnector()

getPartContainer

public abstract PartContainer getPartContainer(Skey key)
                                        throws java.lang.Exception

This method is used to retrieve document part

Parameters:

key - ID of the document

Returns:

the bytes associated to the key

Throws:

java.lang.Exception

getStamp

public abstract java.lang.String getStamp(Skey key)
                                   throws java.io.IOException

This method is used to determine if a document has changed (if stamps are equals, the document is considered unchanged)

Parameters:

key - ID of the document

Returns:

the Stamp associated to the key Note: you may want to use the getSecurityMetaHash() method as an additional stamp value suffix.

Throws:

java.io.IOException

getNonSecurityMetaContainer

public abstract MetaContainer getNonSecurityMetaContainer(Skey key)
                                                   throws java.io.IOException

This method is used to retrieve all meta data of a document

Parameters:

key - ID of document

Returns:

Non Security Metas associated to the key (exclude security tokens)

Throws:

java.io.IOException

getSecurityMetaContainer

public abstract MetaContainer getSecurityMetaContainer(Skey key)
                                                throws java.io.IOException

This method is used to retrieve security tokens of a document. Security tokens are special Meta, you can use SecurityMeta class to create them

Parameters:

key - of the document

Returns:

only the security metas (if empty the document is public)

Throws:

java.io.IOException

getAllMetaContainer

public MetaContainer getAllMetaContainer(Skey key)
                                  throws java.io.IOException

Get all metas associated to the key (non security meta + security meta)

Parameters:

key - ID of document

Returns:

Throws:

java.io.IOException

getSecurityMetaHash

public java.lang.String getSecurityMetaHash(Skey key)
                                     throws java.io.IOException

Get a hash corresponding to the key's security metadata. (Helper for stamp computation)

Throws:

java.io.IOException

getSecurityMetaHash

public java.lang.String getSecurityMetaHash(MetaContainer metas)

Get a hash corresponding to 'meta' security metadata. (Helper for stamp computation)