org.xmlbeam.util

Class IOHelper

java.lang.Object

org.xmlbeam.util.IOHelper

public final class IOHelper
extends Object

A set of tiny helper methods used in the projection framework and free to use for framework clients. This methods are part of the public framework API and will not change in minor version updates.

Author:

Sven Ewald

Constructor Summary

Constructors

Constructor and Description
IOHelper()

Method Summary

Modifier and Type	Method and Description
static Map<String,String>	createBasicAuthenticationProperty(String username, String password) Create HTTP Basic credentials to be used in HTTP get or post methods.
static byte[]	dropUTF8BOM(byte[] source) Silently drop UTF8 BOM
static Document	getDocumentFromURL(DocumentBuilder documentBuilder, String url, Map<String,String> requestProperties, Class<?>... resourceAwareClasses)
static InputStream	httpGet(String httpurl, Map<String,String>... requestProperties) Simple http get imlementation.
static InputStream	httpPost(String httpurl, String data, Map<String,String>... requestProperties) Simple http post implementation.
static String	inputStreamToString(InputStream inputStream, String... optionalCharsetName)
static boolean	isResourceProtocol(String url)
static Document	loadDocument(XBProjector projector, InputStream is)

Methods inherited from class java.lang.Object

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

Constructor Detail

IOHelper

public IOHelper()

Method Detail

createBasicAuthenticationProperty

public static Map<String,String> createBasicAuthenticationProperty(String username,
                                                                   String password)

Create HTTP Basic credentials to be used in HTTP get or post methods.

Parameters:

username -

password -

Returns:

Map containing

httpGet

public static InputStream httpGet(String httpurl,
                                  Map<String,String>... requestProperties)
                           throws IOException

Simple http get imlementation. Supports HTTP Basic authentication via request properties. You may want to use createBasicAuthenticationProperty(java.lang.String, java.lang.String) to add authentication.

Parameters:

httpurl - get url

requestProperties - optional http header fields (key->value)

Returns:

input stream of response

Throws:

IOException

httpPost

public static InputStream httpPost(String httpurl,
                                   String data,
                                   Map<String,String>... requestProperties)
                            throws IOException

Simple http post implementation. Supports HTTP Basic authentication via request properties. You may want to use createBasicAuthenticationProperty(java.lang.String, java.lang.String) to add authentication.

Parameters:

httpurl - target url

data - String with content to post

requestProperties - optional http header fields (key->value)

Returns:

input stream of response

Throws:

IOException

inputStreamToString

public static String inputStreamToString(InputStream inputStream,
                                         String... optionalCharsetName)

Parameters:

inputStream -

optionalCharsetName - optional parameter

Returns:

String with stream content

dropUTF8BOM

public static byte[] dropUTF8BOM(byte[] source)

Silently drop UTF8 BOM

Parameters:

source -

Returns:

data without UTF8 BOM

loadDocument

public static Document loadDocument(XBProjector projector,
                                    InputStream is)

Parameters:

projector -

is - anonymous input stream

Returns:

Document

getDocumentFromURL

public static Document getDocumentFromURL(DocumentBuilder documentBuilder,
                                          String url,
                                          Map<String,String> requestProperties,
                                          Class<?>... resourceAwareClasses)
                                   throws IOException

Parameters:

documentBuilder -

url -

requestProperties -

resourceAwareClasses - Try useing this classes to load resource with resource protocol.

Returns:

new document instance

Throws:

IOException

isResourceProtocol

public static boolean isResourceProtocol(String url)

Parameters:

url -

Returns:

true if the protocol needs a class loader