Package io.goobi.viewer.model.transkribus

Class TranskribusUtils

java.lang.Object

io.goobi.viewer.model.transkribus.TranskribusUtils

public final class TranskribusUtils
extends Object

TranskribusUtils class.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TRANSRIBUS_REST_TESTING_URL	Constant TRANSRIBUS_REST_TESTING_URL="https://transkribus.eu/TrpServerTesting"{trunked}
static final String	TRANSRIBUS_REST_URL	Constant TRANSRIBUS_REST_URL="https://transkribus.eu/TrpServer/rest/"

Method Summary

Modifier and Type	Method	Description
static org.jdom2.Document	auth(String baseUrl, String userName, String password)	auth.
protected static JobStatus	checkJobStatus(String baseUrl, String sessionId, String jobId)	checkJobStatus.
protected static String	createCollection(String baseUrl, String sessionId, String collectionName)	createCollection.
static String	getCollectionId(String baseUrl, String sessionId, String collectionName)	Returns the ID of the first collection that has the given collection name.
protected static boolean	grantCollectionPrivsToViewer(String baseUrl, String sessionId, String collectionId, String recipientUserId, boolean sendMail)	grantCollectionPrivsToViewer.
static TranskribusJob	ingestRecord(String restApiUrl, TranskribusSession userSession, String pi, String metsResolverUrlRoot)	ingestRecord.
protected static TranskribusJob	ingestRecordToCollections(String baseUrl, TranskribusSession session, String pi, String metsUrl, String userCollectionId, String viewerCollectionId)	ingestRecordToCollections.
static TranskribusSession	login(String baseUrl, String userName, String password)	login.

Methods inherited from class java.lang.Object

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

Field Details

TRANSRIBUS_REST_URL

public static final String TRANSRIBUS_REST_URL

Constant TRANSRIBUS_REST_URL="https://transkribus.eu/TrpServer/rest/"

See Also:

• Constant Field Values

TRANSRIBUS_REST_TESTING_URL

public static final String TRANSRIBUS_REST_TESTING_URL

Constant TRANSRIBUS_REST_TESTING_URL="https://transkribus.eu/TrpServerTesting"{trunked}

See Also:

• Constant Field Values

Method Details

ingestRecord

public static TranskribusJob ingestRecord(String restApiUrl,
 TranskribusSession userSession,
 String pi,
 String metsResolverUrlRoot)
                                   throws IOException,
HTTPException,
org.jdom2.JDOMException,
DAOException

ingestRecord.

Parameters:

restApiUrl - a String object.

userSession - a TranskribusSession object.

pi - a String object.

metsResolverUrlRoot - Root of the METS resolver URL (without the identifier).

Returns:

a TranskribusJob object.

Throws:

IOException - if any.

HTTPException - if any.

org.jdom2.JDOMException - if any.

DAOException - if any.

login

public static TranskribusSession login(String baseUrl,
 String userName,
 String password)
                                throws IOException,
org.jdom2.JDOMException

login.

Parameters:

baseUrl - a String object.

userName - a String object.

password - a String object.

Returns:

a TranskribusSession object.

Throws:

IOException - if any.

org.jdom2.JDOMException - if any.

auth

public static org.jdom2.Document auth(String baseUrl,
 String userName,
 String password)
                               throws IOException,
org.jdom2.JDOMException

auth.

Parameters:

baseUrl - a String object.

userName - a String object.

password - a String object.

Returns:

JDOM object containing the API response

Throws:

IOException - if any.

org.jdom2.JDOMException - if any.

getCollectionId

public static String getCollectionId(String baseUrl,
 String sessionId,
 String collectionName)
                              throws IOException,
HTTPException

Returns the ID of the first collection that has the given collection name.

Parameters:

baseUrl - a String object.

sessionId - a String object.

collectionName - a String object.

Returns:

a String object.

Throws:

IOException - if any.

HTTPException - if any.

createCollection

protected static String createCollection(String baseUrl,
 String sessionId,
 String collectionName)
                                  throws IOException

createCollection.

Parameters:

baseUrl - a String object.

sessionId - a String object.

collectionName - a String object.

Returns:

a String object.

Throws:

IOException - if any.

grantCollectionPrivsToViewer

protected static boolean grantCollectionPrivsToViewer(String baseUrl,
 String sessionId,
 String collectionId,
 String recipientUserId,
 boolean sendMail)
                                               throws IOException

grantCollectionPrivsToViewer.

Parameters:

baseUrl - a String object.

sessionId - a String object.

collectionId - a String object.

recipientUserId - a String object.

sendMail - a boolean.

Returns:

a boolean.

Throws:

IOException - if any.

ingestRecordToCollections

protected static TranskribusJob ingestRecordToCollections(String baseUrl,
 TranskribusSession session,
 String pi,
 String metsUrl,
 String userCollectionId,
 String viewerCollectionId)
                                                   throws IOException

ingestRecordToCollections.

Parameters:

baseUrl - a String object.

session - a TranskribusSession object.

pi - a String object.

metsUrl - a String object.

userCollectionId - a String object.

viewerCollectionId - a String object.

Returns:

a TranskribusJob object.

Throws:

IOException - if any. o

checkJobStatus

protected static JobStatus checkJobStatus(String baseUrl,
 String sessionId,
 String jobId)
                                   throws IOException,
HTTPException

checkJobStatus.

Parameters:

baseUrl - a String object.

sessionId - a String object.

jobId - a String object.

Returns:

a io.goobi.viewer.model.transkribus.TranskribusJob.JobStatus object.

Throws:

IOException - if any.

HTTPException - if any.