edu.indiana.dde.mylead.client
Class LeadClient

java.lang.Object
  extended by edu.indiana.dde.mylead.client.LeadClient
All Implemented Interfaces:
LeadClientIntf

public class LeadClient
extends java.lang.Object
implements LeadClientIntf

LeadClient Class


Field Summary
protected static java.lang.String LOG4J_FILE
           
protected static java.lang.String LOG4J_PROPERTY
           
 
Constructor Summary
LeadClient(java.lang.String gridfactoryurl)
          Constructor for the LeadClient object using the default lifetime.
LeadClient(java.lang.String gridfactoryurl, int servicetime)
          Constructor for the LeadClient object.
LeadClient(java.lang.String gridserviceurl, java.lang.String gridfactoryurl, java.lang.String gridregistryurl)
          Deprecated. Since OGSA-DAI 6.0 was implemented, the constructor only uses the factory URL.
LeadClient(java.lang.String gridserviceurl, java.lang.String gridfactoryurl, java.lang.String gridregistryurl, int servicetime)
          Deprecated. Since OGSA-DAI 6.0 was implemented, the constructor only uses the factory URL.
 
Method Summary
 ReturnType addAttribute(java.lang.String dn, CreateAttrHolder[] items)
          This overload of the addAttributes method takes a user's dn, the object they wish to add an attribute to, and an array of CreateAttrHolder instances.
 ReturnType addAttribute(java.lang.String dn, java.lang.String objectGuid, java.lang.String item)
          This method takes a user's dn, the object they wish to add an attribute to, and a LEAD schema fragment containing a node to be added.
 ReturnType addAttribute(java.lang.String dn, java.lang.String objectGuid, java.lang.String[] items)
          This method is an overload of the add attribute.
 ReturnType attributeDef(java.lang.String dn, LeadStringHolder results)
          Returns an XML fragment containing the attributes and elements defined in the mcs_lead database for myLEAD.
 void close()
          Closes the grid service connection and destroys the service instance.
 ReturnType create(java.lang.String dn, CreateDataHolder[] myLeadHolder)
          This version of the create method takes an array of CreateDataHolder instances as a parameter instead of a single LEAD schema instance.
 ReturnType create(java.lang.String dn, MyLeadReplica replica)
          Overrides the create method to take an instance of MyLeadReplica which is used to add a new record for a myLEAD replica to the database.
 ReturnType create(java.lang.String dn, MyLeadReplica[] replicas)
          Overrides the create method to take an instance of MyLeadReplica which is used to add a new record for a myLEAD replica to the database.
 ReturnType create(java.lang.String dn, MyLeadUser user)
          Overrides the create method to take an instance of a MyLeadUser object to add a user profile to the mcs_writer table.
 ReturnType create(java.lang.String dn, MyLeadUser[] users)
          Overrides the create method to take an array of MyLeadUser objects to add user profiles to the mcs_writer table.
 ReturnType create(java.lang.String dn, java.lang.String item, java.lang.String objectType)
          This method adds a file or collection to the myLEAD metadata database.
 ReturnType create(java.lang.String dn, java.lang.String item, java.lang.String objectType, java.lang.String parentGuid)
          This version of the create method has additional parameters for the global ID of the parent object this item is being added to.
 ReturnType delete(java.lang.String dn, java.lang.String objectGuid)
          This method is called to delete an object (file or collection) and the subtree under that object.
 ReturnType deleteAttribute(java.lang.String dn, java.lang.String objectGuid, java.lang.String attrName, java.lang.String attrSrc, int[] positions, java.lang.Long lastUpdate)
          This activity allows a user to delete a metadata attribute in an object they own - as long as it is a deletable metadata attribute.
 ReturnType deleteAttribute(java.lang.String dn, java.lang.String objectGuid, java.lang.String attrName, java.lang.String attrSrc, int firstPos, int lastPos, java.lang.Long lastUpdate)
          This activity allows a user to delete a metadata attribute in an object they own - as long as it is a deletable metadata attribute.
 ReturnType deleteAttribute(java.lang.String dn, java.lang.String objectGuid, java.lang.String attrName, java.lang.String attrSrc, int position, java.lang.Long lastUpdate)
          Override of the deleteAttribute method which takes a single integer position instead of an array of integer positions.
 ReturnType deleteReplica(java.lang.String dn, java.lang.String nickName)
          This method is called to delete the definition for a myLEAD replica.
 ReturnType deleteReplica(java.lang.String dn, java.lang.String[] nickNames)
          This method is called to delete the definition for multiple myLEAD replicas.
 ReturnType deleteUser(java.lang.String dn, java.lang.String userDn)
          This method is called to delete a user and all of their objects from the catalog.
