edu.indiana.dde.mylead.client
Interface LeadClientIntf

All Known Implementing Classes:
LeadClient

public interface LeadClientIntf

This class is the interface implemented by the LeadClient class which can be used to add, update, and query metadata in a myLEAD catalog.

The utility methods in this inteface use the signatures from MCS and in the LeadClient class the code for these methods is from MCS.


Method Summary
 org.globus.mcs.common.ReturnType addAttribute(java.lang.String dn, MyLeadAttrData attribute, java.lang.String parentName, java.lang.String parentType)
           
 org.globus.mcs.common.ReturnType attributeDef(java.lang.String dn, LeadStringHolder attrDef)
           
 void close()
          Closes the gridservice connection and destroys the service instance.
 org.globus.mcs.common.ReturnType create(java.lang.String dn, MyLeadData item)
           
 org.globus.mcs.common.ReturnType create(java.lang.String dn, MyLeadData item, java.lang.String parentName, java.lang.String parentType)
           
 org.globus.mcs.common.ReturnType create(java.lang.String dn, MyLeadReplica replica)
           
 org.globus.mcs.common.ReturnType create(java.lang.String dn, MyLeadUser user)
           
 java.lang.String getServiceUrl()
          This method returns the endpoint URL of the service that is currently being accessed.
 boolean isAuthenticated()
          This method allows the user to find out whether this client is working in authenticated mode.
 org.globus.mcs.common.ReturnType queryLead(java.lang.String dn, int limit, java.lang.String filter, MyLeadQuery target, LeadStringHolder results)
           
 org.globus.mcs.common.ReturnType queryLead(java.lang.String dn, int limit, java.lang.String filter, MyLeadQuery target, MyLeadContextQuery query, LeadStringHolder results)
           
 org.globus.mcs.common.ReturnType queryReplica(java.lang.String dn, LeadStringHolder results)
           
 org.globus.mcs.common.ReturnType queryUser(java.lang.String dn, LeadStringHolder results)
           
 void setAuthentication(boolean authentic)
          This method allows you to make a authenticated connection to the service.
 org.globus.mcs.common.ReturnType update(java.lang.String dn, MyLeadReplica replica)
           
 org.globus.mcs.common.ReturnType update(java.lang.String dn, MyLeadUser user)
           
 org.globus.mcs.common.ReturnType userExists(java.lang.String dn)
           
 

Method Detail

userExists

public org.globus.mcs.common.ReturnType userExists(java.lang.String dn)
                                            throws org.globus.mcs.client.MCSException
Throws:
org.globus.mcs.client.MCSException

queryLead

public org.globus.mcs.common.ReturnType queryLead(java.lang.String dn,
                                                  int limit,
                                                  java.lang.String filter,
                                                  MyLeadQuery target,
                                                  LeadStringHolder results)
                                           throws org.globus.mcs.client.MCSException
Throws:
org.globus.mcs.client.MCSException

queryLead

public org.globus.mcs.common.ReturnType queryLead(java.lang.String dn,
                                                  int limit,
                                                  java.lang.String filter,
                                                  MyLeadQuery target,
                                                  MyLeadContextQuery query,
                                                  LeadStringHolder results)
                                           throws org.globus.mcs.client.MCSException
Throws:
org.globus.mcs.client.MCSException

queryReplica

public org.globus.mcs.common.ReturnType queryReplica(java.lang.String dn,
                                                     LeadStringHolder results)
                                              throws org.globus.mcs.client.MCSException
Throws:
org.globus.mcs.client.MCSException

queryUser

public org.globus.mcs.common.ReturnType queryUser(java.lang.String dn,
                                                  LeadStringHolder results)
                                           throws org.globus.mcs.client.MCSException
Throws:
org.globus.mcs.client.MCSException

attributeDef

public org.globus.mcs.common.ReturnType attributeDef(java.lang.String dn,
                                                     LeadStringHolder attrDef)
                                              throws org.globus.mcs.client.MCSException
Throws:
org.globus.mcs.client.MCSException

create

public org.globus.mcs.common.ReturnType create(java.lang.String dn,
                                               MyLeadData item)
                                        throws org.globus.mcs.client.MCSException
Throws:
org.globus.mcs.client.MCSException

create

public org.globus.mcs.common.ReturnType create(java.lang.String dn,
                                               MyLeadData item,
                                               java.lang.String parentName,
                                               java.lang.String parentType)
                                        throws org.globus.mcs.client.MCSException
Throws:
org.globus.mcs.client.MCSException

create

public org.globus.mcs.common.ReturnType create(java.lang.String dn,
                                               MyLeadReplica replica)
                                        throws org.globus.mcs.client.MCSException
Throws:
org.globus.mcs.client.MCSException

create

public org.globus.mcs.common.ReturnType create(java.lang.String dn,
                                               MyLeadUser user)
                                        throws org.globus.mcs.client.MCSException
Throws:
org.globus.mcs.client.MCSException

update

public org.globus.mcs.common.ReturnType update(java.lang.String dn,
                                               MyLeadReplica replica)
                                        throws org.globus.mcs.client.MCSException
Throws:
org.globus.mcs.client.MCSException

update

public org.globus.mcs.common.ReturnType update(java.lang.String dn,
                                               MyLeadUser user)
                                        throws org.globus.mcs.client.MCSException
Throws:
org.globus.mcs.client.MCSException

addAttribute

public org.globus.mcs.common.ReturnType addAttribute(java.lang.String dn,
                                                     MyLeadAttrData attribute,
                                                     java.lang.String parentName,
                                                     java.lang.String parentType)
                                              throws org.globus.mcs.client.MCSException
Throws:
org.globus.mcs.client.MCSException

close

public void close()
           throws org.globus.mcs.client.MCSException
Closes the gridservice connection and destroys the service instance.

Throws:
org.globus.mcs.client.MCSException - If any error occurs during closing the service instance this Exception is thrown.
See Also:
MCSException

getServiceUrl

public java.lang.String getServiceUrl()
This method returns the endpoint URL of the service that is currently being accessed.

Returns:
String containing the URL.

setAuthentication

public void setAuthentication(boolean authentic)
This method allows you to make a authenticated connection to the service.

Parameters:
authentic - if true then the authentication is set and a valid proxy is required to use the authentication. if false then authentication is removed.

isAuthenticated

public boolean isAuthenticated()
This method allows the user to find out whether this client is working in authenticated mode.

Returns:
boolean - possible values returned are:
true - if the client is working in authenticated mode.
false - if the client is working in non authenticated mode.