com.groiss.wfxml
Class WfXML2

java.lang.Object
  com.groiss.wfxml.WfXML2

public class WfXML2
extends Object

Field Summary

static String	DMSFILTERATT
static short	MODE_ACTIVE Operating mode active means that WfXML is fully active.
static short	MODE_OFF Operating mode off means that WfXML is deactivated.
static short	MODE_PASSIVE Operating mode passive means that WfXML is activated.

Constructor Summary

WfXML2()

Method Summary

static String	dateToWfXMLDate(Date date) Transforms a date to a WfXML date (like specified in the WfXML specification).
static com.dec.avw.core.Server	getDefaultServer()
static com.dec.avw.core.User	getDefaultUser()
static DMSFilter	getDMSFilter() Return the current DMSFilter.
static int	getMaxLogSize()
static short	getOperatingMode() Use this method to find out if the local server operates in passive, active, or off mode.
static Partner	getPartner(String id) Use this method to get a Partner object representing a WfXML communication partner that you know (you must know the id with which the partner has been defined).
static boolean	isLogEnabled(String object)
static void	removeDMSFilter() Remove the DMSFilter.
static void	setDMSFilter(DMSFilter filter) Set the DMSFilter used to determine inclusion of DMSDocuments in a WfXMLMessage.
static Date	wfXMLDateToDate(String dateString) Transforms a WfXML date to a Java Date object.

Methods inherited from class java.lang.Object

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

Field Detail

MODE_ACTIVE

public static final short MODE_ACTIVE

Operating mode active means that WfXML is fully active. Incoming requests are handled and outgoing requests are sent.

See Also:

Constant Field Values

MODE_OFF

public static final short MODE_OFF

Operating mode off means that WfXML is deactivated. It means that incoming requests are not handled. Anyway, outgoing requests can still be sent from this server.

See Also:

Constant Field Values

MODE_PASSIVE

public static final short MODE_PASSIVE

Operating mode passive means that WfXML is activated. Incoming requests are handled but outgoing messages are not sent actively (they require an active communication partner who will request these messages).

See Also:

Constant Field Values

DMSFILTERATT

public static final String DMSFILTERATT

See Also:

Constant Field Values

Constructor Detail

WfXML2

public WfXML2()

Method Detail

dateToWfXMLDate

public static String dateToWfXMLDate(Date date)

Transforms a date to a WfXML date (like specified in the WfXML specification). WfXML dates are in the form YYYY-MM-DDThh:mm:ssZ and always in GMT (Greenwich Mean Time). So this method transforms the given date to this requirements.
For transformations in the other direction, use the wfXMLDateToDate(String) method.

Parameters:

date - A Date object containing a date/time which you want to tranform to WfXML representation

Returns:

a String containing the WfXML representation of the Date object.

getDefaultServer

public static com.dec.avw.core.Server getDefaultServer()

getDefaultUser

public static com.dec.avw.core.User getDefaultUser()

getMaxLogSize

public static int getMaxLogSize()

getOperatingMode

public static short getOperatingMode()

Use this method to find out if the local server operates in passive, active, or off mode.

Returns:

A short value representing the operating mode of the local server. This can be one of the constants of this class, e.g., MODE_ACTIVE.

getPartner

public static Partner getPartner(String id)
                          throws Exception

Use this method to get a Partner object representing a WfXML communication partner that you know (you must know the id with which the partner has been defined). For enterprise servers, this id is the server id.

Parameters:

id - The id with which the partner has been defined in the enterprise configuration of the local server.

Returns:

A reference to the Partner with the given id, or null if no partner with this id exists.

Throws:

Exception

isLogEnabled

public static boolean isLogEnabled(String object)

wfXMLDateToDate

public static Date wfXMLDateToDate(String dateString)

Transforms a WfXML date to a Java Date object. The WfXML date must be in the specified format YYYY-MM-DDThh:mm:ssZ and in GMT (Greenwich Mean Time). The returned date object will represent the time in the current timezone, depending on where the computer is located. For transformations in the other direction, use the dateToWfXMLDate method.

Parameters:

dateString - A String object containing the WfXML representation of a date/time.

Returns:

A Date object containing the date and time.

Throws:

ApplicationException - if the String dateString is not formatted according to the above mentioned format.

setDMSFilter

public static void setDMSFilter(DMSFilter filter)

Set the DMSFilter used to determine inclusion of DMSDocuments in a WfXMLMessage. Must be cleared after usage via removeDMSFilter()

Parameters:

filter - the DMSFilter to set.

getDMSFilter

public static DMSFilter getDMSFilter()

Return the current DMSFilter.

Returns:

the currently set DMSFilter, or null if no filter has been set.

removeDMSFilter

public static void removeDMSFilter()

Remove the DMSFilter.