protected  void finalize()
           
 java.lang.String getHost()
           
 java.lang.String getPort()
           
 java.lang.String getProperty(java.lang.String property)
          All of the methods return some metadata in the response document.
 java.lang.String getServiceUrl()
          Returns the endpoint url of the service that is currently being accessed.
 ReturnType getStatus()
          Before processing a request, the status is set to ReturnType.NO_RESULTS_FOUND and at the end of executing, the status is updated from the response.
 ReturnType getWhiteboardId(java.lang.String dn, LeadStringHolder results)
          This method is passed a distinguished name and it either returns OPERATION_SUCCESSFUL if the user exists in the myLEAD catalog and the ID of their default whiteboard project could be determined, or it returns NO_RESULTS_FOUND.
 boolean isAuthenticated()
          Allows the user to find out whether this client is working in authenticated mode.
 ReturnType move(java.lang.String dn, java.lang.String objectGuid, java.lang.String newParentGuid)
          This method can be used to move an object from one hierarchy to another.
 ReturnType objectExists(java.lang.String dn, java.lang.String guid, int[] objectType)
          This method is passed a distinguished name and the global ID for an object.
 ReturnType queryById(java.lang.String dn, MyLeadParentChildFilterSet hFilter, MyLeadContentFilter cFilter, java.lang.String[] guids, LeadStringHolder results)
          This method is an overload of the queryById method that takes an attribute or element content filter.
 ReturnType queryById(java.lang.String dn, MyLeadParentChildFilterSet hFilter, MyLeadContentFilter cFilter, java.lang.String guid, LeadStringHolder results)
          Overload of the queryById method for taking a single global ID, but also uses the MyLeadParentChildFilterSet hierarchy filter.
 ReturnType queryById(java.lang.String dn, MyLeadParentChildFilterSet hFilter, java.lang.String cFilter, QryExclusionHolder[] exclusions, java.lang.String[] guids, LeadStringHolder results)
          This method is an overload of the queryById method which takes arrays of exclusions and GUIDs.
 ReturnType queryById(java.lang.String dn, MyLeadParentChildFilterSet hFilter, java.lang.String cFilter, QryExclusionHolder[] exclusions, java.lang.String guid, LeadStringHolder results)
          This method is an overload of the queryById method which uses attribute and element exclusions but takes a single GUID - this also uses the MyLeadParentChildFilterSet hierarchy filter.
 ReturnType queryById(java.lang.String dn, MyLeadParentChildFilterSet hFilter, java.lang.String cFilter, java.lang.String[] guids, LeadStringHolder results)
          Overload of the queryById method without the exclusions parameter but using the MyLeadParentChildFilterSet hierarchy filter
 ReturnType queryById(java.lang.String dn, MyLeadParentChildFilterSet hFilter, java.lang.String cFilter, java.lang.String guid, LeadStringHolder results)
          Overload of the queryById method without the exclusions parameter but using the MyLeadParentChildFilterSet hierarchy filter.
 ReturnType queryById(java.lang.String dn, java.lang.String hFilter, MyLeadContentFilter cFilter, java.lang.String[] guids, LeadStringHolder results)
          This overload of queryById takes one or more attribute or element filters for the content filter.
 ReturnType queryById(java.lang.String dn, java.lang.String hFilter, MyLeadContentFilter cFilter, java.lang.String guid, LeadStringHolder results)
          Overloaded version of queryById that handles a query for a single global ID and calls the version which takes an array of global IDs.
 ReturnType queryById(java.lang.String dn, java.lang.String hFilter, java.lang.String cFilter, QryExclusionHolder[] exclusions, java.lang.String[] guids, LeadStringHolder results)
          This method queries for objects identified by the GUIDs passed as parameters, but only if owned by the user identified by the dn parameter.
 ReturnType queryById(java.lang.String dn, java.lang.String hFilter, java.lang.String cFilter, QryExclusionHolder[] exclusions, java.lang.String guid, LeadStringHolder results)
          Overloaded version of queryById that handles a query for a single global ID and calls the version which takes an array of global IDs.
 ReturnType queryById(java.lang.String dn, java.lang.String hFilter, java.lang.String cFilter, java.lang.String[] guids, LeadStringHolder results)
          Overload of the queryById method without the exclusions parameter.
 ReturnType queryById(java.lang.String dn, java.lang.String hFilter, java.lang.String cFilter, java.lang.String guid, LeadStringHolder results)
          Overload of the queryById method without the exclusions parameter.
 ReturnType queryByIdXml(java.lang.String dn, java.lang.String hFilter, java.lang.String cFilter, QryExclusionHolder[] exclusions, java.lang.String[] guids, LeadStringHolder results)
          This method is an alternative to queryById where the cFilter has already been wrapped through a call to the wrapFilter method of the MyLeadContentFilter class.
 ReturnType queryByIdXml(java.lang.String dn, java.lang.String hFilter, java.lang.String cFilter, QryExclusionHolder[] exclusions, java.lang.String guid, LeadStringHolder results)
          Override of the queryByIdXml where there is only a single object parameter.
 ReturnType queryByIdXml(java.lang.String dn, java.lang.String hFilter, java.lang.String cFilter, java.lang.String[] guids, LeadStringHolder results)
          Overload of the queryByIdXml method without the exclusions parameter.
 ReturnType queryByIdXml(java.lang.String dn, java.lang.String hFilter, java.lang.String cFilter, java.lang.String guid, LeadStringHolder results)
          Overload of the queryByIdXml method without the exclusions parameter and only a single object guid.
 ReturnType queryLead(java.lang.String dn, int limit, MyLeadParentChildFilterSet hFilter, MyLeadContentFilter cFilter, MyLeadQuery target, LeadStringHolder results)
          Overload of the queryLead method that takes a MyLeadContentFilter instance for the content filter, specifies no query context, and an instance of MyLeadParentChildFilterSet is used for the hierarchy filter.
 ReturnType queryLead(java.lang.String dn, int limit, MyLeadParentChildFilterSet hFilter, MyLeadContentFilter cFilter, MyLeadQuery target, MyLeadContextQuery query, LeadStringHolder results)
          Overload of the queryLead method that takes a MyLeadContentFilter instance for the content filter and a MyLeadParentChildFilterSet instance for the hierarchy filter.
 ReturnType queryLead(java.lang.String dn, int limit, MyLeadParentChildFilterSet hFilter, java.lang.String cFilter, MyLeadQuery target, LeadStringHolder results)
          Overload of the queryLead method without the exclusions parameter, but an instance of MyLeadParentChildFilterSet is used for the hierarchy filter.
 ReturnType queryLead(java.lang.String dn, int limit, MyLeadParentChildFilterSet hFilter, java.lang.String cFilter, MyLeadQuery target, MyLeadContextQuery query, LeadStringHolder results)
          Overload of the queryLead method without the exclusions parameter but using the parent-child hierarchy filter.
 ReturnType queryLead(java.lang.String dn, int limit, MyLeadParentChildFilterSet hFilter, java.lang.String cFilter, QryExclusionHolder[] exclusions, MyLeadQuery target, LeadStringHolder results)
          An overloaded version of the queryLead method in which a context is not specified, but an instance of MyLeadParentChildFilterSet is used for the hierarchy filter.
 ReturnType queryLead(java.lang.String dn, int limit, MyLeadParentChildFilterSet hFilter, java.lang.String cFilter, QryExclusionHolder[] exclusions, MyLeadQuery target, MyLeadContextQuery query, LeadStringHolder results)
          This overloaded version of queryLead takes a parent-child hierarchy filter set instead of the constant strings for predefined hierarchies.
 ReturnType queryLead(java.lang.String dn, int limit, java.lang.String hFilter, MyLeadContentFilter cFilter, MyLeadQuery target, LeadStringHolder results)
          Overload of the queryLead method that takes a MyLeadContentFilter instance for the content filter but specifies no query context.
 ReturnType queryLead(java.lang.String dn, int limit, java.lang.String hFilter, MyLeadContentFilter cFilter, MyLeadQuery target, MyLeadContextQuery query, LeadStringHolder results)
          Overload of the queryLead method that takes a MyLeadContentFilter instance for the content filter.
 ReturnType queryLead(java.lang.String dn, int limit, java.lang.String hFilter, java.lang.String cFilter, MyLeadQuery target, LeadStringHolder results)
          Overload of the queryLead method without the exclusions parameter.
 ReturnType queryLead(java.lang.String dn, int limit, java.lang.String hFilter, java.lang.String cFilter, MyLeadQuery target, MyLeadContextQuery query, LeadStringHolder results)
          Overload of the queryLead method without the exclusions parameter.
 ReturnType queryLead(java.lang.String dn, int limit, java.lang.String hFilter, java.lang.String cFilter, QryExclusionHolder[] exclusions, MyLeadQuery target, LeadStringHolder results)
          An overloaded version of the queryLead method in which a context is not specified - the query is based only on a target and not the context of that target (parent or child objects).
 ReturnType queryLead(java.lang.String dn, int limit, java.lang.String hFilter, java.lang.String cFilter, QryExclusionHolder[] exclusions, MyLeadQuery target, MyLeadContextQuery query, LeadStringHolder results)
          Query myLEAD based on a target specification for a file, collection, experiment, or project in the context of a query composed of chains of objects that could be contained in the target or objects the target is within.
 ReturnType queryLeadXml(java.lang.String dn, int limit, java.lang.String hFilter, java.lang.String cFilter, QryExclusionHolder[] exclusions, java.lang.String target, LeadStringHolder results)
          Overload of the queryLeadXml method without the context query parameter.
 ReturnType queryLeadXml(java.lang.String dn, int limit, java.lang.String hFilter, java.lang.String cFilter, QryExclusionHolder[] exclusions, java.lang.String target, java.lang.String query, LeadStringHolder results)
          This method is an alternative to queryLead where the cFilter, target, and context query have all already been wrapped through a call to the wrapFilter method of the MyLeadContentFilter class for the filter and the wrapParameters and wrapQuery methods respectively for the target and context query.
 ReturnType queryLeadXml(java.lang.String dn, int limit, java.lang.String hFilter, java.lang.String cFilter, java.lang.String target, LeadStringHolder results)
          Overload of the queryLeadXml method without the exclusions parameter or query context.
 ReturnType queryLeadXml(java.lang.String dn, int limit, java.lang.String hFilter, java.lang.String cFilter, java.lang.String target, java.lang.String query, LeadStringHolder results)
          Overload of the queryLeadXml method without the exclusions parameter.
 ReturnType queryReplica(java.lang.String dn, LeadStringHolder results)
          Passed the distinguished name (dn) of the user and returns information regarding the myLEAD replica that user is assigned to in the mcs_writer table.
 ReturnType queryUser(java.lang.String dn, LeadStringHolder results)
          Passed the distinguished name (dn) of the user and returns information regarding the myLEAD profile for that user in the mcs_writer table.
 ReturnType queryWorkspace(java.lang.String dn, LeadStringHolder results)
          This version of queryWorkspace returns the globally unique IDs (GUID) and title for the entire subtree of the highest level in the hierarchy for the user specified by the DN.
 ReturnType queryWorkspace(java.lang.String dn, java.lang.String guid, int limit, LeadStringHolder results)
          This method returns the globally unique IDs (GUID) and title for each child of the object whos GUID is passed as a parameter.
 void setAuthentication(boolean authentic)
          Allows you to make an authenticated connection to the myLEAD service.
 void setBufferSize(int size)
           
 void setHost(java.lang.String hostName)
           
 void setPort(java.lang.String portNum)
           
 ReturnType update(java.lang.String dn, MyLeadReplica replica)
          This method takes an instance of MyLeadReplica which is used to update an existing myLEAD replica definition in the database based on the nickname.
 ReturnType update(java.lang.String dn, MyLeadReplica[] replicas)
          This method takes an array of MyLeadReplica instances which are used to update existing myLEAD replica definitions in the database based on the nickname.
 ReturnType update(java.lang.String dn, MyLeadUser user)
          This method takes an instance of MyLeadUser which is used to update an existing myLEAD user profile in the mcs_writer table.
 ReturnType update(java.lang.String dn, MyLeadUser[] users)
          Overrides the update method to take an array of MyLeadUser objects to update user profiles in the mcs_writer table.
 ReturnType updateAttribute(java.lang.String dn, java.lang.String objectGuid, java.lang.String item, java.lang.Integer position, java.lang.Long lastUpdate)
          This method takes a user's dn, the global ID of the object they wish to update, a LEAD sMetadata Schema (LMS) fragment containing the revised node, the position (if a metadata attribute allows for multiple instances), and the timestamp of the data being revised.
 ReturnType updateAttribute(java.lang.String dn, UpdateAttrHolder[] updates)
          This version of updateAttribute takes an array of UpdateAttrHolder instances which each contain the specifics for an update.
 ReturnType userExists(java.lang.String dn)
          This method is passed a distinguished name and it either returns OPERATION_SUCCESSFUL if the user exists in the myLEAD catalog, or it returns NO_RESULTS_FOUND if the user is not defined in myLEAD.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOG4J_PROPERTY

