uk.org.ogsadai.client.toolkit
Class TimeoutProperty

java.lang.Object
  |
  +--uk.org.ogsadai.client.toolkit.ConnectionProperty
        |
        +--uk.org.ogsadai.client.toolkit.TimeoutProperty

public final class TimeoutProperty

extends ConnectionProperty

The timeout property used to configure the timeout of a client-service connection. The timeout value is the duration that the client will wait for a response from a web service before reporting an error. OGSA-DAI timeout properties have name {http://ogsadai.org.uk/namespaces/2005/10/}timeout.

Author:

The OGSA-DAI Project Team

Field Summary

private static java.lang.String	COPYRIGHT_NOTICE Copyright statement
private int	mDuration Timeout duration in milliseconds
static javax.xml.namespace.QName	TIMEOUT Default name of OGSA-DAI connection property for connection timeout

Fields inherited from class uk.org.ogsadai.client.toolkit.ConnectionProperty

CONNECTION_PROPERTY_NS

Constructor Summary

TimeoutProperty(int duration)
Creates a timeout connection property.

Method Summary

void	configureCallFactory(SOAPCallFactory factory) Configures a SOAPCallFactory to apply this connection property to any subsequent calls that are made.
int	getTimeout() Gets the timeout value in milliseconds.
java.lang.String	toString() Returns a brief description of this timeout property.

Methods inherited from class uk.org.ogsadai.client.toolkit.ConnectionProperty

getName

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT_NOTICE

private static final java.lang.String COPYRIGHT_NOTICE

Copyright statement

See Also:

Constant Field Values

TIMEOUT

public static final javax.xml.namespace.QName TIMEOUT

Default name of OGSA-DAI connection property for connection timeout

mDuration

private int mDuration

Timeout duration in milliseconds

Constructor Detail

TimeoutProperty

public TimeoutProperty(int duration)

Creates a timeout connection property.

Parameters:

duration - Duration to wait in milliseconds.

Method Detail

getTimeout

public int getTimeout()

Gets the timeout value in milliseconds.

Returns:

timeout value in milliseconds.

toString

public java.lang.String toString()

Returns a brief description of this timeout property.

The exact details of this are subject to change but at present the format is
"[TimeoutProperty: duration=1000ms]" return brief description of the timeout property.

Overrides:

toString in class java.lang.Object

configureCallFactory

public void configureCallFactory(SOAPCallFactory factory)

Description copied from class: ConnectionProperty

Configures a SOAPCallFactory to apply this connection property to any subsequent calls that are made.

Specified by:

configureCallFactory in class ConnectionProperty

Parameters:

factory - factory used for creating SOAP calls that this connection property will be applied to