uk.org.ogsadai.client.toolkit.sessions
Class JoinNewSession

java.lang.Object
  |
  +--uk.org.ogsadai.client.toolkit.sessions.JoinNewSession
All Implemented Interfaces:
SessionRequirements

public class JoinNewSession
extends java.lang.Object
implements SessionRequirements

A SessionRequirement to specify that a request should join a new session.

Author:
The OGSA-DAI Project Team

Field Summary
private static java.lang.String COPYRIGHT_NOTICE
          Copyright statement
private  long mTimeout
          The timeout value for the new session.
 
Constructor Summary
JoinNewSession()
          Creates a session requirement to join a new session with the default timeout.
JoinNewSession(long timeout)
          Creates a session requirement to join a new session with the specified timeout.
 
Method Summary
 java.lang.String generateXML()
          Generates the XML string representation of the session requirements for including within a perform document request.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT_NOTICE

private static final java.lang.String COPYRIGHT_NOTICE
Copyright statement

See Also:
Constant Field Values

mTimeout

private final long mTimeout
The timeout value for the new session.

Constructor Detail

JoinNewSession

public JoinNewSession(long timeout)
Creates a session requirement to join a new session with the specified timeout.

Parameters:
timeout - The timeout value in milliseconds. This is the length of time after which a session will expire when no request is joined to it.

JoinNewSession

public JoinNewSession()
Creates a session requirement to join a new session with the default timeout. The value of the default timeout depends on the configuration of the data service and cannot be controlled by the client.

Method Detail

generateXML

public java.lang.String generateXML()
Description copied from interface: SessionRequirements
Generates the XML string representation of the session requirements for including within a perform document request.

Specified by:
generateXML in interface SessionRequirements
Returns:
a string of XML data