Uses of Class
nl.knaw.dans.lib.dataverse.DataverseException

Packages that use DataverseException

Package	Description
nl.knaw.dans.lib.dataverse	Main package for the DANS Dataverse Client Library

Uses of DataverseException in nl.knaw.dans.lib.dataverse

Methods in nl.knaw.dans.lib.dataverse that throw DataverseException

Modifier and Type	Method	Description
DataverseHttpResponse<DataMessageWithId>	AdminApi.addBannerMessage(String json)	Adds a banner message.
DataverseHttpResponse<DataMessageWithId>	AdminApi.addBannerMessage(Messages messages)	Adds a banner message.
DataverseHttpResponse<FileList>	DatasetApi.addFile(Path file, String metadata)
DataverseHttpResponse<FileList>	DatasetApi.addFile(Path file, FileMeta fileMeta)
DataverseHttpResponse<FileList>	DatasetApi.addFile(PrestagedFile prestagedFile)
DataverseHttpResponse<DataMessage>	LicenseApi.addLicense(License license)
DataverseHttpResponse<DataMessage>	DatasetApi.addLock(String lockType)	Adds a lock of the specified type to the dataset.
DataverseHttpResponse<Workflow>	WorkflowsApi.addWorkflow(Workflow workflow)
DataverseHttpResponse<DataMessage>	DataverseApi.assignDefaultRoleOnDataset(String roleName)
DataverseHttpResponse<RoleAssignmentReadOnly>	DatasetApi.assignRole(String roleAssignment)
DataverseHttpResponse<RoleAssignmentReadOnly>	DatasetApi.assignRole(RoleAssignment roleAssignment)
DataverseHttpResponse<DataMessage>	DataverseApi.assignRole(RoleAssignment roleAssignment)
void	DatasetApi.awaitLock(String lockType)	The same as DatasetApi.awaitLock(String, int, int) but with defaults for number of tries and time between tries.
void	DatasetApi.awaitLock(String lockType, int maxNumberOfRetries, int waitTimeInMilliseconds)	Utility function that lets you wait until a specified lock type is set.
void	DatasetApi.awaitState(String expectedState, long timeout, long pollingInterval)	Waits for the dataset to reach the expected state.
void	DatasetApi.awaitUnlock()	The same
void	DatasetApi.awaitUnlock(int maxNumberOfRetries, int waitTimeInMilliseconds)	Utility function that lets you wait until all locks are cleared before proceeding.
void	DatasetApi.awaitUnlock(List<String> lockTypes, int maxNumberOfRetries, int waitTimeInMilliseconds)	The same for a specific set of locks.
void	DataverseClient.checkConnection()
DataverseHttpResponse<DataMessageSolrIndex>	SolrIndexApi.clear()	Clears (deletes) the Solr index.
DataverseHttpResponse<DataMessage>	MetadataExportApi.clearExportTimestamps()	Clears metadata export timestamps on published local datasets.
DataverseHttpResponse<DataMessage>	SolrIndexApi.clearTimestamps()	Clears the index timestamps for all objects, causing them to be re-indexed on the next indexing run.
DataverseHttpResponse<UserCreatedResult>	BuiltinUserApi.create(String accountData, String password)	Creates a built-in user from a JSON string with account data.
DataverseHttpResponse<UserCreatedResult>	BuiltinUserApi.create(BuiltinUser accountData, String password)	Creates a built-in user from a model object.
DataverseHttpResponse<Dataverse>	DataverseApi.create(String dataverse)
DataverseHttpResponse<Dataverse>	DataverseApi.create(Dataverse dataverse)
DataverseHttpResponse<DatasetCreationResult>	DataverseApi.createDataset(String dataset)
DataverseHttpResponse<DatasetCreationResult>	DataverseApi.createDataset(String dataset, Map<String,String> metadataKeys)
DataverseHttpResponse<DatasetCreationResult>	DataverseApi.createDataset(Dataset dataset)
DataverseHttpResponse<DatasetCreationResult>	DataverseApi.createDataset(Dataset dataset, Map<String,String> metadataKeys)
DataverseHttpResponse<DataMessage>	DataverseApi.createRole(String role)
DataverseHttpResponse<DataMessage>	DataverseApi.createRole(Role role)
DataverseHttpResponse<DataMessage>	DataverseApi.defineMetadataBlocks(List<String> metadataBlocks)
DataverseHttpResponse<DataMessage>	DataverseApi.delete()
DataverseHttpResponse<DataMessage>	DatasetApi.deleteArchivalStatus(String version)	Deletes the archival status of a dataset version.
DataverseHttpResponse<DataMessage>	AdminApi.deleteBannerMessage(int id)	Deletes a banner message.
DataverseHttpResponse<DataMessage>	WorkflowsApi.deleteDefault(String triggerType)
DataverseHttpResponse<DataMessage>	DatasetApi.deleteDraft()
DataverseHttpResponse<Object>	SwordApi.deleteFile(int databaseId)	Deletes a file from the current draft of the dataset.
DataverseHttpResponse<String>	DatasetApi.deleteFiles(List<Long> fileIds)
DataverseHttpResponse<DataMessage>	WorkflowsApi.deleteIpWhitelist()
DataverseHttpResponse<DataMessage>	LicenseApi.deleteLicense(long id)
DataverseHttpResponse<DataMessage>	DatasetApi.deleteLock(String lockType)	Deletes a lock of the specified type from the dataset.
DataverseHttpResponse<DatasetVersion>	DatasetApi.deleteMetadata(String s, Map<String,String> metadataKeys)
DataverseHttpResponse<DatasetVersion>	DatasetApi.deleteMetadata(FieldList fields, Map<String,String> metadataKeys)
DataverseHttpResponse<DataMessage>	DatasetApi.deleteRoleAssignment(int roleAssignmentId)
DataverseHttpResponse<DataMessage>	DataverseApi.deleteRoleAssignment(int roleAssignmentId)
DataverseHttpResponse<DataMessage>	DatasetApi.deleteStorageDriver(String label)	Deletes the storage driver with the specified label.
DataverseHttpResponse<DataMessage>	WorkflowsApi.deleteWorkflow(long workflowId)
DataverseHttpResponse<DataMessage>	DataAccessRequestsApi.disable()
DataverseHttpResponse<DatasetVersion>	DatasetApi.editMetadata(String s)	Edits the current draft's metadata, adding the fields that do not exist yet.
DataverseHttpResponse<DatasetVersion>	DatasetApi.editMetadata(String s, Boolean replace)	Edits the current draft's metadata, adding the fields that do not exist yet.
DataverseHttpResponse<DatasetVersion>	DatasetApi.editMetadata(String s, Boolean replace, Map<String,String> metadataKeys)	Edits the current draft's metadata, adding the fields that do not exist yet.
DataverseHttpResponse<DatasetVersion>	DatasetApi.editMetadata(String s, Map<String,String> metadataKeys)	Edits the current draft's metadata, adding the fields that do not exist yet.
DataverseHttpResponse<DatasetVersion>	DatasetApi.editMetadata(FieldList fields)	Edits the current draft's metadata, adding the fields that do not exist yet.
DataverseHttpResponse<DatasetVersion>	DatasetApi.editMetadata(FieldList fields, Boolean replace)	Edits the current draft's metadata, adding the fields that do not exist yet.
DataverseHttpResponse<DatasetVersion>	DatasetApi.editMetadata(FieldList fields, Boolean replace, Map<String,String> metadataKeys)	Edits the current draft's metadata, adding the fields that do not exist yet.
DataverseHttpResponse<DatasetVersion>	DatasetApi.editMetadata(FieldList fields, Map<String,String> metadataKeys)	Edits the current draft's metadata, adding the fields that do not exist yet.
DataverseHttpResponse<DataMessage>	DataAccessRequestsApi.enable()
DataverseHttpResponse<Object>	MetadataExportApi.exportAll()	Attempts to export all published local datasets that have not been exported yet.
DataverseHttpResponse<SearchResult>	SearchApi.find(String query)	A basic search action with default options.
DataverseHttpResponse<SearchResult>	SearchApi.find(String query, SearchOptions options)	A search action with specific SearchOptions.
DataverseHttpResponse<List<DatasetVersion>>	DatasetApi.getAllVersions()
DataverseHttpResponse<DatasetArchivalStatus>	DatasetApi.getArchivalStatus(String version)	Returns the archival status of the dataset.
DataverseHttpResponse<Map<String,String>>	AdminApi.getAvailableStorageDrivers()	Retrieves a list of available storage drivers from the Dataverse instance.
DataverseHttpResponse<List<DataverseItem>>	DataverseApi.getContents()
DataverseHttpResponse<DataMessage>	AdminApi.getDatabaseSetting(String key)
DataverseHttpResponse<Workflow>	WorkflowsApi.getDefault(String triggerType)
DataverseHttpResponse<DataMessage>	LicenseApi.getDefaultLicense()
<T> T	BasicFileAccessApi.getFile(GetFileOptions options, GetFileRange range, org.apache.hc.core5.http.io.HttpClientResponseHandler<T> handler)
<T> T	BasicFileAccessApi.getFile(GetFileOptions options, org.apache.hc.core5.http.io.HttpClientResponseHandler<T> handler)
<T> T	BasicFileAccessApi.getFile(GetFileRange range, org.apache.hc.core5.http.io.HttpClientResponseHandler<T> handler)
<T> T	BasicFileAccessApi.getFile(org.apache.hc.core5.http.io.HttpClientResponseHandler<T> handler)
DataverseHttpResponse<List<FileMeta>>	DatasetApi.getFiles(String version)
DataverseHttpResponse<DataMessage>	DataverseApi.getGuestBookResponses()
DataverseHttpResponse<DataMessage>	WorkflowsApi.getIpWhitelist()
DataverseHttpResponse<DatasetLatestVersion>	DatasetApi.getLatestVersion()	Deprecated, for removal: This API element is subject to removal in a future version. use DatasetApi.getVersion() instead
DataverseHttpResponse<License>	LicenseApi.getLicenseById(long id)
DataverseHttpResponse<List<License>>	LicenseApi.getLicenses()
DataverseHttpResponse<List<Lock>>	DatasetApi.getLocks()
DataverseHttpResponse<FileMeta>	FileApi.getMetadata()
DataverseHttpResponse<FileMeta>	FileApi.getMetadata(boolean includeDesaccessioned)
DataverseHttpResponse<MetadataBlockDefinition>	MetadataBlocksApi.getMetadataBlock(int id)	Retrieves metadata block information by its integer ID.
DataverseHttpResponse<MetadataBlockDefinition>	MetadataBlocksApi.getMetadataBlock(long id)	Retrieves metadata block information by its long ID.
DataverseHttpResponse<MetadataBlockDefinition>	MetadataBlocksApi.getMetadataBlock(String identifier)	Retrieves metadata block information by its identifier (name or ID).
String	DatasetApi.getState()	Returns the state of the latest version of the dataset that is visible to the user.
DataverseHttpResponse<StorageDriver>	DatasetApi.getStorageDriver()	Retrieves the storage driver associated with a specific dataset.
DataverseHttpResponse<DataMessage>	DataverseApi.getStorageSize()
DataverseHttpResponse<DirectUploadURLs>	DatasetApi.getUploadUrls(long fileSize)
DataverseHttpResponse<DatasetVersion>	DatasetApi.getVersion()	Retrieves that latest version of a dataset that you can see with your permissions.
DataverseHttpResponse<DatasetVersion>	DatasetApi.getVersion(@NonNull String version, boolean excludeFiles)
DataverseHttpResponse<DatasetVersion>	DatasetApi.getVersion(String version)	Retrieves a specific version of a dataset if you can see it with your permissions, otherwise returns a 401.
DataverseHttpResponse<Workflow>	WorkflowsApi.getWorkflow(long workflowId)
DataverseHttpResponse<DatasetCreationResult>	DataverseApi.importDataset(String dataset, String persistentId, boolean autoPublish)
DataverseHttpResponse<DatasetCreationResult>	DataverseApi.importDataset(String dataset, String persistentId, boolean autoPublish, Map<String,String> metadataKeys)
DataverseHttpResponse<DatasetCreationResult>	DataverseApi.importDataset(Dataset dataset, String persistentId, boolean autoPublish)
DataverseHttpResponse<DatasetCreationResult>	DataverseApi.importDataset(Dataset dataset, String persistentId, boolean autoPublish, Map<String,String> metadataKeys)
DataverseHttpResponse<DatasetCreationResult>	DataverseApi.importDatasetFromDdi()
DataverseHttpResponse<DataMessageSolrIndex>	SolrIndexApi.indexAll()	Triggers a full reindex of all content in the Dataverse installation.
DataverseHttpResponse<DataMessageSolrIndex>	SolrIndexApi.indexDataset(int id)	Indexes a specific dataset identified by its database id.
DataverseHttpResponse<DataMessageSolrIndex>	SolrIndexApi.indexDataset(String persistentId)	Indexes a specific dataset identified by its persistent identifier.
DataverseHttpResponse<DataMessage>	SolrIndexApi.indexDataverse(int id)	Indexes a specific dataverse identified by its database id.
DataverseHttpResponse<Boolean>	DataverseApi.isMetadataBlocksRoot()
DataverseHttpResponse<Map<String,String>>	AdminApi.listAllDatabaseSettings()
DataverseHttpResponse<List<BannerMessage>>	AdminApi.listBannerMessages()	Lists all banner messages.
DataverseHttpResponse<Map>	WorkflowsApi.listDefaults()
DataverseHttpResponse<DataMessage>	DataverseApi.listFacets()
DataverseHttpResponse<List<MetadataBlock>>	DataverseApi.listMetadataBlocks()
DataverseHttpResponse<List<MetadataBlockDefinition>>	MetadataBlocksApi.listMetadataBlocks()	Retrieves a list of all metadata blocks.
DataverseHttpResponse<List<MetadataBlockDefinition>>	MetadataBlocksApi.listMetadataBlocks(boolean onlyDisplayedOnCreate)	Retrieves a list of all metadata blocks with an option to filter only those displayed on create.
DataverseHttpResponse<List<MetadataBlockDefinition>>	MetadataBlocksApi.listMetadataBlocks(boolean onlyDisplayedOnCreate, boolean returnDatasetFieldTypes)	Retrieves a list of all metadata blocks with options to filter only those displayed on create and to return dataset field types.
DataverseHttpResponse<List<RoleAssignmentReadOnly>>	DatasetApi.listRoleAssignments()
DataverseHttpResponse<List<RoleAssignmentReadOnly>>	DataverseApi.listRoleAssignments()
DataverseHttpResponse<List<Role>>	DataverseApi.listRoles()
DataverseHttpResponse<AuthenticatedUser>	AdminApi.listSingleUser(String id)
DataverseHttpResponse<List<Workflow>>	WorkflowsApi.listWorkflows()
DataverseHttpResponse<DatasetPublicationResult>	DatasetApi.publish()
DataverseHttpResponse<DataMessage>	DatasetApi.publish(UpdateType updateType, boolean assureIsIndexed)
DataverseHttpResponse<Dataverse>	DataverseApi.publish()
DataverseHttpResponse<Map<String,String>>	AdminApi.putDatabaseSetting(String key, String value)
DataverseHttpResponse<Object>	MetadataExportApi.reExportAll()	Forces re-export of all published local datasets.
DataverseHttpResponse<Object>	MetadataExportApi.reExportAll(String olderThan, String... formats)	Forces re-export of all published local datasets with optional filters.
DataverseHttpResponse<Object>	MetadataExportApi.reExportAllFormats(String... formats)	Forces re-export of all published local datasets for the selected metadata formats.
DataverseHttpResponse<Object>	MetadataExportApi.reExportAllOlderThan(String olderThan)	Forces re-export of all published local datasets exported before the supplied date.
DataverseHttpResponse<Object>	MetadataExportApi.reExportDataset(int id)	Forces re-export of a specific dataset identified by its database id.
DataverseHttpResponse<Object>	MetadataExportApi.reExportDataset(int id, String... formats)	Forces re-export of a specific dataset identified by its database id for selected formats.
DataverseHttpResponse<Object>	MetadataExportApi.reExportDataset(String pid)	Forces re-export of a specific dataset identified by its persistent identifier.
DataverseHttpResponse<Object>	MetadataExportApi.reExportDataset(String pid, String... formats)	Forces re-export of a specific dataset identified by its persistent identifier for selected formats.
DataverseHttpResponse<DatasetPublicationResult>	DatasetApi.releaseMigrated(String publicationDateJsonLd, boolean assureIsIndexed)
DataverseHttpResponse<FileList>	FileApi.replaceFile(Path dataFile, String fileMeta)
DataverseHttpResponse<FileList>	FileApi.replaceFile(Path dataFile, FileMeta fileMeta)
DataverseHttpResponse<Object>	WorkflowsApi.resume(String invocationId, ResumeMessage resumeMessage)
DataverseHttpResponse<DataMessage>	LicenseApi.setActiveState(long id, boolean active)
DataverseHttpResponse<DataMessage>	WorkflowsApi.setDefault(String triggerType, long workflowId)
DataverseHttpResponse<DataMessage>	LicenseApi.setDefaultLicense(long id)
DataverseHttpResponse<HashMap>	DatasetApi.setEmbargo(String json)
DataverseHttpResponse<HashMap>	DatasetApi.setEmbargo(Embargo embargo)
DataverseHttpResponse<DataMessage>	DataverseApi.setFacets(List<String> facets)
DataverseHttpResponse<String>	WorkflowsApi.setIpWhitelist(String ipWhitelist)
DataverseHttpResponse<DataMessage>	DataverseApi.setMetadataBlocksRoot(boolean isRoot)
DataverseHttpResponse<HashMap>	DatasetApi.setRetentionPeriod(String json)
DataverseHttpResponse<HashMap>	DatasetApi.setRetentionPeriod(RetentionPeriod retentionPeriod)
DataverseHttpResponse<DataMessage>	DatasetApi.setStorageDriver(String label)	Sets the storage driver for the Dataverse instance with the specified label.
DataverseHttpResponse<DataMessage>	SolrIndexApi.status()	Returns the current status of the Solr index.
DataverseHttpResponse<DataMessage>	AdminApi.submitDatasetVersionToArchive(String id, String version, boolean isPersistentId)	Submits a dataset version to the archive.
DataverseHttpResponse<SubmitForReviewResult>	DatasetApi.submitForReview()
DataverseHttpResponse<MetricsTreeNode>	MetricsApi.tree()	Returns the metrics tree of dataverses.
DataverseHttpResponse<String>	DatasetApi.updateFileMetadatas(List<FileMetaUpdate> fileMetas)
DataverseHttpResponse<DatasetVersion>	DatasetApi.updateMetadata(String s)
DataverseHttpResponse<DatasetVersion>	DatasetApi.updateMetadata(String s, Map<String,String> metadataKeys)
DataverseHttpResponse<DatasetVersion>	DatasetApi.updateMetadata(DatasetVersion version)	Note that not all the attributes of the DatasetVersion object are writable.
DataverseHttpResponse<DatasetVersion>	DatasetApi.updateMetadata(DatasetVersion version, Map<String,String> metadataKeys)
DataverseHttpResponse<String>	FileApi.updateMetadata(String fileMeta)
DataverseHttpResponse<String>	FileApi.updateMetadata(FileMeta fileMeta)
DataverseHttpResponse<Object>	DatasetApi.updateMetadataFromJsonLd(String metadata, boolean replace)
DataverseHttpResponse<Object>	DatasetApi.updateMetadataFromJsonLd(String metadata, boolean replace, Map<String,String> metadataKeys)
DataverseHttpResponse<DataMessage>	DatasetApi.updateRegistrationMetadata()	Checks whether the metadata registered at the PID provider for a published dataset is up to date and updates it if necessary.
DataverseHttpResponseWithoutEnvelope<DatasetFileValidationResultList>	AdminApi.validateDatasetFiles(int dbId)	The following validates all the physical files in the dataset specified by recalculating the checksums and comparing them against the values saved in the database.
DataverseHttpResponseWithoutEnvelope<DatasetFileValidationResultList>	AdminApi.validateDatasetFiles(String pid)	Validates all the physical files in the dataset specified by recalculating the checksums and comparing them against the values saved in the database.
DataverseHttpResponseWithoutEnvelope<DatasetFileValidationResultList>	AdminApi.validateDatasetFiles(String id, boolean isPersistentId)	Validates all the physical files in the dataset specified by recalculating the checksums and comparing them against the values saved in the database.
DataverseHttpResponse<Dataverse>	DataverseApi.view()