Package org.mycore.common.content

Class MCRWrappedContent

java.lang.Object

org.mycore.common.content.MCRContent

org.mycore.common.content.MCRWrappedContent

Direct Known Subclasses:

MCRSourceContent

public abstract class MCRWrappedContent
extends MCRContent

Author:

Thomas Scheffler (yagee)

Field Summary

Fields inherited from class org.mycore.common.content.MCRContent

docType, encoding, lastModified, length, mimeType, name, systemId, usingSession

Constructor Summary

Constructors

Constructor	Description
MCRWrappedContent()

Method Summary

Modifier and Type	Method	Description
byte[]	asByteArray()	Returns the raw content
String	asString()	Returns content as String, assuming encoding from MCRContent.getEncoding() or MCRConstants.DEFAULT_ENCODING .
Document	asXML()	Parses content, assuming it is XML, and returns the parsed document.
MCRContent	ensureXML()	Ensures that content is XML.
MCRContent	getBaseContent()
MCRContentInputStream	getContentInputStream()	Returns content as content input stream, which provides MD5 functionality.
String	getDocType()	Return the document type of the content, assuming content is XML
String	getETag()	Returns either strong or weak ETag.
InputSource	getInputSource()	Returns content as SAX input source.
InputStream	getInputStream()	Returns content as input stream.
String	getMimeType()
String	getName()
ReadableByteChannel	getReadableByteChannel()	Returns an readable bytechannel to this content or null if one is not available.
MCRContent	getReusableCopy()	Returns a reusable copy of this content, that is an instance (may be the same instance) thats content can be read more than once without consuming the stream.
Source	getSource()	Return the content as Source
String	getSystemId()	Returns the systemID of the current content
boolean	isReusable()	If true, content can be read more than once by calling getInputStream() and similar methods.
boolean	isUsingSession()	Tells if this content may contain data from the current MCRSession.
long	lastModified()	Returns the last modified time
long	length()	Return the length of this content.
void	sendTo(File target)	Sends content to the given local file
void	sendTo(OutputStream out)	Sends content to the given OutputStream.
void	sendTo(OutputStream out, boolean close)	Sends content to the given OutputStream.
void	sendTo(Path target, CopyOption... options)	Sends content to the given path.
protected void	setBaseContent(MCRContent baseContent)
void	setDocType(String docType)	Overwrites DocType detection.
void	setLastModified(long lastModified)
void	setMimeType(String mimeType)
void	setName(String name)
void	setUsingSession(boolean usingSession)

Methods inherited from class org.mycore.common.content.MCRContent

asDataURL, getDataURLEncoding, getEncoding, getSafeEncoding, getSimpleWeakETag, setEncoding

Methods inherited from class java.lang.Object

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

Constructor Details

MCRWrappedContent

public MCRWrappedContent()

Method Details

getBaseContent

public MCRContent getBaseContent()

setBaseContent

protected void setBaseContent(MCRContent baseContent)

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from class: MCRContent

Returns content as input stream. Be sure to close this stream properly!

Specified by:

getInputStream in class MCRContent

Returns:

input stream to read content from

Throws:

IOException

getSystemId

public String getSystemId()

Description copied from class: MCRContent

Returns the systemID of the current content

Overrides:

getSystemId in class MCRContent

getContentInputStream

public MCRContentInputStream getContentInputStream()
                                            throws IOException

Description copied from class: MCRContent

Returns content as content input stream, which provides MD5 functionality. Be sure to close this stream properly!

Overrides:

getContentInputStream in class MCRContent

Returns:

the content input stream

Throws:

IOException

getSource

public Source getSource()
                 throws IOException

Description copied from class: MCRContent

Return the content as Source

Overrides:

getSource in class MCRContent

Returns:

content as Source

Throws:

IOException

sendTo

public void sendTo(OutputStream out)
            throws IOException

Description copied from class: MCRContent

Sends content to the given OutputStream. The OutputStream is NOT automatically closed afterwards.

Overrides:

sendTo in class MCRContent

Parameters:

out - the OutputStream to write the content to

Throws:

IOException

sendTo

public void sendTo(OutputStream out,
 boolean close)
            throws IOException

Description copied from class: MCRContent

Sends content to the given OutputStream.

Overrides:

sendTo in class MCRContent

Parameters:

out - the OutputStream to write the content to

close - if true, close OutputStream afterwards

Throws:

IOException

sendTo

public void sendTo(Path target,
 CopyOption... options)
            throws IOException

Description copied from class: MCRContent

Sends content to the given path.

