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

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

public class JoinExistingSession
extends java.lang.Object
implements SessionRequirements

A SessionRequirement to specify that a request should join an existing session.

Author:
The OGSA-DAI Project Team

Field Summary
private static java.lang.String COPYRIGHT_NOTICE
          Copyright statement
private  SessionID mID
          The ID of the existing session to join.
 
Constructor Summary
JoinExistingSession(Session session)
          Creates a session requirement to join the specified session.
JoinExistingSession(SessionID id)
          Creates a session requirement to join the specified session.
JoinExistingSession(java.lang.String id)
          Creates a session requirement to join the specified session.
 
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

mID

private final SessionID mID
The ID of the existing session to join.

Constructor Detail

JoinExistingSession

public JoinExistingSession(SessionID id)
Creates a session requirement to join the specified session.

Parameters:
id - the session to join

JoinExistingSession

public JoinExistingSession(Session session)
Creates a session requirement to join the specified session.

Parameters:
session - the session to join

JoinExistingSession

public JoinExistingSession(java.lang.String id)
Creates a session requirement to join the specified session.

Parameters:
id - the session identifier string to join
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