protected static final java.lang.String LOG4J_PROPERTY
See Also:
Constant Field Values

LOG4J_FILE

protected static final java.lang.String LOG4J_FILE
See Also:
Constant Field Values
Constructor Detail

LeadClient

public LeadClient(java.lang.String gridfactoryurl,
                  int servicetime)
           throws MyLeadException
Constructor for the LeadClient object. It takes in 2 arguments as listed below.
At least one of the URL arguments has to be NON NULL for the object to be created.

Parameters:
gridfactoryurl - The url string where the factory instance can be located.
servicetime - The destroy time for the service instance which is created using a factory.
Throws:
MyLeadException - If any error occurs then this exception is thrown.

LeadClient

public LeadClient(java.lang.String gridfactoryurl)
           throws MyLeadException
Constructor for the LeadClient object using the default lifetime. This version of the constructor takes just the factory URL as an argument. The default lietime is 5 minutes.

Parameters:
gridfactoryurl - The url string where the factory instance can be located.
Throws:
MyLeadException - If any error occurs then this exception is thrown.

LeadClient

public LeadClient(java.lang.String gridserviceurl,
                  java.lang.String gridfactoryurl,
                  java.lang.String gridregistryurl)
           throws MyLeadException
Deprecated. Since OGSA-DAI 6.0 was implemented, the constructor only uses the factory URL.

Constructor for the LeadClient object using the default lifetime. This version of the constructor takes 3 arguments as listed below.
At least one of the URL arguments has to be NON NULL for the object to be created. The service instance, if created from a factory, will have a default destroy time of 5 minutes.

Parameters:
gridserviceurl - The url string where the service instance is located.
gridfactoryurl - The url string where the factory instance can be located.
gridregistryurl - The url string where the registry can be located.
Throws:
MyLeadException - If any error occurs then this exception is thrown.

LeadClient

public LeadClient(java.lang.String gridserviceurl,
                  java.lang.String gridfactoryurl,
                  java.lang.String gridregistryurl,
                  int servicetime)
           throws MyLeadException
Deprecated. Since OGSA-DAI 6.0 was implemented, the constructor only uses the factory URL.

This version of the constructor takes in 4 arguments as listed below.
At least one of the URL arguments has to be NON NULL for the object to be created.

Parameters:
gridserviceurl - The url string where the service instance is located.
gridfactoryurl - The url string where the factory instance can be located.
gridregistryurl - The url string where the registry can be located.
servicetime - The destroy time for the service instance which is created using a factory.
Throws:
MyLeadException
Method Detail

setBufferSize

public void setBufferSize(int size)

setHost

public void setHost(java.lang.String hostName)

getHost

public java.lang.String getHost()

setPort

public void setPort(java.lang.String portNum)

getPort

public java.lang.String getPort()

getStatus

public ReturnType getStatus()
Before processing a request, the status is set to ReturnType.NO_RESULTS_FOUND and at the end of executing, the status is updated from the response.

Specified by:
getStatus in interface LeadClientIntf
Returns:
ReturnType with status of the last request processed

getProperty

public java.lang.String getProperty(java.lang.String property)
All of the methods return some metadata in the response document. All of the methods at least return a ReturnType from the process. the ReturnType can also be retrieved with the getStatus method. At the start of each process, these metadata properties are cleared, so if there was an error, the properties may be empty. This method takes the name of a property and returns that property's value. If the property is not in the set, an empty string is returned.

Specified by:
getProperty in interface LeadClientIntf
Parameters:
property - String with the name of the property value being requested
Returns:
String with the property value, or an empty string if the property is not in the set of properties returned for the last request.

userExists

public ReturnType userExists(java.lang.String dn)
                      throws MyLeadException
This method is passed a distinguished name and it either returns OPERATION_SUCCESSFUL if the user exists in the myLEAD catalog, or it returns NO_RESULTS_FOUND if the user is not defined in myLEAD.

Specified by:
userExists in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user being checked for.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL or
ReturnType.NO_RESULTS_FOUND
Throws:
MyLeadException

objectExists

public ReturnType objectExists(java.lang.String dn,
                               java.lang.String guid,
                               int[] objectType)
                        throws MyLeadException
This method is passed a distinguished name and the global ID for an object. it either returns OPERATION_SUCCESSFUL if the object exists in the specified user's space in the myLEAD catalog, or it reutrrns one of the return types listed below if there was an error or the object does not exist for this user.

Specified by:
objectExists in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user.
guid - String with the global ID of the object being sought
objectType - int array used to return the type for the object if found.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.OBJECT_DOES_NOT_EXIST,
ReturnType.NO_RESULTS_FOUND - nothing returned by the server,
ReturnType.OUTPUT_INIT_ERROR - OGSA-DAI setup error, or
ReturnType.MYLEAD_INTERNAL_ERROR - other processing error.
Throws:
MyLeadException

getWhiteboardId

public ReturnType getWhiteboardId(java.lang.String dn,
                                  LeadStringHolder results)
                           throws MyLeadException
This method is passed a distinguished name and it either returns OPERATION_SUCCESSFUL if the user exists in the myLEAD catalog and the ID of their default whiteboard project could be determined, or it returns NO_RESULTS_FOUND.

Parameters:
dn - String with the distinguished name of the user.
results - StringHolder in which the user's whiteboard global ID will be returned. If there is an error, then this will be set to an empty string.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL or
ReturnType.NO_RESULTS_FOUND
Throws:
MyLeadException

queryById

public ReturnType queryById(java.lang.String dn,
                            java.lang.String hFilter,
                            java.lang.String cFilter,
                            QryExclusionHolder[] exclusions,
                            java.lang.String[] guids,
                            LeadStringHolder results)
                     throws MyLeadException
This method queries for objects identified by the GUIDs passed as parameters, but only if owned by the user identified by the dn parameter. The results returned are based on the hierarchy filter (hFilter) and the content filter (cFilter) and returned in the results string holder. Other versions of this method handle the attribute or element content filters.

Specified by:
queryById in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user issuing the query.
hFilter - String with the hierarchy filter - target or full subtree.
cFilter - String with the content filter - GUIDONLY or FULL_SCHEMA.
exclusions - Array of QryExclusionHolder instances which contain a node or metadata attribute name and an attribute source if the exclusion is for a metadata attribute.
guids - Array of Strings containing the global IDs of the objects to query on.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MYLEAD_INTERNAL_ERROR
Throws:
MyLeadException - If any error occurs during execution of the request then this Exception is thrown.
See Also:
LeadStringHolder

queryById

public ReturnType queryById(java.lang.String dn,
                            MyLeadParentChildFilterSet hFilter,
                            java.lang.String cFilter,
                            QryExclusionHolder[] exclusions,
                            java.lang.String[] guids,
                            LeadStringHolder results)
                     throws MyLeadException
This method is an overload of the queryById method which takes arrays of exclusions and GUIDs. This override uses the MyLeadParentChildFilterSet filter.

Specified by:
queryById in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user issuing the query.
hFilter - MyLeadParentChildFilterSet instance containing the parent-child hierarchy filter.
cFilter - String with the content filter - GUIDONLY or FULL_SCHEMA.
exclusions - Array of QryExclusionHolder instances which contain a node or metadata attribute name and an attribute source if the exclusion is for a metadata attribute.
guids - Array of Strings containing the global IDs of the objects to query on.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MYLEAD_INTERNAL_ERROR
Throws:
MyLeadException - If any error occurs during execution of the request then this Exception is thrown.
See Also:
LeadStringHolder

queryById

