com.sapportals.wcm.protocol.ice.util

Class DOMResourceHelper

java.lang.Object

com.sapportals.wcm.protocol.ice.util.DOMResourceHelper

public class DOMResourceHelper
extends Object

This is a simple helper class to read XML resources from a repository into a DOM representation in memory or vice versa.

Copyright 2004 SAP AG

Constructor Summary

Constructors

Constructor and Description
DOMResourceHelper()

Method Summary

Modifier and Type	Method and Description
static String	makeFilename(String id) Creates a valid filename from an arbitrary id string.
static Document	read(IResource resource) Reads the specified XML resource into a DOM representation.
static Document	read(String uri, IResourceContext context) Reads the specified XML resource into a DOM representation.
static byte[]	serialize(Document document) Serializes the specified DOM representation into a byte array.
static byte[]	serialize(IDOMStorable storable) Serializes the specified IDOMStorable object into a byte array.
static void	write(IResource resource, Document document) Writes the specified DOM representation to the specified XML resource.
static void	write(IResource resource, IDOMStorable storable) Writes the specified DOM representation to the specified XML resource.
static void	write(String uri, Document document, IResourceContext context) Writes the specified DOM representation to the specified XML resource.
static void	write(String uri, IDOMStorable storable, IResourceContext context) Writes the specified DOM representation to the specified XML resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

DOMResourceHelper

public DOMResourceHelper()

Method Detail

read

public static Document read(String uri,
                            IResourceContext context)
                     throws ResourceException,
                            ContentException,
                            IOException,
                            SAXException

Reads the specified XML resource into a DOM representation.

Parameters:

uri - the URI of the resource to be read

context - the resource context

Returns:

the DOM representation of the resource

Throws:

IOException - if an I/O error has occured

ContentException - if the content is invalid

ResourceException - on error

SAXException - on parser error

read

public static Document read(IResource resource)
                     throws ResourceException,
                            ContentException,
                            IOException,
                            SAXException

Reads the specified XML resource into a DOM representation.

Parameters:

resource - the resource to be read

Returns:

the DOM representation of the resource

Throws:

IOException - if an I/O error has occured

ContentException - if the content is invalid

ResourceException - on error

SAXException - on parser error

write

public static void write(String uri,
                         IDOMStorable storable,
                         IResourceContext context)
                  throws ResourceException,
                         IOException

Writes the specified DOM representation to the specified XML resource.

Parameters:

uri - the URI of the resource to be (opver-)written. If the resource does not exists, it will be created

storable - the IDOMStorable object to write

context - the resource context

Throws:

IOException - if an I/O error has occured

ResourceException - on error

write

public static void write(String uri,
                         Document document,
                         IResourceContext context)
                  throws ResourceException,
                         IOException

Writes the specified DOM representation to the specified XML resource.

Parameters:

uri - the URI of the resource to be (over-)written. If the resource does not exists, it will be created.

document - the DOM representation to write

context - the resource context

Throws:

IOException - if an I/O error has occured

ResourceException - on error

write

public static void write(IResource resource,
                         IDOMStorable storable)
                  throws ResourceException,
                         IOException

Writes the specified DOM representation to the specified XML resource.

Parameters:

resource - the resource to be updated

storable - the IDOMStorable object to be written

Throws:

IOException - if an I/O error has occured

ResourceException - on error

write

public static void write(IResource resource,
                         Document document)
                  throws ResourceException,
                         IOException

Writes the specified DOM representation to the specified XML resource.

Parameters:

resource - the resource to be updated

document - the DOM representation to write

Throws:

IOException - if an I/O error has occured

ResourceException - on error

serialize

public static byte[] serialize(IDOMStorable storable)
                        throws IOException

Serializes the specified IDOMStorable object into a byte array.

Parameters:

storable - the IDOMStorable to be serialized

Returns:

a byte array containing the XML representation

Throws:

IOException - if an I/O error has occured

serialize

public static byte[] serialize(Document document)
                        throws IOException

Serializes the specified DOM representation into a byte array.

Parameters:

document - the DOM representation to be serialized

Returns:

a byte array containing the XML representation

Throws:

IOException - if an I/O error has occured

makeFilename

public static String makeFilename(String id)

Creates a valid filename from an arbitrary id string. This method will replace any non-character by "_".

Parameters:

id - an arbitrary id string

Returns:

a valid filename