ikrs.httpd.resource
Class ByteArrayResource

java.lang.Object
  extended by ikrs.httpd.resource.AbstractResource
      extended by ikrs.httpd.resource.ByteArrayResource
All Implemented Interfaces:
Resource

public class ByteArrayResource
extends AbstractResource
implements Resource


Constructor Summary
ByteArrayResource(HTTPHandler handler, CustomLogger logger, byte[] data, boolean useFairLocks)
          Create a new ByteArrayResource.
ByteArrayResource(HTTPHandler handler, CustomLogger logger, byte[] data, int offset, int length, boolean useFairLocks)
          Create a new ByteArrayResource.
 
Method Summary
 boolean close()
          Closes this resource.
 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).
 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
 
Methods inherited from interface ikrs.httpd.Resource
getHypertextAccessFile, getMetaData, getReadLock, getWriteLock
 

Constructor Detail

ByteArrayResource

public ByteArrayResource(HTTPHandler handler,
                         CustomLogger logger,
                         byte[] data,
                         boolean useFairLocks)
                  throws java.lang.NullPointerException
Create a new ByteArrayResource.

Throws:
java.lang.NullPointerException

ByteArrayResource

public ByteArrayResource(HTTPHandler handler,
                         CustomLogger logger,
                         byte[] data,
                         int offset,
                         int length,
                         boolean useFairLocks)
                  throws java.lang.NullPointerException
Create a new ByteArrayResource.

Throws:
java.lang.NullPointerException
Method Detail

isOpen

public boolean isOpen()
               throws java.io.IOException
This method determines if this resource was alerady opened or not.

Specified by:
isOpen in interface Resource
Specified by:
isOpen in class AbstractResource
Throws:
java.io.IOException - If any IO error occurs.

open

public void open(boolean readOnly)
          throws ReadOnlyException,
                 java.io.IOException
This method opens the underlying resource. Don't forget to close.

Specified by:
open in interface Resource
Specified by:
open in class AbstractResource
Parameters:
readOnly - if set to true, the resource will be opned in read-only mode.
Throws:
ReadOnlyException - If the underlying resource is read-only in general.
java.io.IOException - If any other IO error occurs.
See Also:
isReadOnly()

isReadOnly

public boolean isReadOnly()
                   throws java.io.IOException
This method returns true if the underlying resource is read-only (in general).

Specified by:
isReadOnly in interface Resource
Specified by:
isReadOnly in class AbstractResource
Throws:
java.io.IOException - If any IO error occurs.

getLength

public long getLength()
               throws java.io.IOException
This method returns the *actual* length of the underlying resource. This length will be used in the HTTP header fields to specify the transaction length. During read-process (you used the locks, didn't you?) the length MUST NOT change.

Specified by:
getLength in interface Resource
Specified by:
getLength in class AbstractResource
Returns:
the length of the resource's data in bytes.
Throws:
java.io.IOException - If any IO error occurs.

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws ReadOnlyException,
                                            java.io.IOException
Get the output stream to this resource.

Specified by:
getOutputStream in interface Resource
Specified by:
getOutputStream in class AbstractResource
Throws:
ReadOnlyException - If this resource was opened with the read-only flag set.
java.io.IOException - If any other IO error occurs.

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException
Get the input stream from this resource.

Specified by:
getInputStream in interface Resource
Specified by:
getInputStream in class AbstractResource
Throws:
java.io.IOException - If any IO error occurs.

close

public boolean close()
              throws java.io.IOException
Closes this resource.

Specified by:
close in interface Resource
Specified by:
close in class AbstractResource
Returns:
false if the resource was already closed, false otherwise.
Throws:
java.io.IOException