public ReturnType queryById(java.lang.String dn,
                            java.lang.String hFilter,
                            java.lang.String cFilter,
                            java.lang.String[] guids,
                            LeadStringHolder results)
                     throws MyLeadException
Overload of the queryById method without the exclusions parameter.

Specified by:
queryById in interface LeadClientIntf
Throws:
MyLeadException

queryById

public ReturnType queryById(java.lang.String dn,
                            MyLeadParentChildFilterSet hFilter,
                            java.lang.String cFilter,
                            java.lang.String[] guids,
                            LeadStringHolder results)
                     throws MyLeadException
Overload of the queryById method without the exclusions parameter but using the MyLeadParentChildFilterSet hierarchy filter

Specified by:
queryById in interface LeadClientIntf
Throws:
MyLeadException

queryById

public ReturnType queryById(java.lang.String dn,
                            java.lang.String hFilter,
                            MyLeadContentFilter cFilter,
                            java.lang.String[] guids,
                            LeadStringHolder results)
                     throws MyLeadException
This overload of queryById takes one or more attribute or element filters for the content filter.

Specified by:
queryById in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user issuing the query.
hFilter - String with the hierarchy filter - target or full subtree.
cFilter - myLeadContentFilter which is either a myLeadAttributeFilter or myLeadElementFilter object.
guids - Array of Strings containing the global IDs of the objects to query on.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MYLEAD_INTERNAL_ERROR
Throws:
MyLeadException - If any error occurs during execution of the request then this Exception is thrown.
See Also:
LeadStringHolder

queryById

public ReturnType queryById(java.lang.String dn,
                            MyLeadParentChildFilterSet hFilter,
                            MyLeadContentFilter cFilter,
                            java.lang.String[] guids,
                            LeadStringHolder results)
                     throws MyLeadException
This method is an overload of the queryById method that takes an attribute or element content filter. This override also takes a MyLeadParentChildFilterSet for the hierarchy filter.

Specified by:
queryById in interface LeadClientIntf
Throws:
MyLeadException

queryById

public ReturnType queryById(java.lang.String dn,
                            java.lang.String hFilter,
                            java.lang.String cFilter,
                            QryExclusionHolder[] exclusions,
                            java.lang.String guid,
                            LeadStringHolder results)
                     throws MyLeadException
Overloaded version of queryById that handles a query for a single global ID and calls the version which takes an array of global IDs.

Specified by:
queryById in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user issuing the query.
hFilter - String with the hierarchy filter - target or full subtree.
cFilter - String with the content filter - GUID only or full schema.
exclusions - Array of QryExclusionHolder instances which contain a node or metadata attribute name and an attribute source if the exclusion is for a metadata attribute.
guid - String with the global ID of the object to query on.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MYLEAD_INTERNAL_ERROR
Throws:
MyLeadException - If any error occurs during execution of the request then this Exception is thrown.
See Also:
LeadStringHolder

queryById

public ReturnType queryById(java.lang.String dn,
                            MyLeadParentChildFilterSet hFilter,
                            java.lang.String cFilter,
                            QryExclusionHolder[] exclusions,
                            java.lang.String guid,
                            LeadStringHolder results)
                     throws MyLeadException
This method is an overload of the queryById method which uses attribute and element exclusions but takes a single GUID - this also uses the MyLeadParentChildFilterSet hierarchy filter.

Specified by:
queryById in interface LeadClientIntf
Throws:
MyLeadException

queryById

public ReturnType queryById(java.lang.String dn,
                            java.lang.String hFilter,
                            java.lang.String cFilter,
                            java.lang.String guid,
                            LeadStringHolder results)
                     throws MyLeadException
Overload of the queryById method without the exclusions parameter.

Specified by:
queryById in interface LeadClientIntf
Throws:
MyLeadException

queryById

public ReturnType queryById(java.lang.String dn,
                            MyLeadParentChildFilterSet hFilter,
                            java.lang.String cFilter,
                            java.lang.String guid,
                            LeadStringHolder results)
                     throws MyLeadException
Overload of the queryById method without the exclusions parameter but using the MyLeadParentChildFilterSet hierarchy filter.

Specified by:
queryById in interface LeadClientIntf
Throws:
MyLeadException

queryById

public ReturnType queryById(java.lang.String dn,
                            java.lang.String hFilter,
                            MyLeadContentFilter cFilter,
                            java.lang.String guid,
                            LeadStringHolder results)
                     throws MyLeadException
Overloaded version of queryById that handles a query for a single global ID and calls the version which takes an array of global IDs. This version uses a MyLeadContentFilter.

Specified by:
queryById in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user issuing the query.
hFilter - String with the hierarchy filter - target or full subtree.
cFilter - MyLeadContentFilter with the content filter.
guid - String with the global ID of the object to query on.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MYLEAD_INTERNAL_ERROR
Throws:
MyLeadException - If any error occurs during execution of the request then this Exception is thrown.
See Also:
LeadStringHolder

queryById

public ReturnType queryById(java.lang.String dn,
                            MyLeadParentChildFilterSet hFilter,
                            MyLeadContentFilter cFilter,
                            java.lang.String guid,
                            LeadStringHolder results)
                     throws MyLeadException
Overload of the queryById method for taking a single global ID, but also uses the MyLeadParentChildFilterSet hierarchy filter.

Specified by:
queryById in interface LeadClientIntf
Throws:
MyLeadException

queryByIdXml

public ReturnType queryByIdXml(java.lang.String dn,
                               java.lang.String hFilter,
                               java.lang.String cFilter,
                               QryExclusionHolder[] exclusions,
                               java.lang.String[] guids,
                               LeadStringHolder results)
                        throws MyLeadException
This method is an alternative to queryById where the cFilter has already been wrapped through a call to the wrapFilter method of the MyLeadContentFilter class. The same method name could not be used since it would be an ambiguous signature.

Specified by:
queryByIdXml in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user issuing the query.
hFilter - String with the hierarchy filter - target, full subtree, or an already wrapped MyLeadParentChildFilterSet.
cFilter - String with the XML fragment for a MyLeadContentFilter content filter.
exclusions - Array of QryExclusionHolder instances which contain a node or metadata attribute name and an attribute source if the exclusion is for a metadata attribute.
guids - Array of Strings containing the global IDs of the objects to query on.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MYLEAD_INTERNAL_ERROR
Throws:
MyLeadException - If any error occurs during execution of the request then this Exception is thrown.
See Also:
LeadStringHolder

queryByIdXml

public ReturnType queryByIdXml(java.lang.String dn,
                               java.lang.String hFilter,
                               java.lang.String cFilter,
                               java.lang.String[] guids,
                               LeadStringHolder results)
                        throws MyLeadException
Overload of the queryByIdXml method without the exclusions parameter.

Specified by:
queryByIdXml in interface LeadClientIntf
Throws:
MyLeadException

queryByIdXml

public ReturnType queryByIdXml(java.lang.String dn,
                               java.lang.String hFilter,
                               java.lang.String cFilter,
                               QryExclusionHolder[] exclusions,
                               java.lang.String guid,
                               LeadStringHolder results)
                        throws MyLeadException
Override of the queryByIdXml where there is only a single object parameter.

Specified by:
queryByIdXml in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user issuing the query.
hFilter - String with the hierarchy filter - target or full subtree.
cFilter - String with the XML fragment for a MyLeadContentFilter content filter.
exclusions - Array of QryExclusionHolder instances which contain a node or metadata attribute name and an attribute source if the exclusion is for a metadata attribute.
guid - String with the global ID of the object to query on.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MYLEAD_INTERNAL_ERROR
Throws:
MyLeadException - If any error occurs during execution of the request then this Exception is thrown.
See Also:
LeadStringHolder

queryByIdXml

public ReturnType queryByIdXml(java.lang.String dn,
                               java.lang.String hFilter,
                               java.lang.String cFilter,
                               java.lang.String guid,
                               LeadStringHolder results)
                        throws MyLeadException
Overload of the queryByIdXml method without the exclusions parameter and only a single object guid.

Specified by:
queryByIdXml in interface LeadClientIntf
Throws:
MyLeadException

queryLead

public ReturnType queryLead(java.lang.String dn,
                            int limit,
                            java.lang.String hFilter,
                            java.lang.String cFilter,
                            QryExclusionHolder[] exclusions,
                            MyLeadQuery target,
                            MyLeadContextQuery query,
                            LeadStringHolder results)
                     throws MyLeadException
