org.kepler.objectmanager.repository

Class EcogridRepository

java.lang.Object

org.kepler.objectmanager.repository.Repository

org.kepler.objectmanager.repository.EcogridRepository

public class EcogridRepository
extends Repository

This class represents an ecogrid repository

Author:

Chad Berkley

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EcogridRepository.RegistryClientContainer a class to hold a registry client and a sessionid

Field Summary

Fields inherited from class org.kepler.objectmanager.repository.Repository

authDomain, authenticatedQueryPath, authorizationPath, authProtocol, includeInSave, includeInSearch, lsidAuthority, lsidPath, name, putPath, queryPath, registry, registryauth, repository

Constructor Summary

Constructors

Constructor and Description
EcogridRepository(java.lang.String name, java.lang.String repository, java.lang.String putPath, java.lang.String authDomain, java.lang.String lsidPath, java.lang.String queryPath, java.lang.String authenticatedQueryPath, java.lang.String authorizationPath, java.lang.String registry, java.lang.String registryauth, java.lang.String authProtocol, java.lang.String lsidAuthority)

Method Summary

Modifier and Type	Method and Description
KeplerLSID	addRegistryEntry(org.ecoinformatics.ecogrid.registry.stub.RegistryEntryType registryEntry, java.lang.String sessionId) add an ecogrid registry entry.
java.util.Iterator<EcogridRepositoryResults>	advancedSearch(java.io.Reader queryDocument, boolean authenticate) Search the repository and return an iterator of EcogridRepositoryResults.
org.ecoinformatics.ecogrid.queryservice.resultset.ResultsetType	arbitrarySearch(java.io.Reader queryDocument, boolean authenticate) Search the repository using queryDocument.
java.io.InputStream	get(KeplerLSID lsid, boolean authenticate) return the object from the repository that has the given lsid
java.io.InputStream	get(java.lang.String docid, boolean authenticate) return an object using a ecogrid docid identifier
java.lang.String	getAuthorizationServerURL() Get the url for the authorization service associated with this repository
static KarXml	getKarXml(java.lang.String docid, java.lang.String repositoryName, boolean authenticate) Return karXml for a docid from a repositoryName.
java.lang.String	getLSIDServerURL() return the url for the lsid service associated with this repository
java.lang.String	getNextObject(KeplerLSID lsid) returns the next object for the given lsid
java.lang.String	getNextRevision(KeplerLSID lsid) returns the next revision for the given lsid
java.lang.String	loginRegEcoGrid(java.lang.String userName, java.lang.String password) login to the registry
void	put(java.lang.Object o, KeplerLSID lsid, java.lang.String sessionId) put a file with a predetermined sessionid
void	removeRegistryEntry(KeplerLSID lsid, java.lang.String sessionId) remove an ecogrid registry entry.
java.util.Iterator<EcogridRepositoryResults>	search(java.lang.String queryString, boolean authenticate) Search the repository and return an iterator of EcogridRepositoryResults.
void	updateRegistryEntry(java.lang.String registryEntry, KeplerLSID lsid) update an ecogrid registry entry.

Methods inherited from class org.kepler.objectmanager.repository.Repository

getAuthDomain, getAuthenticatedQueryPath, getAuthorizationPath, getAuthProtocol, getLsidAuthority, getLSIDPath, getName, getPutPath, getQueryPath, getRegistry, getRepository, includeInSave, includeInSearch, setIncludeInSave, setIncludeInSearch, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EcogridRepository

public EcogridRepository(java.lang.String name,
                         java.lang.String repository,
                         java.lang.String putPath,
                         java.lang.String authDomain,
                         java.lang.String lsidPath,
                         java.lang.String queryPath,
                         java.lang.String authenticatedQueryPath,
                         java.lang.String authorizationPath,
                         java.lang.String registry,
                         java.lang.String registryauth,
                         java.lang.String authProtocol,
                         java.lang.String lsidAuthority)

Method Detail

getLSIDServerURL

public java.lang.String getLSIDServerURL()

return the url for the lsid service associated with this repository

Specified by:

getLSIDServerURL in class Repository

getAuthorizationServerURL

public java.lang.String getAuthorizationServerURL()

Get the url for the authorization service associated with this repository

Returns:

search

