BEA WebLogic Server 9.1 API Reference

weblogic.jms.extensions
Class ClientSAFFactory

java.lang.Object
  weblogic.jms.extensions.ClientSAFFactory

public class ClientSAFFactory

extends Object

This is a factory for ClientSAF objects, that can be used to control aspects of the client Store & Forward system

See Also:

ClientSAF

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Constructor Summary

ClientSAFFactory()

Method Summary

static ClientSAF	getClientSAF() Returns a client SAF instance.
static ClientSAF	getClientSAF(File rootDirectory, InputStream configuration) Returns a client SAF instance
static ClientSAF	getClientSAF(InputStream configuration) Returns a client SAF instance

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientSAFFactory

public ClientSAFFactory()

Method Detail

getClientSAF

public static ClientSAF getClientSAF()
                              throws JMSException

Returns a client SAF instance. This version of the factory assumes that the name of the configuration file is "ClientSAF.xml" and can be found in the current working directory of this JVM.

Returns:

A ClientSAF object, which can be used to control the configuration aspects of the ClientSAF system

Throws:

JMSException - If this call is attempted on a WLS server. Client SAF can only be used on a client.

getClientSAF

public static ClientSAF getClientSAF(File rootDirectory,
                                     InputStream configuration)
                              throws JMSException

Returns a client SAF instance

Parameters:

rootDirectory - The directory that should be considered the root directory where the client SAF implementation can store files and directories. Any relative paths in the configuration file are relative to this directory (for example, the store directory)

configuration - An input stream for a configuration that is well-formed with respect to weblogic-jmsmd.xsd and which has a root element of weblogic-client-jms

Returns:

A ClientSAF object, which can be used to control the configuration aspects of the ClientSAF system

Throws:

JMSException - If this call is attempted on a WLS server. Client SAF can only be used on a client.

getClientSAF

public static ClientSAF getClientSAF(InputStream configuration)
                              throws JMSException

Returns a client SAF instance

Parameters:

configuration - An input stream for a configuration that is well-formed with respect to weblogic-jmsmd.xsd and which has a root element of weblogic-client-jms

Returns:

A ClientSAF object, which can be used to control the configuration aspects of the ClientSAF system

Throws:

JMSException - If this call is attempted on a WLS server. Client SAF can only be used on a client.