DEPRECATED
A object which can provide documents and document information.
In the case of statefull connections to DMS, this should represent a single connection to the DMS (pooling will be handled by the infrastructure).
DocumentProvider can support transaction isolation levels very similar to java.sql.Connections. If the DocumentProvider doesn't support transaction isolation levels, it should always report TRANSACTION_NONE (i.e. it shouldn't thrown an exception).
com.bea.p13n.content.document.ref.DefaultDocumentProvider
Field Summary |
public static final int |
|
public static final int |
|
public static final int |
|
public static final int |
|
public static final int |
|
Method Summary |
public void |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public | |
public |
|
public |
|
public int |
|
public void |
|
public void |
|
public void |
|
Field Detail |
public static final int TRANSACTION_NONE
Related Topics
public static final int TRANSACTION_READ_COMMITTED
Related Topics
public static final int TRANSACTION_READ_UNCOMMITTED
Related Topics
public static final int TRANSACTION_REPEATABLE_READ
Related Topics
public static final int TRANSACTION_SERIALIZABLE
Related Topics
Method Detail |
public void close()Close the provider down.
throwsDocumentException
This will be called before the provider is dereferenced; it should close any resources opened by init() or internally. The provider instance should not be used after this method has been invoked.
DocumentException
publicReturn the set of String document ids of documents which match the given search parameters.DocumentIterator
findDocumentIds(Search
params)
throwsDocumentException
DocumentException
publicReturn the set of DocumentMetadataDefs which match the given search parameters object.DocumentIterator
findDocumentMetadata(Search
params)
throwsDocumentException
The implementor of DocumentProvider will need to map the parameters into the native search mechanism.
DocumentException
publicReturn the set of DocumentDefs which match the given search parameters object.DocumentIterator
findDocuments(Search
params)
throwsDocumentException
The implementor of DocumentProvider will need to map the parameters into the native search mechanism.
DocumentException
publicReturn the DocumentDef with the given String document id.DocumentDef
getDocument(String
id)
throwsDocumentException
DocumentException
publicReturn the DocumentMetadataDef with the given String document id.DocumentMetadataDef
getDocumentMetadata(String
id)
throwsDocumentException
DocumentException
publicGet the last modified timestamp for the given document id.Timestamp
getDocumentModifiedDate(String
id)
throwsDocumentException
DocumentException
publicReturn the named document schema def (null if does not exist).DocumentSchemaDef
getSchema(String
schemaName)
throwsDocumentException
DocumentException
publicReturn the list of schema names supported in this DMS.DocumentIterator
getSchemaNames()
throwsDocumentException
DocumentException
publicReturn the map (name to DocumentSchemaDef) of all the schemas supported in the system.Map
getSchemas()
throwsDocumentException
This operation could be time expensive.
DocumentException
public int getTransactionIsolation()Get the document provider's current transaction isolation level.
throwsDocumentException
DocumentException
public void init(Initialize the DocumentProvider based upon the specified configuration properties.Properties
properties)
throwsDocumentException
This will be called after the DocumentProvider has been instantiated.
DocumentException
public void reset()Reset the connection internally to a fresh state.
throwsDocumentException
This might include rolling back a transaction and clearing out any internal state.
DocumentException
public void setTransactionIsolation(int level)Set the document provider's transaction isolation level.
throwsDocumentException
DocumentException