org.eaglei.datatools.jena
Class RESTRepositoryProvider

java.lang.Object
  org.eaglei.datatools.jena.RESTRepositoryProvider

All Implemented Interfaces:

CrudProvider, DatatoolsSecurityProvider, InstanceProvider, QueryProvider, RepositoryProvider, WorkFlowProvider

public final class RESTRepositoryProvider
extends java.lang.Object
implements RepositoryProvider

Author:

Ricardo De Lima, Lucy Hadden, Daniela Bourges April 11, 2010 Center for Biomedical Informatics (CBMI)

Field Summary

static java.lang.String	LABEL_QUERY_FAILED
protected static java.lang.String	READ_VIEW

Fields inherited from interface org.eaglei.datatools.provider.CrudProvider

DEFAULT_WORKSPACE_ENTITY

Constructor Summary

RESTRepositoryProvider(DatatoolsConfiguration config, org.eaglei.model.jena.JenaEIInstanceFactory instanceFactory)

Method Summary

java.util.List<org.eaglei.model.EIURI>	claim(org.eaglei.security.Session session, java.util.List<org.eaglei.model.EIURI> uris)
void	createInstance(org.eaglei.security.Session session, org.eaglei.model.EIInstance instance, org.eaglei.model.EIEntity workspaceEntity)
void	createInstance(org.eaglei.security.Session session, java.lang.String rdfString, java.lang.String instanceUri, org.eaglei.model.EIEntity workspaceEntity)
org.eaglei.model.EIInstance	deepCopy(org.eaglei.security.Session session, org.eaglei.model.EIURI originalUri)
void	deleteInstance(org.eaglei.security.Session session, org.eaglei.model.EIURI instanceUri)
org.eaglei.model.EIInstance	duplicateInstance(org.eaglei.security.Session session, org.eaglei.model.EIInstance original)
java.util.List<org.eaglei.model.EIInstanceMinimal>	EIQuery(org.eaglei.security.Session session, java.lang.String sparql)
java.lang.String	fakeWorkflowClaim(org.eaglei.security.Session session, org.eaglei.model.EIURI uri, java.lang.String claimant) Deprecated.
java.lang.String[]	fakeWorkflowGetWFStates(org.eaglei.security.Session session) Deprecated.
java.util.List<org.eaglei.model.EIURI>	fakeWorkflowGetWFStatesList(org.eaglei.security.Session session) Deprecated.
java.lang.String	fakeWorkflowPromote(org.eaglei.security.Session session, org.eaglei.model.EIURI uri, org.eaglei.model.EIURI newState) Deprecated.
org.eaglei.model.EIInstance	getEmptyEIInstance(org.eaglei.security.Session session, org.eaglei.model.EIURI classUri)
org.eaglei.model.EIInstance	getEmptyEIInstance(org.eaglei.security.Session session, org.eaglei.model.EIURI classUri, org.eaglei.model.EIEntity instanceEntity)
java.util.List<org.eaglei.model.EIInstanceMinimal>	getFilterQuery(org.eaglei.security.Session session, org.eaglei.model.EIURI classUri, org.eaglei.model.EIURI state, org.eaglei.model.EIURI lab) Deprecated.
java.util.List<org.eaglei.model.EIInstanceMinimal>	getFilterQuery(org.eaglei.security.Session session, org.eaglei.model.EIURI classUri, org.eaglei.model.EIURI state, org.eaglei.model.EIURI lab, boolean strictOwnerFilter) Deprecated.
org.eaglei.model.EIInstance	getInstance(org.eaglei.security.Session session, org.eaglei.model.EIURI instanceID)
org.eaglei.model.EIInstance	getInstanceWithWorkflowState(org.eaglei.security.Session session, org.eaglei.model.EIURI instanceUri)
java.util.Map<org.eaglei.model.EIURI,java.lang.String>	getModifiedDates(org.eaglei.security.Session session, java.util.List<org.eaglei.model.EIURI> uris)
java.util.List<org.eaglei.model.EIURI>	getNewInstanceID(org.eaglei.security.Session session, int count)
java.util.List<Workspace>	getWorkspaces(org.eaglei.security.Session session)
boolean	isOnline()
java.util.List<org.eaglei.model.EIInstanceMinimal>	listReferencingResources(org.eaglei.security.Session session, org.eaglei.model.EIURI resourceUri, org.eaglei.search.provider.AuthSearchRequest queryRequest, SortByProperties orderBy, boolean strictOwnerFilter)
java.util.List<org.eaglei.model.EIInstanceMinimal>	listResources(org.eaglei.security.Session session, org.eaglei.search.provider.AuthSearchRequest queryRequest, SortByProperties orderBy, boolean strictOwnerFilter)
java.util.List<WorkFlowTransition>	listWorkFlowTransitions(org.eaglei.security.Session session, org.eaglei.model.EIEntity workspaceEntity) Returns the list of WorkFlowTransion objects
User	login(java.lang.String userName, java.lang.String password)
void	logout(org.eaglei.security.Session session)
java.lang.String	query(org.eaglei.security.Session session, java.lang.String sparql)
java.util.List<org.eaglei.model.EIInstanceMinimal>	referencedByQuery(org.eaglei.security.Session session, org.eaglei.model.EIURI resourceUri, boolean strictOwnerFilter) Deprecated.
java.util.List<org.eaglei.model.EIURI>	release(org.eaglei.security.Session session, java.util.List<org.eaglei.model.EIURI> uris)
java.lang.String	retrieveLabel(org.eaglei.security.Session session, org.eaglei.model.EIURI uri)
protected void	setReadParameters(org.apache.commons.httpclient.methods.PostMethod method)
protected void	setWriteParameters(org.apache.commons.httpclient.methods.PostMethod method, java.lang.String id)
java.util.List<org.eaglei.model.EIURI>	transition(org.eaglei.security.Session session, java.util.List<org.eaglei.model.EIURI> uris, org.eaglei.model.EIEntity transitionEntity)
java.lang.String	updateInstance(org.eaglei.security.Session session, org.eaglei.model.EIInstance instance, java.lang.String token)
java.lang.String	updateInstance(org.eaglei.security.Session session, java.lang.String rdfString, java.lang.String instanceUri, java.lang.String token)
void	uploadInstances(org.eaglei.security.Session session, java.lang.String rdf) Deprecated.
User	whoami(org.eaglei.security.Session session)

