Package com.levigo.jadice.web.demo.enterprise.server

Class ClassPathWithAnnoAndPermissionDocumentDataProvider

java.lang.Object

com.levigo.jadice.web.demo.common.server.dataprovider.SimpleDocumentDataProvider<ClassPathWithAnnoAndPermissionSource,ClassPathWithAnnoAndPermissionHandle>

com.levigo.jadice.web.demo.enterprise.server.ClassPathWithAnnoAndPermissionDocumentDataProvider

All Implemented Interfaces:

DocumentDataProvider<ClassPathWithAnnoAndPermissionSource,ClassPathWithAnnoAndPermissionHandle>

@Component
public class ClassPathWithAnnoAndPermissionDocumentDataProvider
extends SimpleDocumentDataProvider<ClassPathWithAnnoAndPermissionSource,ClassPathWithAnnoAndPermissionHandle>

Constructor Summary

Constructors

Constructor	Description
ClassPathWithAnnoAndPermissionDocumentDataProvider()

Method Summary

Modifier and Type	Method	Description
protected void	applyPermissions(com.levigo.jadice.document.read.Reader reader, ClassPathWithAnnoAndPermissionSource source)
ClassPathWithAnnoAndPermissionHandle	createSourceHandle(ClassPathWithAnnoAndPermissionSource source)	Creates a SourceHandle from a given Source.
protected org.jadice.util.base.Provider<InputStream,IOException>	get(String resource)
org.jadice.util.base.Provider<InputStream,IOException>	getRecoveryStream(ClassPathWithAnnoAndPermissionHandle sourceHandle)	Creates the Provider out of a old PageSegmentHandle
org.jadice.util.base.Provider<InputStream,IOException>	getStream(ClassPathWithAnnoAndPermissionSource source)	Creates the Provider out of a Source
void	read(com.levigo.jadice.document.read.Reader reader, ClassPathWithAnnoAndPermissionSource source)	Reads a part of the document to load.
void	recover(com.levigo.jadice.document.read.Reader reader, ClassPathWithAnnoAndPermissionHandle handle)	Partially recovers a Document identified by the given PageSegmentHandle.

Methods inherited from class java.lang.Object

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

Constructor Details

ClassPathWithAnnoAndPermissionDocumentDataProvider

public ClassPathWithAnnoAndPermissionDocumentDataProvider()

Method Details

createSourceHandle

public ClassPathWithAnnoAndPermissionHandle createSourceHandle(ClassPathWithAnnoAndPermissionSource source)

Description copied from interface: DocumentDataProvider

Creates a SourceHandle from a given Source. The information required to recover the document must be stored in the PageSegmentHandle. The web toolkit server will call the DocumentDataProvider.recover(Reader, PageSegmentHandle) method with a PageSegmentHandle. Typical scenarios include garbage-collected documents, a server restart, or moving a request to another server for load-balancing or fail-over purposes.

Parameters:

source - The Source the Handle should be created from.

Returns:

The PageSegmentHandle to recover the document stream.

getStream

public org.jadice.util.base.Provider<InputStream,IOException> getStream(ClassPathWithAnnoAndPermissionSource source)

Description copied from class: SimpleDocumentDataProvider

Creates the Provider out of a Source

Specified by:

getStream in class SimpleDocumentDataProvider<ClassPathWithAnnoAndPermissionSource,ClassPathWithAnnoAndPermissionHandle>

Parameters:

source - the Data to read the Document

Returns:

the Provider to read the Document matching to the source

getRecoveryStream

public org.jadice.util.base.Provider<InputStream,IOException> getRecoveryStream(ClassPathWithAnnoAndPermissionHandle sourceHandle)

Description copied from class: SimpleDocumentDataProvider

Creates the Provider out of a old PageSegmentHandle

Specified by:

getRecoveryStream in class SimpleDocumentDataProvider<ClassPathWithAnnoAndPermissionSource,ClassPathWithAnnoAndPermissionHandle>

Parameters:

sourceHandle - the handle to recover the Stream

Returns:

the Provider to read the Document matching to the handle

read

public void read(com.levigo.jadice.document.read.Reader reader,
 ClassPathWithAnnoAndPermissionSource source)
          throws com.levigo.jadice.document.JadiceException,
IOException

Description copied from interface: DocumentDataProvider

Reads a part of the document to load. This will be used to initially load the document when a client initiates displaying a document. Please note, that the read method will be called only once during a server-side document read lifecycle. Subsequent reads will trigger the recover method, not a read.

Specified by:

read in interface DocumentDataProvider<ClassPathWithAnnoAndPermissionSource,ClassPathWithAnnoAndPermissionHandle>

Overrides:

read in class SimpleDocumentDataProvider<ClassPathWithAnnoAndPermissionSource,ClassPathWithAnnoAndPermissionHandle>

Parameters:

reader - The Reader to load the document.

source - The Source to read the document from, including a unique identifier.

Throws:

com.levigo.jadice.document.JadiceException - Any rendering exceptions reported by the Jadice core.

IOException - Other exceptions while reading the document.

recover

public void recover(com.levigo.jadice.document.read.Reader reader,
 ClassPathWithAnnoAndPermissionHandle handle)
             throws RecoverFailedException,
com.levigo.jadice.document.JadiceException

Description copied from interface: DocumentDataProvider

Partially recovers a Document identified by the given PageSegmentHandle. Sometimes, client applications may request Document instances that have either been removed from cache, garbage-collected due to long inactivity or in consequence of a server switch. This method will be used for subsequent document reads.

Specified by:

recover in interface DocumentDataProvider<ClassPathWithAnnoAndPermissionSource,ClassPathWithAnnoAndPermissionHandle>

Overrides:

recover in class SimpleDocumentDataProvider<ClassPathWithAnnoAndPermissionSource,ClassPathWithAnnoAndPermissionHandle>

Parameters:

reader - The Reader to load the Document with

handle - The information specifying which Document to recover

Throws:

RecoverFailedException - Thrown if the document cannot be recovered.

com.levigo.jadice.document.JadiceException - Any rendering exceptions reported by the Jadice core.

applyPermissions

protected void applyPermissions(com.levigo.jadice.document.read.Reader reader,
 ClassPathWithAnnoAndPermissionSource source)

get

protected org.jadice.util.base.Provider<InputStream,IOException> get(String resource)