edu.indiana.dde.mylead.common
Class MyLeadStorage

java.lang.Object
  extended byedu.indiana.dde.mylead.common.MyLeadStorage

public class MyLeadStorage
extends java.lang.Object

This class is used to identify the storage resources that are available to a user. In this class the storage resource is defined, but in the MyLeadUser class storage resources can be associated with individual users.

See Also:
MyLeadUser

Constructor Summary
MyLeadStorage()
          Default constructor for a storage resource.
 
Method Summary
 void addProtocol(java.lang.String protocol)
          Used to add a transport protocol to the list for this storage resource.
 java.lang.String getAccessUrl()
          Returns the access URL previously set in a call to the setAccessUrl method.
 java.lang.String getGlobalId()
          Returns the global ID previously set in a call to the setGlobalId method.
 java.lang.String getNickname()
          Returns the unique nickname previously set in a call to the setNickname method.
 void setAccessUrl(java.lang.String urlStr)
          Used to set the access URL for the resource defined in this class.
 void setGlobalId(java.lang.String idStr)
          Used to set the global ID for the resource defined in this class.
 void setNickname(java.lang.String nameStr)
          Used to set the unique nickname for the resource defined in this class.
 java.lang.String wrapParameters()
          Wraps up the parameters in an XML fragment for use in an OGSA-DAI perform document used by the myLEAD client.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MyLeadStorage

public MyLeadStorage()
Default constructor for a storage resource. All of the variables are set to blank strings for the defaults.

Method Detail

setGlobalId

public void setGlobalId(java.lang.String idStr)
Used to set the global ID for the resource defined in this class.

Parameters:
idStr - String with the global ID for this resource.

getGlobalId

public java.lang.String getGlobalId()
Returns the global ID previously set in a call to the setGlobalId method. If not previously set, the default empty String set in the constructor is returned.

Returns:
String with the global ID for this storage resource.

setAccessUrl

public void setAccessUrl(java.lang.String urlStr)
Used to set the access URL for the resource defined in this class.

Parameters:
urlStr - String with the access URL for this resource.

getAccessUrl

public java.lang.String getAccessUrl()
Returns the access URL previously set in a call to the setAccessUrl method. If not previously set, the default empty String set in the constructor is returned.

Returns:
String with the access URL for this storage resource.

setNickname

public void setNickname(java.lang.String nameStr)
Used to set the unique nickname for the resource defined in this class.

Parameters:
nameStr - String with the unique nickname for this resource.

getNickname

public java.lang.String getNickname()
Returns the unique nickname previously set in a call to the setNickname method. If not previously set, the default empty String set in the constructor is returned.

Returns:
String with the unique nickname for this storage resource.

addProtocol

public void addProtocol(java.lang.String protocol)
Used to add a transport protocol to the list for this storage resource. A storage resource can have more than one access protocol.

Parameters:
protocol - String containing the protocol to be added to the list of access protocols for this storage resource.

wrapParameters

public java.lang.String wrapParameters()
                                throws org.globus.mcs.client.MCSException
Wraps up the parameters in an XML fragment for use in an OGSA-DAI perform document used by the myLEAD client. Fields are only included if they have a value. The nickname is a required field.

Returns:
String with the XML fragment for this storage resource.
Throws:
org.globus.mcs.client.MCSException