Methods inherited from class java.lang.Object

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

Field Detail

READ_VIEW

protected static final java.lang.String READ_VIEW

See Also:

Constant Field Values

LABEL_QUERY_FAILED

public static final java.lang.String LABEL_QUERY_FAILED

See Also:

Constant Field Values

Constructor Detail

RESTRepositoryProvider

public RESTRepositoryProvider(DatatoolsConfiguration config,
                              org.eaglei.model.jena.JenaEIInstanceFactory instanceFactory)
                       throws java.io.IOException

Throws:

java.io.IOException

Method Detail

setWriteParameters

protected void setWriteParameters(org.apache.commons.httpclient.methods.PostMethod method,
                                  java.lang.String id)

setReadParameters

protected void setReadParameters(org.apache.commons.httpclient.methods.PostMethod method)

createInstance

public void createInstance(org.eaglei.security.Session session,
                           org.eaglei.model.EIInstance instance,
                           org.eaglei.model.EIEntity workspaceEntity)
                    throws java.lang.Exception

Specified by:

createInstance in interface CrudProvider

Throws:

java.lang.Exception

createInstance

public void createInstance(org.eaglei.security.Session session,
                           java.lang.String rdfString,
                           java.lang.String instanceUri,
                           org.eaglei.model.EIEntity workspaceEntity)
                    throws java.lang.Exception

Throws:

java.lang.Exception

deepCopy

public org.eaglei.model.EIInstance deepCopy(org.eaglei.security.Session session,
                                            org.eaglei.model.EIURI originalUri)
                                     throws java.lang.Exception

Specified by:

deepCopy in interface CrudProvider

Throws:

java.lang.Exception

duplicateInstance

public org.eaglei.model.EIInstance duplicateInstance(org.eaglei.security.Session session,
                                                     org.eaglei.model.EIInstance original)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

deleteInstance

public void deleteInstance(org.eaglei.security.Session session,
                           org.eaglei.model.EIURI instanceUri)
                    throws java.lang.Exception

Specified by:

deleteInstance in interface CrudProvider

Throws:

java.lang.Exception

updateInstance

public java.lang.String updateInstance(org.eaglei.security.Session session,
                                       org.eaglei.model.EIInstance instance,
                                       java.lang.String token)
                                throws java.lang.Exception

Specified by:

updateInstance in interface CrudProvider

Throws:

java.lang.Exception

updateInstance

