|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object nu.staldal.lagoon.core.Producer
public abstract class Producer
A Producer is one step in the pipeline process to build a file in a website.
Constructor Summary | |
---|---|
Producer()
|
Method Summary | |
---|---|
void |
afterBuild()
|
void |
beforeBuild()
|
void |
destroy()
Destroy the producer. |
LagoonContext |
getContext()
Get the LagoonContext this producer is associated with. |
java.lang.String |
getEntryName()
Get the name of the sitemap entry this producer is associated with. |
java.lang.Object |
getObjectFromRepository(java.lang.String key)
Get an object from the repository. |
java.lang.String |
getParam(java.lang.String name)
Get a parameter. |
java.util.Enumeration |
getParamNames()
Get an Enumeration of all parameter names. |
int |
getPosition()
Get the position of this producer in the pipeline. |
SourceManager |
getSourceMan()
Get the SourceManager this producer is associated with. |
boolean |
putObjectIntoRepository(java.lang.String key,
java.lang.Object obj)
Store an object into the repository. |
java.io.InputStream |
readFileFromRepository(java.lang.String key)
Read from a file in the repository. |
java.io.OutputStream |
storeFileInRepository(java.lang.String key)
Store a file in the repository. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface nu.staldal.lagoon.core.ProducerInterface |
---|
hasBeenUpdated, init |
Constructor Detail |
---|
public Producer()
Method Detail |
---|
public void destroy() throws java.io.IOException
ProducerInterface
destroy
in interface ProducerInterface
java.io.IOException
public void beforeBuild() throws java.io.IOException
java.io.IOException
public void afterBuild() throws java.io.IOException
java.io.IOException
public java.lang.String getEntryName()
public int getPosition()
public SourceManager getSourceMan()
public LagoonContext getContext()
public java.lang.String getParam(java.lang.String name)
name
- the name of the parameter to get
public java.util.Enumeration getParamNames()
public java.io.InputStream readFileFromRepository(java.lang.String key)
key
- the key to locate the file
null
if the file wasn't found.public java.io.OutputStream storeFileInRepository(java.lang.String key) throws java.io.IOException
key
- the key to locate the file
null
if the repository is unavailable.
java.io.IOException
public java.lang.Object getObjectFromRepository(java.lang.String key) throws java.io.IOException
key
- the key to locate the object
null
if not found
java.io.IOException
public boolean putObjectIntoRepository(java.lang.String key, java.lang.Object obj) throws java.io.IOException
key
- the key to locate the objectobj
- the object to store, must be Serializable
true
if successful,
false
if the repository is unavailable.
java.io.IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |