org.kepler.objectmanager.repository

Class Repository

java.lang.Object

org.kepler.objectmanager.repository.Repository

Direct Known Subclasses:

EcogridRepository

public abstract class Repository
extends java.lang.Object

This interface represents a repository on the ecogrid

Author:

Chad Berkley

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	authDomain
protected java.lang.String	authenticatedQueryPath
protected java.lang.String	authorizationPath
protected java.lang.String	authProtocol
protected boolean	includeInSave
protected boolean	includeInSearch
protected java.lang.String	lsidAuthority
protected java.lang.String	lsidPath
protected java.lang.String	name
protected java.lang.String	putPath
protected java.lang.String	queryPath
protected java.lang.String	registry
protected java.lang.String	registryauth
protected java.lang.String	repository

Constructor Summary

Constructors

Constructor and Description
Repository(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) constructor

Method Summary

Modifier and Type	Method and Description
abstract java.io.InputStream	get(KeplerLSID lsid, boolean authenticate) return the object from the repository that has the given lsid
abstract java.io.InputStream	get(java.lang.String id, boolean authenticate) get method with a string id
java.lang.String	getAuthDomain() return the authentication service path
java.lang.String	getAuthenticatedQueryPath() return the authenticated query service path
java.lang.String	getAuthorizationPath() return the authorization service path
java.lang.String	getAuthProtocol() return the protocol of the authentication
java.lang.String	getLsidAuthority()
java.lang.String	getLSIDPath() return the lsid service path
abstract java.lang.String	getLSIDServerURL() get the url for the lsid service associated with this repository
java.lang.String	getName() get the name of the repository
java.lang.String	getPutPath() return the put service path
java.lang.String	getQueryPath() return the query service path
java.lang.String	getRegistry() get the registry of the repository
java.lang.String	getRepository() get the repository url
boolean	includeInSave() If the repository is included in saving process
boolean	includeInSearch()
abstract void	put(java.lang.Object o, KeplerLSID lsid, java.lang.String sessionid) put an object into the repository with a predetermined sessionid
abstract java.util.Iterator	search(java.lang.String queryString, boolean authenticate) Search the repository and return an iterator of results (the Iterator contains KeplerLSIDs of matched items).
void	setIncludeInSave(boolean includeInSave) Set the repository to be included in saving process or not
void	setIncludeInSearch(boolean includeInSearch)
java.lang.String	toString() return a string rep of this object for debug purposes

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

repository

protected java.lang.String repository

putPath

protected java.lang.String putPath

authDomain

protected java.lang.String authDomain

queryPath

protected java.lang.String queryPath

authenticatedQueryPath

protected java.lang.String authenticatedQueryPath

authorizationPath

protected java.lang.String authorizationPath

lsidPath

protected java.lang.String lsidPath

registry

protected java.lang.String registry

registryauth

protected java.lang.String registryauth

authProtocol

protected java.lang.String authProtocol

lsidAuthority

protected java.lang.String lsidAuthority

includeInSearch

protected boolean includeInSearch

includeInSave

protected boolean includeInSave

Constructor Detail

Repository

public Repository(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)

constructor

Parameters:

repository - the address of the repository

username - the username of the repository

password - the password for the repository

authProtocol - protocol (http or https for the repository)

Method Detail

search

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

Search the repository and return an iterator of results (the Iterator contains KeplerLSIDs of matched items).

Throws:

AuthenticationException

RepositoryException

get

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

return the object from the repository that has the given lsid

Throws:

AuthenticationException

RepositoryException

get

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

get method with a string id

Throws:

AuthenticationException

RepositoryException

put

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

put an object into the repository with a predetermined sessionid

Throws:

RepositoryException

getLSIDServerURL

public abstract java.lang.String getLSIDServerURL()

get the url for the lsid service associated with this repository

getRepository

public java.lang.String getRepository()

get the repository url

getName

public java.lang.String getName()

get the name of the repository

getRegistry

public java.lang.String getRegistry()

get the registry of the repository

getAuthDomain

public java.lang.String getAuthDomain()

return the authentication service path

getPutPath

public java.lang.String getPutPath()

return the put service path

getQueryPath

public java.lang.String getQueryPath()

return the query service path

getAuthenticatedQueryPath

public java.lang.String getAuthenticatedQueryPath()

return the authenticated query service path

getLSIDPath

public java.lang.String getLSIDPath()

return the lsid service path

getAuthorizationPath

public java.lang.String getAuthorizationPath()

return the authorization service path

getAuthProtocol

public java.lang.String getAuthProtocol()

return the protocol of the authentication

getLsidAuthority

public java.lang.String getLsidAuthority()

includeInSearch

public boolean includeInSearch()

setIncludeInSearch

public void setIncludeInSearch(boolean includeInSearch)

includeInSave

public boolean includeInSave()

If the repository is included in saving process

Returns:

true if it is included in saving process

setIncludeInSave

public void setIncludeInSave(boolean includeInSave)

Set the repository to be included in saving process or not

Parameters:

includeInSave - true if the repository should be included

toString

public java.lang.String toString()

return a string rep of this object for debug purposes

Overrides:

toString in class java.lang.Object