public java.lang.String updateInstance(org.eaglei.security.Session session,
                                       java.lang.String rdfString,
                                       java.lang.String instanceUri,
                                       java.lang.String token)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getInstance

public org.eaglei.model.EIInstance getInstance(org.eaglei.security.Session session,
                                               org.eaglei.model.EIURI instanceID)
                                        throws java.lang.Exception

Specified by:

getInstance in interface InstanceProvider

Throws:

java.lang.Exception

getNewInstanceID

public java.util.List<org.eaglei.model.EIURI> getNewInstanceID(org.eaglei.security.Session session,
                                                               int count)
                                                        throws java.lang.Exception

Specified by:

getNewInstanceID in interface CrudProvider

Throws:

java.lang.Exception

getWorkspaces

public java.util.List<Workspace> getWorkspaces(org.eaglei.security.Session session)
                                        throws java.lang.Exception

Specified by:

getWorkspaces in interface DatatoolsSecurityProvider

Throws:

java.lang.Exception

login

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

Specified by:

login in interface DatatoolsSecurityProvider

Throws:

java.lang.Exception

logout

public void logout(org.eaglei.security.Session session)
            throws java.lang.Exception

Specified by:

logout in interface DatatoolsSecurityProvider

Throws:

java.lang.Exception

whoami

public User whoami(org.eaglei.security.Session session)
            throws java.lang.Exception

Specified by:

whoami in interface DatatoolsSecurityProvider

Throws:

java.lang.Exception

getEmptyEIInstance

public org.eaglei.model.EIInstance getEmptyEIInstance(org.eaglei.security.Session session,
                                                      org.eaglei.model.EIURI classUri,
                                                      org.eaglei.model.EIEntity instanceEntity)
                                               throws java.lang.Exception

Specified by:

getEmptyEIInstance in interface CrudProvider

Throws:

java.lang.Exception

getEmptyEIInstance

public org.eaglei.model.EIInstance getEmptyEIInstance(org.eaglei.security.Session session,
                                                      org.eaglei.model.EIURI classUri)
                                               throws java.lang.Exception

Specified by:

getEmptyEIInstance in interface CrudProvider

Throws:

java.lang.Exception

isOnline

public boolean isOnline()

Specified by:

isOnline in interface DatatoolsSecurityProvider

query

public java.lang.String query(org.eaglei.security.Session session,
                              java.lang.String sparql)
                       throws java.lang.Exception

Specified by:

query in interface QueryProvider

Throws:

java.lang.Exception

EIQuery

public java.util.List<org.eaglei.model.EIInstanceMinimal> EIQuery(org.eaglei.security.Session session,
                                                                  java.lang.String sparql)
                                                           throws java.lang.Exception

Specified by:

EIQuery in interface QueryProvider

Throws:

java.lang.Exception

getFilterQuery

@Deprecated
public java.util.List<org.eaglei.model.EIInstanceMinimal> getFilterQuery(org.eaglei.security.Session session,
                                                                                    org.eaglei.model.EIURI classUri,
                                                                                    org.eaglei.model.EIURI state,
                                                                                    org.eaglei.model.EIURI lab)
                                                                  throws java.lang.Exception

Deprecated.

Specified by:

getFilterQuery in interface QueryProvider

Throws:

java.lang.Exception

getFilterQuery

@Deprecated
public java.util.List<org.eaglei.model.EIInstanceMinimal> getFilterQuery(org.eaglei.security.Session session,
                                                                                    org.eaglei.model.EIURI classUri,
                                                                                    org.eaglei.model.EIURI state,
                                                                                    org.eaglei.model.EIURI lab,
                                                                                    boolean strictOwnerFilter)
                                                                  throws java.lang.Exception

Deprecated.

Specified by:

getFilterQuery in interface QueryProvider

Throws:

java.lang.Exception

referencedByQuery

@Deprecated
public java.util.List<org.eaglei.model.EIInstanceMinimal> referencedByQuery(org.eaglei.security.Session session,
                                                                                       org.eaglei.model.EIURI resourceUri,
                                                                                       boolean strictOwnerFilter)
                                                                     throws java.lang.Exception

Deprecated.

Specified by:

referencedByQuery in interface QueryProvider

Throws:

java.lang.Exception

uploadInstances

@Deprecated
public void uploadInstances(org.eaglei.security.Session session,
                                       java.lang.String rdf)
                     throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

fakeWorkflowClaim