Query myLEAD based on a target specification for a file, collection, experiment, or project in the context of a query composed of chains of objects that could be contained in the target or objects the target is within. The query consists of one or more chains of objects that are combined conjunctively and/or disjuctively to provide the context for the target specified. Both the target and the query chains can also include criteria for metadata attributes and elements.
The hFilter parameter allows the user to define the hierarchy of data thatis returned. The hFilter options are:
SUBTREE
TARGET
CHILDREN

FULL_SUBTREE For each object meeting the criteria specified for the target, in the context of the query chains, the object and all child objects within that object will be returned.
TARGET will return only the objects that meet the target criteria within the context of the query chains. No subtree of other objects are returned.
CHILDREN will return the objects that are children of the objects meeting the target criteria in the context of the query.
The heirarchy filter determines what objects are returned, but not what is returned for thos objects. The cFilter content filter determines what content is returned for each object identified based on the hierarchy filter. The options for the cFilter are:
FULL_SCHEMA
GUIDONLY
An instance of MyLeadAttributeFilter, or
An instance of MyLeadElementFilter
The last two options for the cFilter are handled by an overloaded version of this function.

As in MCS, the user can specify the number of results they want returned by setting the limit parameter. The limit is the number of targets included. For example, if the FULL_SUBTREE filter is being used, limit is set to 2, and there are 10 objects matching the target criteria in the context of the query, then the full subtree will be returned for the first two objects matching the target.
When the limit is set to zero, all of the results are returned.
The results are returned in the LeadStringHolder that was passed as a parameter.

Specified by:
queryLead in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user issuing the query.
limit - integer that is the number of results that are to be returned.
hFilter - A String containing one of the heirarchy filter options listed.
cFilter - A String containing either the FULL_SCHEMA or GUIDONLY content filter options.
exclusions - Array of QryExclusionHolder instances which contain a node or metadata attribute name and an attribute source if the exclusion is for a metadata attribute.
target - An instance of a class that extends MyLeadQuery with the criteria for the target object and any metadata attributes to be considered. The object will be a file or some type of collection that\ extends the abstract MyLeadQuery class.
query - A MyLeadContextQuery object that provides the context of the target. If this is null, then there is no context specified and only the target is used. This object conntains the chains of objects that the target must contain and/or be within.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MYLEAD_INTERNAL_ERROR
Throws:
MyLeadException - If any error occurs during execution of the request then this Exception is thrown.
See Also:
MyLeadQuery, MyLeadFile, MyLeadCollection, MyLeadExperiment, MyLeadProject, LeadStringHolder, ReturnType

queryLead

public ReturnType queryLead(java.lang.String dn,
                            int limit,
                            MyLeadParentChildFilterSet hFilter,
                            java.lang.String cFilter,
                            QryExclusionHolder[] exclusions,
                            MyLeadQuery target,
                            MyLeadContextQuery query,
                            LeadStringHolder results)
                     throws MyLeadException
This overloaded version of queryLead takes a parent-child hierarchy filter set instead of the constant strings for predefined hierarchies.

Specified by:
queryLead in interface LeadClientIntf
Throws:
MyLeadException

queryLead

public ReturnType queryLead(java.lang.String dn,
                            int limit,
                            java.lang.String hFilter,
                            java.lang.String cFilter,
                            MyLeadQuery target,
                            MyLeadContextQuery query,
                            LeadStringHolder results)
                     throws MyLeadException
Overload of the queryLead method without the exclusions parameter.

Specified by:
queryLead in interface LeadClientIntf
Throws:
MyLeadException

queryLead

public ReturnType queryLead(java.lang.String dn,
                            int limit,
                            MyLeadParentChildFilterSet hFilter,
                            java.lang.String cFilter,
                            MyLeadQuery target,
                            MyLeadContextQuery query,
                            LeadStringHolder results)
                     throws MyLeadException
Overload of the queryLead method without the exclusions parameter but using the parent-child hierarchy filter.

Specified by:
queryLead in interface LeadClientIntf
Throws:
MyLeadException

queryLead

public ReturnType queryLead(java.lang.String dn,
                            int limit,
                            java.lang.String hFilter,
                            MyLeadContentFilter cFilter,
                            MyLeadQuery target,
                            MyLeadContextQuery query,
                            LeadStringHolder results)
                     throws MyLeadException
Overload of the queryLead method that takes a MyLeadContentFilter instance for the content filter.

Specified by:
queryLead in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user issuing the query.
limit - integer that is the number of results that are to be returned.
hFilter - A String containing one of the heirarchy filter options listed.
cFilter - An instance of a class implementing the MyLeadContentFilter interface for the content filter. content filter options.
target - An instance of a class that extends MyLeadQuery with the criteria for the target object and any metadata attributes to be considered. The object will be a file or some type of collection that\ extends the abstract MyLeadQuery class.
query - A MyLeadContextQuery object that provides the context of the target. If this is null, then there is no context specified and only the target is used. This object conntains the chains of objects that the target must contain and/or be within.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MYLEAD_INTERNAL_ERROR
Throws:
MyLeadException - If any error occurs during execution of the request then this Exception is thrown.
See Also:
MyLeadQuery, MyLeadFile, MyLeadCollection, MyLeadExperiment, MyLeadProject, LeadStringHolder, ReturnType

queryLead

public ReturnType queryLead(java.lang.String dn,
                            int limit,
                            MyLeadParentChildFilterSet hFilter,
                            MyLeadContentFilter cFilter,
                            MyLeadQuery target,
                            MyLeadContextQuery query,
                            LeadStringHolder results)
                     throws MyLeadException
Overload of the queryLead method that takes a MyLeadContentFilter instance for the content filter and a MyLeadParentChildFilterSet instance for the hierarchy filter.

Specified by:
queryLead in interface LeadClientIntf
Throws:
MyLeadException

queryLead

public ReturnType queryLead(java.lang.String dn,
                            int limit,
                            java.lang.String hFilter,
                            java.lang.String cFilter,
                            QryExclusionHolder[] exclusions,
                            MyLeadQuery target,
                            LeadStringHolder results)
                     throws MyLeadException
An overloaded version of the queryLead method in which a context is not specified - the query is based only on a target and not the context of that target (parent or child objects).

Specified by:
queryLead in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user issuing the query.
limit - integer that is the number of results that are to be returned.
hFilter - A String containing one of the heirarchy filter options listed.
cFilter - A String containing either the FULL_SCHEMA or GUIDONLY content filter options.
exclusions - Array of QryExclusionHolder instances which contain a node or metadata attribute name and an attribute source if the exclusion is for a metadata attribute.
target - An instance of a class that extends MyLeadQuery with the criteria for the target object and any metadata attributes to be considered. The object will be a file or some type of collection that\ extends the abstract MyLeadQuery class.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MYLEAD_INTERNAL_ERROR
Throws:
MyLeadException - If any error occurs during execution of the request then this Exception is thrown.
See Also:
MyLeadQuery, MyLeadFile, MyLeadCollection, MyLeadExperiment, MyLeadProject, LeadStringHolder

queryLead

public ReturnType queryLead(java.lang.String dn,
                            int limit,
                            MyLeadParentChildFilterSet hFilter,
                            java.lang.String cFilter,
                            QryExclusionHolder[] exclusions,
                            MyLeadQuery target,
                            LeadStringHolder results)
                     throws MyLeadException
An overloaded version of the queryLead method in which a context is not specified, but an instance of MyLeadParentChildFilterSet is used for the hierarchy filter.

Specified by:
queryLead in interface LeadClientIntf
Throws:
MyLeadException

queryLead

public ReturnType queryLead(java.lang.String dn,
                            int limit,
                            java.lang.String hFilter,
                            java.lang.String cFilter,
                            MyLeadQuery target,
                            LeadStringHolder results)
                     throws MyLeadException
Overload of the queryLead method without the exclusions parameter.

Specified by:
queryLead in interface LeadClientIntf
Throws:
MyLeadException

queryLead

public ReturnType queryLead(java.lang.String dn,
                            int limit,
                            MyLeadParentChildFilterSet hFilter,
                            java.lang.String cFilter,
                            MyLeadQuery target,
                            LeadStringHolder results)
                     throws MyLeadException
Overload of the queryLead method without the exclusions parameter, but an instance of MyLeadParentChildFilterSet is used for the hierarchy filter.

Specified by:
queryLead in interface LeadClientIntf
Throws:
MyLeadException

queryLead