Overrides:

sendTo in class MCRContent

Parameters:

target - target path to write content to

options - see Files.copy(InputStream, Path, CopyOption...)} for help on copy options

Throws:

IOException

getInputSource

public InputSource getInputSource()
                           throws IOException

Description copied from class: MCRContent

Returns content as SAX input source.

Overrides:

getInputSource in class MCRContent

Returns:

input source to read content from

Throws:

IOException

sendTo

public void sendTo(File target)
            throws IOException

Description copied from class: MCRContent

Sends content to the given local file

Overrides:

sendTo in class MCRContent

Parameters:

target - the file to write the content to

Throws:

IOException

asByteArray

public byte[] asByteArray()
                   throws IOException

Description copied from class: MCRContent

Returns the raw content

Overrides:

asByteArray in class MCRContent

Returns:

the content

Throws:

IOException

asString

public String asString()
                throws IOException

Description copied from class: MCRContent

Returns content as String, assuming encoding from MCRContent.getEncoding() or MCRConstants.DEFAULT_ENCODING .

Overrides:

asString in class MCRContent

Returns:

content as String

Throws:

IOException

asXML

public Document asXML()
               throws JDOMException,
IOException,
SAXException

Description copied from class: MCRContent

Parses content, assuming it is XML, and returns the parsed document.

Overrides:

asXML in class MCRContent

Returns:

the XML document parsed from content

Throws:

JDOMException

IOException

SAXException

ensureXML

public MCRContent ensureXML()
                     throws IOException,
JDOMException,
SAXException

Description copied from class: MCRContent

Ensures that content is XML. The content is parsed as if asXML() is called. When content is XML, an MCRContent instance is returned that guarantees that. When XML can not be parsed, an exception is thrown.

Overrides:

ensureXML in class MCRContent

Throws:

IOException

JDOMException

SAXException

getDocType

public String getDocType()
                  throws IOException

Description copied from class: MCRContent

Return the document type of the content, assuming content is XML

Overrides:

getDocType in class MCRContent

Returns:

document type as String

Throws:

IOException

isReusable

public boolean isReusable()

Description copied from class: MCRContent

If true, content can be read more than once by calling getInputStream() and similar methods. If false, content may be consumed when it is read more than once. Most subclasses provide reusable content.

Overrides:

isReusable in class MCRContent

getReusableCopy

public MCRContent getReusableCopy()
                           throws IOException

Description copied from class: MCRContent

Returns a reusable copy of this content, that is an instance (may be the same instance) thats content can be read more than once without consuming the stream.

Overrides:

getReusableCopy in class MCRContent

Throws:

IOException

length

public long length()
            throws IOException

Description copied from class: MCRContent

Return the length of this content.

Overrides:

length in class MCRContent

Returns:

-1 if length is unknown

Throws:

IOException

lastModified

public long lastModified()
                  throws IOException

Description copied from class: MCRContent

Returns the last modified time

Overrides:

lastModified in class MCRContent

Returns:

-1 if last modified time is unknown

Throws:

IOException

setLastModified

public void setLastModified(long lastModified)

Overrides:

setLastModified in class MCRContent

getETag

public String getETag()
               throws IOException

Description copied from class: MCRContent

Returns either strong or weak ETag.

Overrides:

getETag in class MCRContent

Returns:

null, if no ETag could be generated

Throws:

IOException

getReadableByteChannel

public ReadableByteChannel getReadableByteChannel()
                                           throws IOException

Description copied from class: MCRContent

Returns an readable bytechannel to this content or null if one is not available.

Overrides:

getReadableByteChannel in class MCRContent

Throws:

IOException

setDocType

public void setDocType(String docType)

Description copied from class: MCRContent

Overwrites DocType detection.

Overrides:

setDocType in class MCRContent

See Also:

• MCRContent.getDocType()

getMimeType

public String getMimeType()
                   throws IOException

Overrides:

getMimeType in class MCRContent

Throws:

IOException

setMimeType

public void setMimeType(String mimeType)

Overrides:

setMimeType in class MCRContent

getName

public String getName()

Overrides:

getName in class MCRContent

setName

public void setName(String name)

Overrides:

setName in class MCRContent

isUsingSession

public boolean isUsingSession()

Description copied from class: MCRContent

Tells if this content may contain data from the current MCRSession. Use this information to alter cache behavior.

Overrides:

isUsingSession in class MCRContent

Returns:

true if it MAY contain session data

setUsingSession

public void setUsingSession(boolean usingSession)

Overrides:

setUsingSession in class MCRContent