@Deprecated
public java.lang.String fakeWorkflowClaim(org.eaglei.security.Session session,
                                                     org.eaglei.model.EIURI uri,
                                                     java.lang.String claimant)
                                   throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

fakeWorkflowPromote

@Deprecated
public java.lang.String fakeWorkflowPromote(org.eaglei.security.Session session,
                                                       org.eaglei.model.EIURI uri,
                                                       org.eaglei.model.EIURI newState)
                                     throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

fakeWorkflowGetWFStatesList

@Deprecated
public java.util.List<org.eaglei.model.EIURI> fakeWorkflowGetWFStatesList(org.eaglei.security.Session session)
                                                                   throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

fakeWorkflowGetWFStates

@Deprecated
public java.lang.String[] fakeWorkflowGetWFStates(org.eaglei.security.Session session)
                                           throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

retrieveLabel

public java.lang.String retrieveLabel(org.eaglei.security.Session session,
                                      org.eaglei.model.EIURI uri)
                               throws java.lang.Exception

Specified by:

retrieveLabel in interface QueryProvider

Throws:

java.lang.Exception

listResources

public java.util.List<org.eaglei.model.EIInstanceMinimal> listResources(org.eaglei.security.Session session,
                                                                        org.eaglei.search.provider.AuthSearchRequest queryRequest,
                                                                        SortByProperties orderBy,
                                                                        boolean strictOwnerFilter)
                                                                 throws java.lang.Exception

Specified by:

listResources in interface WorkFlowProvider

Throws:

java.lang.Exception

listReferencingResources

public java.util.List<org.eaglei.model.EIInstanceMinimal> listReferencingResources(org.eaglei.security.Session session,
                                                                                   org.eaglei.model.EIURI resourceUri,
                                                                                   org.eaglei.search.provider.AuthSearchRequest queryRequest,
                                                                                   SortByProperties orderBy,
                                                                                   boolean strictOwnerFilter)
                                                                            throws java.lang.Exception

Specified by:

listReferencingResources in interface WorkFlowProvider

Throws:

java.lang.Exception

getInstanceWithWorkflowState

public org.eaglei.model.EIInstance getInstanceWithWorkflowState(org.eaglei.security.Session session,
                                                                org.eaglei.model.EIURI instanceUri)
                                                         throws java.lang.Exception

Specified by:

getInstanceWithWorkflowState in interface WorkFlowProvider

Throws:

java.lang.Exception

listWorkFlowTransitions

public java.util.List<WorkFlowTransition> listWorkFlowTransitions(org.eaglei.security.Session session,
                                                                  org.eaglei.model.EIEntity workspaceEntity)
                                                           throws java.lang.Exception

Description copied from interface: WorkFlowProvider

Returns the list of WorkFlowTransion objects

Specified by:

listWorkFlowTransitions in interface WorkFlowProvider

workspaceEntity - restrict results to transitions applying to given workspace . if passed null defaults to list from all workspaces

Returns:

List

Throws:

EIDataToolsProviderException

java.lang.Exception

org.apache.commons.httpclient.HttpException

java.io.IOException

See Also:

It Uses the Repository API call /repository/workflow/transitions,please see Workflow design notes at Workflow Design Notes

getModifiedDates

public java.util.Map<org.eaglei.model.EIURI,java.lang.String> getModifiedDates(org.eaglei.security.Session session,
                                                                               java.util.List<org.eaglei.model.EIURI> uris)
                                                                        throws java.lang.Exception

Specified by:

getModifiedDates in interface CrudProvider

Throws:

java.lang.Exception

claim

public java.util.List<org.eaglei.model.EIURI> claim(org.eaglei.security.Session session,
                                                    java.util.List<org.eaglei.model.EIURI> uris)
                                             throws java.lang.Exception

Specified by:

claim in interface WorkFlowProvider

Throws:

java.lang.Exception

release

public java.util.List<org.eaglei.model.EIURI> release(org.eaglei.security.Session session,
                                                      java.util.List<org.eaglei.model.EIURI> uris)
                                               throws java.lang.Exception

Specified by:

release in interface WorkFlowProvider

Throws:

java.lang.Exception

transition

public java.util.List<org.eaglei.model.EIURI> transition(org.eaglei.security.Session session,
                                                         java.util.List<org.eaglei.model.EIURI> uris,
                                                         org.eaglei.model.EIEntity transitionEntity)
                                                  throws java.lang.Exception

Specified by:

transition in interface WorkFlowProvider

Throws:

java.lang.Exception