public ReturnType queryLead(java.lang.String dn,
                            int limit,
                            java.lang.String hFilter,
                            MyLeadContentFilter cFilter,
                            MyLeadQuery target,
                            LeadStringHolder results)
                     throws MyLeadException
Overload of the queryLead method that takes a MyLeadContentFilter instance for the content filter but specifies no query context.

Specified by:
queryLead in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user issuing the query.
limit - integer that is the number of results that are to be returned.
hFilter - A String containing one of the heirarchy filter options listed.
cFilter - An instance of a class implementing the MyLeadContentFilter interface for the content filter. content filter options.
target - An instance of a class that extends MyLeadQuery with the criteria for the target object and any metadata attributes to be considered. The object will be a file or some type of collection that\ extends the abstract MyLeadQuery class.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MYLEAD_INTERNAL_ERROR
Throws:
MyLeadException - If any error occurs during execution of the request then this Exception is thrown.
See Also:
MyLeadQuery, MyLeadFile, MyLeadCollection, MyLeadExperiment, MyLeadProject, LeadStringHolder, ReturnType

queryLead

public ReturnType queryLead(java.lang.String dn,
                            int limit,
                            MyLeadParentChildFilterSet hFilter,
                            MyLeadContentFilter cFilter,
                            MyLeadQuery target,
                            LeadStringHolder results)
                     throws MyLeadException
Overload of the queryLead method that takes a MyLeadContentFilter instance for the content filter, specifies no query context, and an instance of MyLeadParentChildFilterSet is used for the hierarchy filter.

Specified by:
queryLead in interface LeadClientIntf
Throws:
MyLeadException

queryLeadXml

public ReturnType queryLeadXml(java.lang.String dn,
                               int limit,
                               java.lang.String hFilter,
                               java.lang.String cFilter,
                               QryExclusionHolder[] exclusions,
                               java.lang.String target,
                               java.lang.String query,
                               LeadStringHolder results)
                        throws MyLeadException
This method is an alternative to queryLead where the cFilter, target, and context query have all already been wrapped through a call to the wrapFilter method of the MyLeadContentFilter class for the filter and the wrapParameters and wrapQuery methods respectively for the target and context query. Although this could have been done as an override of the queryLead method, the Xml suffix was added to the method name to be consistent with the queryByIdXml method which also takes the cFilter as a wrapped XML fragment.

Specified by:
queryLeadXml in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user issuing the query.
limit - integer that is the number of results that are to be returned.
hFilter - String containing one of the heirarchy filter options listed. For backward compatibility this parameter is not wrapped as an XML fragment unless it is a MyLeadParentChildFilterSet.
cFilter - String with an XML fragment for a MyLeadContentFilter content filter.
exclusions - Array of QryExclusionHolder instances which contain a node or metadata attribute name and an attribute source if the exclusion is for a metadata attribute.
target - String with an XML fragment for an instance of a class that extends MyLeadQuery with the criteria for the target object and any metadata attributes to be considered. The object will be a file or some type of collection that extends the abstract MyLeadQuery class.
query - Optional String with an XML fragment for a MyLeadContextQuery with the context for the target.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MYLEAD_INTERNAL_ERROR
Throws:
MyLeadException - If any error occurs during execution of the request then this Exception is thrown.
See Also:
MyLeadQuery, MyLeadFile, MyLeadCollection, MyLeadExperiment, MyLeadProject, LeadStringHolder, ReturnType

queryLeadXml

public ReturnType queryLeadXml(java.lang.String dn,
                               int limit,
                               java.lang.String hFilter,
                               java.lang.String cFilter,
                               java.lang.String target,
                               java.lang.String query,
                               LeadStringHolder results)
                        throws MyLeadException
Overload of the queryLeadXml method without the exclusions parameter.

Specified by:
queryLeadXml in interface LeadClientIntf
Throws:
MyLeadException

queryLeadXml

public ReturnType queryLeadXml(java.lang.String dn,
                               int limit,
                               java.lang.String hFilter,
                               java.lang.String cFilter,
                               QryExclusionHolder[] exclusions,
                               java.lang.String target,
                               LeadStringHolder results)
                        throws MyLeadException
Overload of the queryLeadXml method without the context query parameter.

Specified by:
queryLeadXml in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user issuing the query.
limit - integer that is the number of results that are to be returned.
hFilter - String containing one of the heirarchy filter options listed.
cFilter - String with an XML fragment for a MyLeadContentFilter content filter.
exclusions - Array of QryExclusionHolder instances which contain a node or metadata attribute name and an attribute source if the exclusion is for a metadata attribute.
target - String with an XML fragment for an instance of a class that extends MyLeadQuery with the criteria for the target object and any metadata attributes to be considered. The object will be a file or some type of collection that extends the abstract MyLeadQuery class.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MYLEAD_INTERNAL_ERROR
Throws:
MyLeadException - If any error occurs during execution of the request then this Exception is thrown.
See Also:
MyLeadQuery, MyLeadFile, MyLeadCollection, MyLeadExperiment, MyLeadProject, LeadStringHolder, ReturnType

queryLeadXml

public ReturnType queryLeadXml(java.lang.String dn,
                               int limit,
                               java.lang.String hFilter,
                               java.lang.String cFilter,
                               java.lang.String target,
                               LeadStringHolder results)
                        throws MyLeadException
Overload of the queryLeadXml method without the exclusions parameter or query context.

Specified by:
queryLeadXml in interface LeadClientIntf
Throws:
MyLeadException

queryWorkspace

public ReturnType queryWorkspace(java.lang.String dn,
                                 java.lang.String guid,
                                 int limit,
                                 LeadStringHolder results)
                          throws MyLeadException
This method returns the globally unique IDs (GUID) and title for each child of the object whos GUID is passed as a parameter. The object must be accessible by the user identified by the DN parameter.

Specified by:
queryWorkspace in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user issuing the query.
guid - String contianing the globally unique ID (resourceID) of the parent object.
limit - The number of results that are to be returned. 0 is no limit
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MYLEAD_INTERNAL_ERROR
Throws:
MyLeadException - If any error occurs during execution of the request then this Exception is thrown.

queryWorkspace

public ReturnType queryWorkspace(java.lang.String dn,
                                 LeadStringHolder results)
                          throws MyLeadException
This version of queryWorkspace returns the globally unique IDs (GUID) and title for the entire subtree of the highest level in the hierarchy for the user specified by the DN.

Specified by:
queryWorkspace in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user issuing the query.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MYLEAD_INTERNAL_ERROR
Throws:
MyLeadException - If any error occurs during execution of the request then this Exception is thrown.

delete

public ReturnType delete(java.lang.String dn,
                         java.lang.String objectGuid)
                  throws MyLeadException
This method is called to delete an object (file or collection) and the subtree under that object.

Specified by:
delete in interface LeadClientIntf
Parameters:
dn - String with the dn of the user wanting to delete an object
objectGuid - String with the global ID of the object to be deleted. In the LEAD Metadata Schema this is the resourceID.
Returns:
ReturnType that indicates whether the deletion was successful or an error occurred.
Throws:
MyLeadException

create

public ReturnType create(java.lang.String dn,
                         java.lang.String item,
                         java.lang.String objectType)
                  throws MyLeadException
This method adds a file or collection to the myLEAD metadata database.

Specified by:
create in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user adding the object.
item - String with an instance of LEAD schema representing an object (e.g., file or collection).
objectType - String with the type of item parameter. Must match one of the types from mlAggregationType in the mylead_types schema.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL or
ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
ReturnType

create

public ReturnType create(java.lang.String dn,
                         java.lang.String item,
                         java.lang.String objectType,
                         java.lang.String parentGuid)
                  throws MyLeadException
This version of the create method has additional parameters for the global ID of the parent object this item is being added to.

Specified by:
create in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user adding the object.
item - String with an instance of LEAD schema representing an object (e.g., file or collection).
objectType - String with the type of item parameter. Must match one of the types from mlAggregationType in the mylead_types schema.
parentGuid - String with the global ID of the parent object this item is being added to.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL or
ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
ReturnType

create

public ReturnType create(java.lang.String dn,
                         CreateDataHolder[] myLeadHolder)
                  throws MyLeadException
This version of the create method takes an array of CreateDataHolder instances as a parameter instead of a single LEAD schema instance. The CreateDataHolder class is a simple container that has a String variable for a LEAD schema instance along with the object's parent name and type.
If there is more than one instance of an object with the name given for the parent in a user's workspace, then the full path should be given for the parent object.
For example, if adding a file to a collection named 'WRF_Output', and such a collection exists under different experiments, then the path to the parent should be specified, such as:
myProject/myExperiment/WRF_Output
instead of just WRF_Output. If the parent name is ambiguous, then the new object cannot be created.

