|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object ikrs.httpd.resource.AbstractResource ikrs.httpd.resource.ProcessableResource
public class ProcessableResource
Processable resources represent system processes that generate any output which will be used as the Resource's output data. The resource expects a system command that will be executed in an external system process. The resource will read from the process' stdout and pass the received data towards the designated input stream (see Resource.getInputStream()). Note A: Failing the execution of the system command does not necessarily throw any exceptions! Use the ProcessableResource.getExitValue() method to check wheter the execution was successful. Note B: If the execution really fails, the resource contains the data from the error output (not from stdout). TAKE CARE WITH PLATFORM DEPENDENT COMMANDS!
Constructor Summary | |
---|---|
ProcessableResource(HTTPHandler handler,
CustomLogger logger,
java.lang.ProcessBuilder pb,
PostDataWrapper postData,
boolean useFairLocks)
Create a new ProcessableResource. |
Method Summary | |
---|---|
boolean |
close()
Closes this resource. |
int |
getExitValue()
Get the process's exit code after execution (after calling the open() method). |
java.io.InputStream |
getInputStream()
Get the input stream from this resource. |
long |
getLength()
This method returns the *actual* length of the underlying resource. |
java.io.OutputStream |
getOutputStream()
Get the output stream to this resource. |
boolean |
isOpen()
This method determines if this resource was alerady opened or not. |
boolean |
isReadOnly()
This method returns true if the underlying resource is read-only (in general). |
static void |
main(java.lang.String[] argv)
For testing only. |
void |
open(boolean readOnly)
This method opens the underlying resource. |
Methods inherited from class ikrs.httpd.resource.AbstractResource |
---|
getHTTPHandler, getHypertextAccessFile, getLogger, getMetaData, getReadLock, getWriteLock, setHypertextAccessFile |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ProcessableResource(HTTPHandler handler, CustomLogger logger, java.lang.ProcessBuilder pb, PostDataWrapper postData, boolean useFairLocks) throws java.lang.NullPointerException
logger
- A custom logger to write log messages to (must not be null).pb
- The process builder to use (must not be null).useFairLocks
- If set to true the class will use fair read locks (writing isn't
possible at all with this class).
java.lang.NullPointerException
- If logger or pb is null.Method Detail |
---|
public int getExitValue()
public void open(boolean readOnly) throws ReadOnlyException, java.io.IOException
open
in interface Resource
open
in class AbstractResource
readOnly
- if set to true, the resource will be opened in read-only mode.
ReadOnlyException
- If the underlying resource is read-only in general.
java.io.IOException
- If any other IO error occurs.isReadOnly()
public boolean isOpen() throws java.io.IOException
isOpen
in interface Resource
isOpen
in class AbstractResource
java.io.IOException
- If any IO error occurs.public boolean isReadOnly() throws java.io.IOException
isReadOnly
in interface Resource
isReadOnly
in class AbstractResource
java.io.IOException
- If any IO error occurs.public long getLength() throws java.io.IOException
getLength
in interface Resource
getLength
in class AbstractResource
java.io.IOException
- If any IO error occurs.public java.io.OutputStream getOutputStream() throws ReadOnlyException, java.io.IOException
getOutputStream
in interface Resource
getOutputStream
in class AbstractResource
ReadOnlyException
- If this resource was opened with the read-only flag set.
java.io.IOException
- If any other IO error occurs.public java.io.InputStream getInputStream() throws java.io.IOException
getInputStream
in interface Resource
getInputStream
in class AbstractResource
java.io.IOException
- If any IO error occurs.public boolean close() throws java.io.IOException
close
in interface Resource
close
in class AbstractResource
java.io.IOException
public static void main(java.lang.String[] argv)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |