Property Detail

• java.lang.String COLLECTIONS_BASE_URL

• static final java.util.List COMMON_FIELDS_DR_DRT

• static final java.lang.String DEFAULT_API_KEY_HEADER

• static final java.util.List REQUIRED_FIELDS

• static final java.util.List TEMP_DATA_RESROUCE_STATUSES

• static final java.lang.String USER_HEADER

• au.org.ala.web.AuthService authService

• CollectoryHubJenkinsService collectoryHubJenkinsService

• CollectoryHubService collectoryHubService

• java.lang.Object grailsApplication

• au.org.ala.ws.service.WebService webService

Method Detail

• java.util.Map addLicenseAndVersion(java.util.Map dr, java.lang.String license)

  map license from temp data resource to license in data resource

  Parameters:

  dr

  license

  Returns:

• java.util.Map checkIfMandatoryFieldsAreFilled(java.util.Map drt)

  Checks if required fields are filled by owner of temp data resource. It returns appropriate message according to fields failing the mandatory condition

  Parameters:

  drt - - java.util.Map - temp data resource fields

  Returns:

• java.util.Map cleanTempDateResource(java.util.Map tempMeta)

  Make properties more human friendly

  Parameters:

  tempMeta - - drt map

  Returns:

• java.util.Map convertTempDataResourceToDataResource(java.util.Map drt)

  Map temp data resource properties to data resource properties

  Parameters:

  drt

  Returns:

• java.util.Map createContact(java.util.Map props)

  Create contact details for a user

  Parameters:

  props - - contains properties like email, first name, fax number etc.

  Returns:

• java.util.Map createContactMap(java.lang.String alaId)

  Map details of contact from userdetails system to collectory compatible format.

  Parameters:

  alaId

  Returns:

• java.util.List createOrSaveDataResource(java.lang.String uid)

  Create or update a data resource for a uid

  Parameters:

  uid - - drt id

  Returns:

• java.util.Map createOrSaveDataResource(java.lang.String uid, java.util.Map dr)

  Create or update a data resource. If uid is passed, then function will update data resource. Otherwise, create a new data resource

  Parameters:

  uid - - dr id

  dr - - data resource fields

  Returns:

  [ uid: dr1, status: 200, location: '/ws/dataResource/dr1' ]

• java.lang.Object createOrUpdateContactForEntity(java.lang.String entity, java.lang.String uid, java.lang.Integer contactId)

  create a relationship between a contact and an entity

  Parameters:

  entity

  uid

  contactId

  Returns:

• java.util.Map declineTempDataResource(java.lang.String uid)

  Decline a data resource. This function will update status of data resource.

  Parameters:

  uid - - drt id

  Returns:

• void deleteAnEntity(java.lang.String entity, java.lang.String uid)

  An function which will delete an entity on collectory

  Parameters:

  entity

  uid

• java.util.Map deleteDataResource(java.lang.String uid)

  delete a data resource

  Parameters:

  uid

  Returns:

• java.util.Map deleteTempDataResource(java.lang.String uid)

  delete a data resource

  Parameters:

  uid

  Returns:

• java.util.Map draftTempDataResource(java.lang.String uid)

  Set status of a data resource to draft.

  Parameters:

  uid - - drt id

  Returns:

• java.util.Map getContact(java.lang.String email)

  Get contact details of a user.

  Parameters:

  email - - email address

  Returns:

• java.util.Map getDataResource(java.lang.String id)

  get data resource id details and contact person details

  Parameters:

  id - - data resource id

  Returns:

• @grails.plugin.cache.Cacheable('longTermCache') java.util.List getDataResources(java.lang.String context)

  get all data resource id details satisfying a query condition.

  Parameters:

  context - - all, hub - all corresponds to all data in ALA and hub for a particular hub config eg. MDBA hub

  Returns:

• @grails.plugin.cache.Cacheable('longTermCache') java.util.List getDataResourcesFromCollectory(java.lang.String url)

  get detials of all data resource ids in collectory

  Parameters:

  url

  Returns:

• java.lang.String getDateAndTimeFromTimeStamp(java.lang.String timestamp)

  convert a timestamp to human recognizable format

  Parameters:

  timestamp

  Returns:

• java.util.List getFilteredDataResources(java.lang.String query, java.lang.String source)

  Query data resource name and return a list of matching data resource ids

  Parameters:

  query

  source

  Returns:

  ['dr1','dr2']

• java.util.Map getInstitution(java.lang.String id)

  get institution details and contact person details.

  Parameters:

  id

  Returns:

• java.util.Map getListOfTempDataResource(java.lang.String userId, java.lang.String max = 10, java.lang.String offset = 0, java.lang.String status = '', java.lang.String sortField = 'lastUpdated', java.lang.String sortOrder = 'desc')

  Get all temp data resource for a user.

  Parameters:

  userId - - ala id

  max

  offset

  status

  sortField

  sortOrder

  Returns:

  A map containing list of temp data resources and total temp data resources in db matiching passed criteria.

• java.lang.Integer getOrCreateContact(java.lang.String email, java.lang.String alaId)

  get a user's contact id. If user does not exist, create one.

  Parameters:

  email

  alaId

  Returns:

• @grails.plugin.cache.Cacheable(value = "collectoryCache", key = "#uid") java.util.Map getTempDataResource(java.lang.String uid)

  Get metadata of a temp data resource and append system metadata to it

  Parameters:

  uid - - drt1

  Returns:

  java.util.Map

• java.util.Map getTempDataResourceFromCollectory(java.lang.String uid)

  Get metadata for a temp data resource from collectory

  Parameters:

  uid

  Returns:

• java.util.Map getUserUploads(java.lang.String currentUserId, java.lang.String webserviceUrl = '', java.lang.String max = 10, java.lang.String offset = 0, java.lang.String status = '', java.lang.String sortField = 'lastUpdated', java.lang.String sortOrder = 'desc')

  Retrieves a listing of uploads for this user.

  Returns:

  JSON list of data resources

• @javax.annotation.PostConstruct java.lang.Object init()

• java.lang.Boolean isDataSubmittedForTempDataResource(java.lang.String uid)

  check if data file is present for a given temp data resource

  Parameters:

  uid - - drt id

  Returns:

• java.util.Map loadToProduction(java.lang.String uid, java.lang.Boolean indexing)

  Load a temp data resource to production.

  Parameters:

  uid

  Returns:

• java.util.Map preFillSystemDetails(java.util.Map tempMeta)

  Pre-fill temp metadata with user name, links to resources etc

  Parameters:

  tempMeta

  Returns:

• java.util.Map resetStatus(java.lang.String uid)

  Set status of a dataset to draft

  Parameters:

  uid - - drt id

  Returns:

• @grails.plugin.cache.CacheEvict(value="collectoryCache", key= "#uid", beforeInvocation = true) java.util.Map saveTempDataResource(java.util.Map data, java.lang.String uid)

  Save temp data resource metadata on collectory.

  params:

  uid - required - temp data resource id

  params:

  All temp data resource related properties - check au.org.ala.collectory.TempDataResource in Collectory Plugin.

• java.util.Map submitTempDataResourceForReview(java.lang.String uid)

  Submit a user uploaded dataset for review.

  Parameters:

  uid

  Returns: