eu.fbk.knowledgestore

Class Operation.Download

java.lang.Object

eu.fbk.knowledgestore.Operation

eu.fbk.knowledgestore.Operation.Download

Enclosing class:

Operation

public abstract static class Operation.Download
extends Operation

Download operation.

This operation attempts at fetching the representation associated to a resource with the ID specified. The operation is controlled by two optional parameters: caching(boolean) enables or disables the use of intermediate caches, if available, while accept(String...) / accept(Iterable) require the returned representation to have a certain MIME type (if it is not the case, the invocation fails).

Nested Class Summary

Nested classes/interfaces inherited from class eu.fbk.knowledgestore.Operation

Operation.Count, Operation.Create, Operation.Delete, Operation.Download, Operation.Match, Operation.Merge, Operation.Retrieve, Operation.Sparql, Operation.SparqlDelete, Operation.SparqlUpdate, Operation.Update, Operation.Upload

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Download(Map<String,String> inheritedNamespaces, org.openrdf.model.URI resourceID) Creates a new Download operation instance.

Method Summary

Modifier and Type	Method and Description
Operation.Download	accept(Iterable<? extends String> mimeTypes) Sets the acceptable MIME types (default: accept everything).
Operation.Download	accept(String... mimeTypes) Sets the acceptable MIME type (default: accept everything).
Operation.Download	caching(boolean caching) Sets whether the representation can be retrieved from caches (default true).
protected abstract Representation	doExec(Long timeout, org.openrdf.model.URI resourceID, Set<String> mimeTypes, boolean caching) Implementation method responsible of executing the download operation.
Representation	exec() Executes the operation, returning the requested representation or null, if it does not exist.
Operation.Download	namespaces(Map<String,String> namespaces) Sets the optional namespaces for this operation.
Operation.Download	timeout(Long timeout) Sets the optional timeout for this operation in milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

Download

protected Download(@Nullable
                   Map<String,String> inheritedNamespaces,
                   org.openrdf.model.URI resourceID)

Creates a new Download operation instance.

Parameters:

inheritedNamespaces - an immutable map of inherited namespaces, possibly null

resourceID - the ID of the resource whose representation should be retrieved

Method Detail

timeout

public Operation.Download timeout(@Nullable
                                  Long timeout)

Description copied from class: Operation

Sets the optional timeout for this operation in milliseconds. Passing null or a non-positive value will remove any timeout previously set.

Overrides:

timeout in class Operation

Parameters:

timeout - the timeout; null or non-positive to reset

Returns:

this operation object for call chaining

namespaces

public Operation.Download namespaces(@Nullable
                                     Map<String,String> namespaces)

Description copied from class: Operation

Sets the optional namespaces for this operation. Supplied namespaces overrides the namespaces inherited from the Session. Passing null will remove any namespace map previously set on the operation.

Overrides:

namespaces in class Operation

Parameters:

namespaces - the namespace map overriding session namespaces; null to reset

Returns:

this operation object for call chaining

accept

public final Operation.Download accept(@Nullable
                                       String... mimeTypes)

Sets the acceptable MIME type (default: accept everything). Supplied values override previously configured MIME types; passing null will drop the constraint.

Parameters:

mimeTypes - the acceptable MIME types; null (default) to drop any constraint

Returns:

this operation object, for call chaining

accept

public final Operation.Download accept(@Nullable
                                       Iterable<? extends String> mimeTypes)

Sets the acceptable MIME types (default: accept everything). Supplied values override previously configured MIME types; passing null will drop the constraint.

Parameters:

mimeTypes - the acceptable MIME types; null (default) to drop any constraint

Returns:

this operation object, for call chaining

caching

public final Operation.Download caching(boolean caching)

Sets whether the representation can be retrieved from caches (default true).

Parameters:

caching - true, if the representation can be retrieved from caches

Returns:

this operation object, for call chaining

exec

public final Representation exec()
                          throws OperationException

Executes the operation, returning the requested representation or null, if it does not exist. Note that returned representations MUST be closed after use.

Returns:

the requested representation, or null if it does not exist

Throws:

OperationException - in case of failure (see possible outcome status codes)

doExec

@Nullable
protected abstract Representation doExec(@Nullable
                                                   Long timeout,
                                                   org.openrdf.model.URI resourceID,
                                                   @Nullable
                                                   Set<String> mimeTypes,
                                                   boolean caching)
                                            throws OperationException

Implementation method responsible of executing the download operation.

Parameters:

timeout - the optional timeout for the operation; null if there is no timeout

resourceID - the ID of the resource whose representation must be returned

mimeTypes - the acceptable MIME types; null if there is no constraint

caching - true, if the representation can be retrieved from a cache

Returns:

the resource representation, if exists, otherwise null

Throws:

OperationException - in case of failure (see possible outcome status codes)