public java.util.Iterator<EcogridRepositoryResults> search(java.lang.String queryString,
                                                           boolean authenticate)
                                                    throws RepositoryException,
                                                           AuthenticationException

Search the repository and return an iterator of EcogridRepositoryResults.

Specified by:

search in class Repository

Parameters:

queryString - a string to search for

authenticate - boolean

Returns:

null if there are no results for the query. An iterator of EcogridRepositoryResults if there are results.

Throws:

AuthenticationException

RepositoryException

See Also:

EcogridRepositoryResults

advancedSearch

public java.util.Iterator<EcogridRepositoryResults> advancedSearch(java.io.Reader queryDocument,
                                                                   boolean authenticate)
                                                            throws RepositoryException,
                                                                   AuthenticationException

Search the repository and return an iterator of EcogridRepositoryResults.

Parameters:

queryDocument - - the query document to give the QueryServiceClient

Returns:

Throws:

RepositoryException

AuthenticationException

arbitrarySearch

public org.ecoinformatics.ecogrid.queryservice.resultset.ResultsetType arbitrarySearch(java.io.Reader queryDocument,
                                                                                       boolean authenticate)
                                                                                throws RepositoryException,
                                                                                       AuthenticationException

Search the repository using queryDocument.

Parameters:

queryDocument -

authenticate -

Returns:

ResultsetType, or null

Throws:

RepositoryException

AuthenticationException

get

public java.io.InputStream get(java.lang.String docid,
                               boolean authenticate)
                        throws RepositoryException,
                               AuthenticationException

return an object using a ecogrid docid identifier

Specified by:

get in class Repository

Throws:

AuthenticationException

RepositoryException

getKarXml

public static KarXml getKarXml(java.lang.String docid,
                               java.lang.String repositoryName,
                               boolean authenticate)
                        throws RepositoryException

Return karXml for a docid from a repositoryName. Move this method to another class if you can think of a better home.

Parameters:

docid -

repositoryName -

Returns:

Throws:

RepositoryException

get

public java.io.InputStream get(KeplerLSID lsid,
                               boolean authenticate)
                        throws RepositoryException,
                               AuthenticationException

return the object from the repository that has the given lsid

Specified by:

get in class Repository

Throws:

AuthenticationException

RepositoryException

put

public void put(java.lang.Object o,
                KeplerLSID lsid,
                java.lang.String sessionId)
         throws RepositoryException

put a file with a predetermined sessionid

Specified by:

put in class Repository

Throws:

RepositoryException

getNextObject

public java.lang.String getNextObject(KeplerLSID lsid)
                               throws RepositoryException

returns the next object for the given lsid

Parameters:

lsid - the lsid to get the next object for

Throws:

RepositoryException

getNextRevision

public java.lang.String getNextRevision(KeplerLSID lsid)
                                 throws RepositoryException

returns the next revision for the given lsid

Parameters:

lsid - the lsid to get the next revision for

Throws:

RepositoryException

addRegistryEntry

public KeplerLSID addRegistryEntry(org.ecoinformatics.ecogrid.registry.stub.RegistryEntryType registryEntry,
                                   java.lang.String sessionId)
                            throws RepositoryException

add an ecogrid registry entry.

Parameters:

registryEntry - an xml file that conforms to seek/project/ecogrid/src/xsd_reg/RegistryEntryType.xsd

sessionid - the session id to use to authenticate

Throws:

RepositoryException

updateRegistryEntry

public void updateRegistryEntry(java.lang.String registryEntry,
                                KeplerLSID lsid)
                         throws RepositoryException

update an ecogrid registry entry.

Parameters:

registryEntry - an xml file that conforms to seek/project/ecogrid/src/xsd_reg/RegistryEntryType.xsd

lsid - the id of the entry

sessionid - the session id to use to authenticate

Throws:

RepositoryException

removeRegistryEntry

public void removeRegistryEntry(KeplerLSID lsid,
                                java.lang.String sessionId)
                         throws RepositoryException

remove an ecogrid registry entry.

Parameters:

lsid - the id of the entry

sessionid - the session id to use to authenticate

Throws:

RepositoryException

loginRegEcoGrid

public java.lang.String loginRegEcoGrid(java.lang.String userName,
                                        java.lang.String password)
                                 throws java.lang.Exception

login to the registry

Throws:

java.lang.Exception