eu.id3.bioseal

Class ResourceCallbackArgs

java.lang.Object

eu.id3.bioseal.ResourceCallbackArgs

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable

public class ResourceCallbackArgs
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Serializable

Contains resource callback data.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResourceCallbackArgs() Creates a new instance of the ResourceCallbackArgs class.
ResourceCallbackArgs(long handle) Creates a new instance of the ResourceCallbackArgs class.

Method Summary

Modifier and Type	Method and Description
void	close() Releases all resources used by this ResourceCallbackArgs.
java.lang.String	computeSha256() Computes the SHA-256 of the external resource's data.
void	download() Downloads a resource.
java.lang.String	downloadStringFile(java.lang.String url) Downloads a file from the specified URL and returns a string.
protected void	finalize() Finalizer for this class.
long	getHandle() Gets the native handle.
byte[]	getOutputData() Gets the the external resource data as a byte array.
boolean	getRequiresUpdate() Gets the the external resource data must be updated.
java.lang.String	getResourceName() Gets the the resource name corresponing to the uri.
ResourceType	getResourceType() Gets the the resource type corresponding to the uri.
java.lang.String	getUri() Gets the the URI used to retrieve the external resource.
void	setOutputData(byte[] outputData) Sets the the external resource data as a byte array.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceCallbackArgs

public ResourceCallbackArgs()
                     throws BiosealException

Creates a new instance of the ResourceCallbackArgs class.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

ResourceCallbackArgs

public ResourceCallbackArgs(long handle)
                     throws BiosealException

Creates a new instance of the ResourceCallbackArgs class.

Parameters:

handle - Handle to the ResourceCallbackArgs.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

Method Detail

close

public void close()

Releases all resources used by this ResourceCallbackArgs.

Specified by:

close in interface java.lang.AutoCloseable

finalize

protected void finalize()

Finalizer for this class. Finalizers are deprecated since Java 9+. This method is not guaranteed to be called. To release all memory held by this class please be sure to call the close() method.

Overrides:

finalize in class java.lang.Object

getHandle

public long getHandle()

Gets the native handle.

Returns:

The native handle.

getUri

public java.lang.String getUri()
                        throws BiosealException

Gets the the URI used to retrieve the external resource.

Returns:

The URI used to retrieve the external resource.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getResourceName

public java.lang.String getResourceName()
                                 throws BiosealException

Gets the the resource name corresponing to the uri.

Returns:

The resource name corresponing to the uri.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getResourceType

public ResourceType getResourceType()
                             throws BiosealException

Gets the the resource type corresponding to the uri.

Returns:

The resource type corresponding to the uri.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getRequiresUpdate

public boolean getRequiresUpdate()
                          throws BiosealException

Gets the the external resource data must be updated.

Returns:

The external resource data must be updated.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

getOutputData

public byte[] getOutputData()
                     throws BiosealException

Gets the the external resource data as a byte array.

Returns:

The external resource data as a byte array.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

setOutputData

public void setOutputData(byte[] outputData)
                   throws BiosealException

Sets the the external resource data as a byte array.

Parameters:

outputData - The external resource data as a byte array.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

download

public void download()
              throws BiosealException

Downloads a resource.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

downloadStringFile

public java.lang.String downloadStringFile(java.lang.String url)
                                    throws BiosealException

Downloads a file from the specified URL and returns a string.

Parameters:

url - The URL to the file.

Returns:

The file as a string.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.

computeSha256

public java.lang.String computeSha256()
                               throws BiosealException

Computes the SHA-256 of the external resource's data.

Returns:

A string that contains the SHA-256.

Throws:

BiosealException - An error has occurred during Bioseal Library execution.