com.threecrickets.prudence.service

Class DocumentService<A extends com.threecrickets.prudence.internal.attributes.DocumentExecutionAttributes>

java.lang.Object

com.threecrickets.prudence.service.DocumentService<A>

Type Parameters:

A - The attributes

Direct Known Subclasses:

ApplicationTaskDocumentService, ExecutionResourceDocumentService, ResourceDocumentServiceBase

public class DocumentService<A extends com.threecrickets.prudence.internal.attributes.DocumentExecutionAttributes>
extends Object

Document service exposed to executables.

Author:

Tal Liron

Field Summary

Fields

Modifier and Type	Field and Description
protected A	attributes The attributes.
protected LinkedList<DocumentDescriptor<Executable>>	documentDescriptorStack The document stack.

Constructor Summary

Constructors

Constructor and Description
DocumentService(A attributes) Constructor.
DocumentService(A attributes, DocumentDescriptor<Executable> documentDescriptor) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addDependency(String documentName) Explicitly add a dependency to this document.
void	addFileDependency(String path) Explicitly add a dependency to this document.
void	execute(String documentName) Executes a source code document.
void	executeOnce(String documentName) As execute(String), but will only execute once per this thread.
ClientResource	external(String uri, String mediaTypeName) Access any resource.
Cache	getCache() The cache.
DocumentDescriptor<Executable>	getDescriptor() The descriptor for the currently executing document (the one at the top of the stack).
protected DocumentDescriptor<Executable>	getDocumentDescriptor(String documentName) Finds a document.
DocumentSource<Executable>	getSource() The DocumentSource used to fetch executables.
ClientResource	internal(String resourceUri, String mediaTypeName) Access a resource internal to the current application.
ClientResource	internalOther(String applicationInternalName, String resourceUri, String mediaTypeName) Access a resource internal to the current Prudence instance.
void	invalidate(String documentName) Invalidates a document, which can affect documents that depend on it.
void	invalidateCurrent() Invalidates the current document, which can affect documents that depend on it.
boolean	markExecuted(String documentName, boolean wasExecuted) Marks a document as executed for this thread's ExecutionContext.
protected DocumentDescriptor<Executable>	popDocumentDescriptor() Remove the top document from the stack.
protected void	pushDocumentDescriptor(DocumentDescriptor<Executable> documentDescriptor) Add a document to the top of stack.
void	require(String... documentNames) As executeOnce(String).

Methods inherited from class java.lang.Object

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

Field Detail

attributes

protected final A extends com.threecrickets.prudence.internal.attributes.DocumentExecutionAttributes attributes

The attributes.

documentDescriptorStack

protected LinkedList<DocumentDescriptor<Executable>> documentDescriptorStack

The document stack.

Constructor Detail

DocumentService

public DocumentService(A attributes)

Constructor.

Parameters:

attributes - The attributes

DocumentService

public DocumentService(A attributes,
                       DocumentDescriptor<Executable> documentDescriptor)

Constructor.

Parameters:

attributes - The attributes

documentDescriptor - The initial document descriptor

Method Detail

getCache

public Cache getCache()

The cache.

Returns:

The cache

getSource

public DocumentSource<Executable> getSource()

The DocumentSource used to fetch executables.

Returns:

The document source

getDescriptor

public DocumentDescriptor<Executable> getDescriptor()

The descriptor for the currently executing document (the one at the top of the stack).

Returns:

The current document or null

execute

public void execute(String documentName)
             throws ParsingException,
                    ExecutionException,
                    DocumentException,
                    IOException

Executes a source code document. The language of the source code will be determined by the document tag, which is usually the filename extension.

Parameters:

documentName - The document name

Throws:

ParsingException - In case of a Scripturian parsing error

ExecutionException - In case of a Scripturian execution error

DocumentException - In case of a Scripturian document retrieval error

IOException - In case of a Scripturian writing error

executeOnce

public void executeOnce(String documentName)
                 throws ParsingException,
                        ExecutionException,
                        DocumentException,
                        IOException

As execute(String), but will only execute once per this thread.

Parameters:

documentName - The document name

Throws:

ParsingException - In case of a Scripturian parsing error

ExecutionException - In case of a Scripturian execution error

DocumentException - In case of a Scripturian document retrieval error

IOException - In case of a Scripturian writing error

See Also:

markExecuted(String, boolean)

require

public void require(String... documentNames)
             throws ParsingException,
                    ExecutionException,
                    DocumentException,
                    IOException

As executeOnce(String).

Parameters:

documentNames - The document names

Throws:

ParsingException - In case of a Scripturian parsing error

ExecutionException - In case of a Scripturian execution error

DocumentException - In case of a Scripturian document retrieval error

IOException - In case of a Scripturian writing error

markExecuted

public boolean markExecuted(String documentName,
                            boolean wasExecuted)

Marks a document as executed for this thread's ExecutionContext.

Parameters:

documentName - The document name

wasExecuted - True if marked as executed, false to clear execution flag

Returns:

True if the document was marked as executed or not by this call, false if it was already marked as such

See Also:

executeOnce(String)

addDependency

public void addDependency(String documentName)
                   throws ParsingException,
                          DocumentException

Explicitly add a dependency to this document.

Parameters:

documentName - The document name

Throws:

DocumentException - In case of a Scripturian document retrieval error

ParsingException - In case of a Scripturian parsing error

addFileDependency

public void addFileDependency(String path)
                       throws ParsingException,
                              DocumentException

Explicitly add a dependency to this document. Unlike addDependency(String), any file can be added here. The contents of the file are never read.

Parameters:

path - The document name

Throws:

ParsingException - In case of a Scripturian parsing error

DocumentException - In case of a Scripturian document retrieval error

invalidate

public void invalidate(String documentName)
                throws ParsingException,
                       DocumentException,
                       IOException

Invalidates a document, which can affect documents that depend on it.

Parameters:

documentName - The document name

Throws:

DocumentException - In case of a Scripturian document retrieval error

ParsingException - In case of a Scripturian parsing error

IOException - In case of a Scripturian writing error

invalidateCurrent

public void invalidateCurrent()

Invalidates the current document, which can affect documents that depend on it.

internal

public ClientResource internal(String resourceUri,
                               String mediaTypeName)

Access a resource internal to the current application.

Parameters:

resourceUri - The URI

mediaTypeName - The preferred media type

Returns:

The client proxy

internalOther

public ClientResource internalOther(String applicationInternalName,
                                    String resourceUri,
                                    String mediaTypeName)

Access a resource internal to the current Prudence instance.

Parameters:

applicationInternalName - The application internal name

resourceUri - The URI

mediaTypeName - The preferred media type

Returns:

The client proxy

external

public ClientResource external(String uri,
                               String mediaTypeName)

Access any resource.

Parameters:

uri - The URI

mediaTypeName - The preferred media type

Returns:

The client proxy

pushDocumentDescriptor

protected void pushDocumentDescriptor(DocumentDescriptor<Executable> documentDescriptor)

Add a document to the top of stack.

Parameters:

documentDescriptor - The document descriptor

popDocumentDescriptor

protected DocumentDescriptor<Executable> popDocumentDescriptor()

Remove the top document from the stack.

Returns:

The top document descriptor or null

getDocumentDescriptor

protected DocumentDescriptor<Executable> getDocumentDescriptor(String documentName)
                                                        throws ParsingException,
                                                               DocumentException

Finds a document.

Parameters:

documentName - The document name

Returns:

The document descriptor

Throws:

ParsingException - In case of a Scripturian parsing error

DocumentException - In case of a Scripturian document retrieval error