Specified by:
create in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user adding the object.
myLeadHolder - An array of CreateDataHolder instances. Each instance is a File or Collection to be added.
Returns:
The return type is as follows:
OPERATION_SUCCESSFUL - all objects were inserted successfully.
CREATE_ERRORS - there were some objects rejected - check the log.
DN_DOES_NOT_EXIST - the specified DN is not in the system.
MCS_INTERNAL_ERROR - some error was thrown
Throws:
MyLeadException

addAttribute

public ReturnType addAttribute(java.lang.String dn,
                               java.lang.String objectGuid,
                               java.lang.String item)
                        throws MyLeadException
This method takes a user's dn, the object they wish to add an attribute to, and a LEAD schema fragment containing a node to be added. Must be a valid add attribute node in the schema.

Specified by:
addAttribute in interface LeadClientIntf
Parameters:
dn - Distinguished name of the user adding the attribute.
objectGuid - String with the GUID of the object the attribute belongs to.
item - String containing the LEAD schema fragment
Returns:
ReturnType - Values returned are: ReturnType.OPERATION_SUCCESSFUL or
ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
ReturnType

addAttribute

public ReturnType addAttribute(java.lang.String dn,
                               java.lang.String objectGuid,
                               java.lang.String[] items)
                        throws MyLeadException
This method is an overload of the add attribute. The only difference is that an array of metadata attribute XML fragments can be passed as a parameter instead of passing a single String. However, the activity schema for adding attributes allows multiple attributes to be passed in a single document, so this version just concatenates all of the metadata attributes in the array.

Specified by:
addAttribute in interface LeadClientIntf
Parameters:
dn - Distinguished name of the user adding the attribute.
objectGuid - String with the GUID of the object the attribute belongs to.
items - String array containing the LEAD schema fragments
Returns:
ReturnType - Values returned are: ReturnType.OPERATION_SUCCESSFUL or
ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
ReturnType

addAttribute

public ReturnType addAttribute(java.lang.String dn,
                               CreateAttrHolder[] items)
                        throws MyLeadException
This overload of the addAttributes method takes a user's dn, the object they wish to add an attribute to, and an array of CreateAttrHolder instances. This version allows for a perform doc that can handle adding attributes for multiple objects in a single call (all owned by the same user).

Specified by:
addAttribute in interface LeadClientIntf
Parameters:
dn - Distinguished name of the user adding the attribute.
items - Array of CreateAttrHolder instances.
Returns:
ReturnType - Values returned are: ReturnType.OPERATION_SUCCESSFUL or
ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
ReturnType

updateAttribute

public ReturnType updateAttribute(java.lang.String dn,
                                  java.lang.String objectGuid,
                                  java.lang.String item,
                                  java.lang.Integer position,
                                  java.lang.Long lastUpdate)
                           throws MyLeadException
This method takes a user's dn, the global ID of the object they wish to update, a LEAD sMetadata Schema (LMS) fragment containing the revised node, the position (if a metadata attribute allows for multiple instances), and the timestamp of the data being revised. The node passed as a parameter must be a valid metadata attribute.

Specified by:
updateAttribute in interface LeadClientIntf
Parameters:
dn - Distinguished name of the user adding the attribute.
objectGuid - String with the GUID of the object the metadata attribute belongs to.
item - String containing the LEAD schema fragment.
position - Integer with the position of the item if there are multiple instances. If the metadata attribute passed as the item parameter does not allow for multiple instances, then the position is ignored. Not included in the perform document if null.
lastUpdate - Long with a timestamp indicating the version of the data used to create the update. When query results are returned, they include a timestamp of the last update to each object. This can be passed back as a parameter to this method. If the metadata attribute being updated has a more recent timestamp, then the update is not done. This should be used when displaying data to users and allowing them to update the metadata. If null is passed for the timestamp, then the timestamp will not be included in the perform document and the update will be processed regardless of the timestamp for the metadata attribute being updated. Format of the timestamp is YYYYMMDDHHMMSS where YYYY is 1970 or higher. The Long class is used instead of long so null can be passed as a parameter.
Returns:
ReturnType - Values returned are: ReturnType.OPERATION_SUCCESSFUL or
ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
ReturnType

updateAttribute

public ReturnType updateAttribute(java.lang.String dn,
                                  UpdateAttrHolder[] updates)
                           throws MyLeadException
This version of updateAttribute takes an array of UpdateAttrHolder instances which each contain the specifics for an update. All of the updates in the array must relate to objects owned by the single user identified by the dn parameter.

Specified by:
updateAttribute in interface LeadClientIntf
Parameters:
dn - Distinguished name of the user adding the attribute.
updates - Array of UpdateAttrHolder instances - each containing an attribute update.
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
ReturnType

deleteAttribute

public ReturnType deleteAttribute(java.lang.String dn,
                                  java.lang.String objectGuid,
                                  java.lang.String attrName,
                                  java.lang.String attrSrc,
                                  int[] positions,
                                  java.lang.Long lastUpdate)
                           throws MyLeadException
This activity allows a user to delete a metadata attribute in an object they own - as long as it is a deletable metadata attribute. Some are required attributes with a cardinality of one and can never be deleted. Other attributes may have a cardinality greater than one, but at least one instance is required.
There are two version of the delete - this one takes one or more positions of instances of an attribute which should be deleted. An overload exists for thecase where there is only one position. The other alternative is a range of attribute instances.

Specified by:
deleteAttribute in interface LeadClientIntf
Parameters:
dn - Distinguished name of the user adding the attribute.
objectGuid - String with the GUID of the object the metadata attribute belongs to.
attrName - String with the name of the metadata attribute for which instances will be deleted.
attrSrc - String with the source of the definition for the attribute to be deleted. Each metadata attribute definition is defined by its name and the source of that name. Together, the attrName and attrSrc parameters identify the definition of the metadata attributes and then the positions parameter identifies which instances of that metadata attribute should be deleted.
positions - Array of integers with positions of the attribute instances to be deleted. The first instance is position one.
lastUpdate - Long with a timestamp indicating the version of the data used to decide on the deletion. When query results are returned, they include a timestamp of the last update to each object. This can be passed back as a parameter to this method. If the metadata attribute being deleted has a more recent timestamp, then the deletion is not done. This should be used when displaying data to users and allowing them to delete metadata attributes. Format of the timestamp is YYYYMMDDHHMMSS where YYYY is 1970 or higher.
Returns:
ReturnType - Values returned are: ReturnType.OPERATION_SUCCESSFUL or
ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
ReturnType

deleteAttribute

public ReturnType deleteAttribute(java.lang.String dn,
                                  java.lang.String objectGuid,
                                  java.lang.String attrName,
                                  java.lang.String attrSrc,
                                  int position,
                                  java.lang.Long lastUpdate)
                           throws MyLeadException
Override of the deleteAttribute method which takes a single integer position instead of an array of integer positions.

Specified by:
deleteAttribute in interface LeadClientIntf
Throws:
MyLeadException

deleteAttribute

public ReturnType deleteAttribute(java.lang.String dn,
                                  java.lang.String objectGuid,
                                  java.lang.String attrName,
                                  java.lang.String attrSrc,
                                  int firstPos,
                                  int lastPos,
                                  java.lang.Long lastUpdate)
                           throws MyLeadException
This activity allows a user to delete a metadata attribute in an object they own - as long as it is a deletable metadata attribute. Some are required attributes with a cardinality of one and can never be deleted. Other attributes may have a cardinality greater than one, but at least one instance is required.
There are two version of the delete - this one takes a first and last position for instances of an attribute which should be deleted. The other alternative is a version which takes an array of one or more positions for attribute instances to be deleted.

Specified by:
deleteAttribute in interface LeadClientIntf
Parameters:
dn - Distinguished name of the user adding the attribute.
objectGuid - String with the GUID of the object the metadata attribute belongs to.
attrName - String with the name of the metadata attribute for which instances will be deleted.
attrSrc - String with the source of the definition for the attribute to be deleted. Each metadata attribute definition is defined by its name and the source of that name. Together, the attrName and attrSrc parameters identify the definition of the metadata attributes and then the positions parameter identifies which instances of that metadata attribute should be deleted.
firstPos - int with the position of the first attribute instance to be deleted.
lastPos - int with the position of the last attribute instance to be deleted.
lastUpdate - Long with a timestamp indicating the version of the data used to decide on the deletion. When query results are returned, they include a timestamp of the last update to each object. This can be passed back as a parameter to this method. If the metadata attribute being deleted has a more recent timestamp, then the deletion is not done. This should be used when displaying data to users and allowing them to delete metadata attributes. Format of the timestamp is YYYYMMDDHHMMSS where YYYY is 1970 or higher.
Returns:
ReturnType - Values returned are: ReturnType.OPERATION_SUCCESSFUL or
ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
ReturnType

move

public ReturnType move(java.lang.String dn,
                       java.lang.String objectGuid,
                       java.lang.String newParentGuid)
                throws MyLeadException
This method can be used to move an object from one hierarchy to another. The user who's DN is passed as a parameter must be the owner of the object as well as the owner of the new parent. the object and parent must both already exist, and the parent must be of an object type that it can have the moved object as a child (e.g., a collection in LMS CANNOT have an experiment as a child).

Specified by:
move in interface LeadClientIntf
Parameters:
dn - Distinguished name of the user moving the object.
objectGuid - String with the global ID of the object to be moved.
newParentGuid - String with the global ID of the object's new parent.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
Throws:
MyLeadException - If any error occurs during execution of request this Exception is thrown.

create

public ReturnType create(java.lang.String dn,
                         MyLeadUser user)
                  throws MyLeadException
Overrides the create method to take an instance of a MyLeadUser object to add a user profile to the mcs_writer table.

Specified by:
create in interface LeadClientIntf
Parameters:
dn - The distinguished name of the user adding users.
user - A MyLeadUser object.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL or
ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
MyLeadUser, ReturnType

create

public ReturnType create(java.lang.String dn,
                         MyLeadUser[] users)
                  throws MyLeadException
Overrides the create method to take an array of MyLeadUser objects to add user profiles to the mcs_writer table.

Specified by:
create in interface LeadClientIntf
Parameters:
dn - The distinguished name of the user adding users.
users - An array of MyLeadUser objects.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL or
ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
MyLeadUser, ReturnType

update

public ReturnType update(java.lang.String dn,
                         MyLeadUser user)
                  throws MyLeadException
This method takes an instance of MyLeadUser which is used to update an existing myLEAD user profile in the mcs_writer table.

Specified by:
update in interface LeadClientIntf
Parameters:
dn - Distinguished name of user requesting the change.
user - A MyLeadUser object.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL or
ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
MyLeadUser, ReturnType

update

public ReturnType update(java.lang.String dn,
                         MyLeadUser[] users)
                  throws MyLeadException
Overrides the update method to take an array of MyLeadUser objects to update user profiles in the mcs_writer table.

Specified by:
update in interface LeadClientIntf
Parameters:
dn - The distinguished name of the user adding users.
users - An array of MyLeadUser objects.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL or
ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
MyLeadUser, ReturnType

deleteUser

public ReturnType deleteUser(java.lang.String dn,
                             java.lang.String userDn)
                      throws MyLeadException
This method is called to delete a user and all of their objects from the catalog. The dn of the user making the call must have rights to delete a user.

Specified by:
deleteUser in interface LeadClientIntf
Parameters:
dn - String with distingushed name of the user making the request to delete.
userDn - String with the DN of the user to be deleted.
Returns:
ReturnType indicates whether the deletion was successful.
Throws:
MyLeadException

queryUser

public ReturnType queryUser(java.lang.String dn,
                            LeadStringHolder results)
                     throws MyLeadException
Passed the distinguished name (dn) of the user and returns information regarding the myLEAD profile for that user in the mcs_writer table. If an asterisk is passed as the dn, then information regarding all users is returned.

Specified by:
queryUser in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL, or
ReturnType.NO_RESULTS_FOUND
Throws:
MyLeadException - If an error occurs during execution of request then this Exception is thrown.
See Also:
LeadStringHolder, ReturnType

create

public ReturnType create(java.lang.String dn,
                         MyLeadReplica replica)
                  throws MyLeadException
Overrides the create method to take an instance of MyLeadReplica which is used to add a new record for a myLEAD replica to the database.

Specified by:
create in interface LeadClientIntf
Parameters:
replica - A MyLeadReplica object.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL or
ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
MyLeadReplica, ReturnType

create

public ReturnType create(java.lang.String dn,
                         MyLeadReplica[] replicas)
                  throws MyLeadException
Overrides the create method to take an instance of MyLeadReplica which is used to add a new record for a myLEAD replica to the database.

Specified by:
create in interface LeadClientIntf
Parameters:
replicas - An array of MyLeadReplica objects.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL or
ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
MyLeadReplica, ReturnType

update

public ReturnType update(java.lang.String dn,
                         MyLeadReplica replica)
                  throws MyLeadException
This method takes an instance of MyLeadReplica which is used to update an existing myLEAD replica definition in the database based on the nickname.

Specified by:
update in interface LeadClientIntf
Parameters:
dn - Distinguished name of user requesting the change
replica - A MyLeadReplica object.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL, or ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
MyLeadReplica, ReturnType

update

public ReturnType update(java.lang.String dn,
                         MyLeadReplica[] replicas)
                  throws MyLeadException
This method takes an array of MyLeadReplica instances which are used to update existing myLEAD replica definitions in the database based on the nickname.

Specified by:
update in interface LeadClientIntf
Parameters:
dn - Distinguished name of user requesting the change
replicas - An array of MyLeadReplica objects.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL, or ReturnType.AUTHORIZATION_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
MyLeadReplica, ReturnType

deleteReplica

public ReturnType deleteReplica(java.lang.String dn,
                                java.lang.String nickName)
                         throws MyLeadException
This method is called to delete the definition for a myLEAD replica.

Specified by:
deleteReplica in interface LeadClientIntf
Throws:
MyLeadException

deleteReplica

public ReturnType deleteReplica(java.lang.String dn,
                                java.lang.String[] nickNames)
                         throws MyLeadException
This method is called to delete the definition for multiple myLEAD replicas.

Specified by:
deleteReplica in interface LeadClientIntf
Throws:
MyLeadException

queryReplica

public ReturnType queryReplica(java.lang.String dn,
                               LeadStringHolder results)
                        throws MyLeadException
Passed the distinguished name (dn) of the user and returns information regarding the myLEAD replica that user is assigned to in the mcs_writer table. If an asterisk is passed as the dn, then information regarding all replicas is returned.

Specified by:
queryReplica in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL, or
ReturnType.NO_RESULTS_FOUND
Throws:
MyLeadException - If an error occurs during execution of request this Exception is thrown.
See Also:
LeadStringHolder, ReturnType

attributeDef

public ReturnType attributeDef(java.lang.String dn,
                               LeadStringHolder results)
                        throws MyLeadException
Returns an XML fragment containing the attributes and elements defined in the mcs_lead database for myLEAD.

Specified by:
attributeDef in interface LeadClientIntf
Parameters:
dn - String with the distinguished name of the user executing the query.
results - A LeadStringHolder in which an XML fragment is returned with the results.
Returns:
ReturnType - Values returned are:
ReturnType.OPERATION_SUCCESSFUL,
ReturnType.NO_RESULTS_FOUND, or
ReturnType.MCS_INTERNAL_ERROR
Throws:
MyLeadException - If an error occurs during execution of the request then this Exception is thrown.
See Also:
ReturnType

getServiceUrl

public java.lang.String getServiceUrl()
Returns the endpoint url of the service that is currently being accessed. This method is the same as in MCSClient.

Specified by:
getServiceUrl in interface LeadClientIntf
Returns:
String

setAuthentication

public void setAuthentication(boolean authentic)
Allows you to make an authenticated connection to the myLEAD service. This method is the same as in MCSClient.

Specified by:
setAuthentication in interface LeadClientIntf
Parameters:
authentic - if true the authentication is set and you will require a valid proxy to use the authentication. if false then authentication is removed.

isAuthenticated

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

Specified by:
isAuthenticated in interface LeadClientIntf
Returns:
boolean - Values returned are:
true - if the client is working in authenticated mode
false - if the client is working in non authenticated mode

close

public void close()
           throws MyLeadException
Closes the grid service connection and destroys the service instance. This method is the same as in MCSClient.

Specified by:
close in interface LeadClientIntf
Throws:
MyLeadException - If any error occurs during closing the service instance this Exception is thrown.

finalize

protected void finalize()
Overrides:
finalize in class java.lang.Object