Nutzungsbeispiele Java-Client

Um die Anbindung eigener Anwendungen an den URN-Service bzw. die URN-Rest-API zu unterstützen, bieten wir einen Java-Client. 

Folgende Schnittstellen 

wurden hier implementiert:

Schritt-für-Schritt-Anleitung

Technische Voraussetzungen:

• Die Verwendung von Java 8 oder kompatiblere JVM Sprache in der entsprechenden Version.
• Berechtigung zur Einspielung von URNS der eigenen Institutionen innerhalb des eigenen Namensraumes in Form von LOGIN / USER Credentials.
• Die URL zur URN-Rest-API (z.B.: "http://api.nbn-resolving.org/sandbox/v2/").

UrnRestClient

private static final String V2_URI = "http://api.nbn-resolving.org/sandbox/v2/";

private static UrnRestClient urnRepository;

public static void main(String[] args) {

 	urnRepository = new UrnRestClient(V2_URI); 
	final ApiInfo info = urnRepository.getInfo();
}

liefert ein Objekt vom Typ ApiInfo mit folgenden Output (info.toString() ):

UrnNamespaceClient

Um die Namensräume gezielt abfragen zu können, werden Filter- und Sortierparameter benötigt. 

ORG_LOGIN und ORG_PASSWORD sind Platzhalter für das eigene LOGIN/PASSWORD.

getNamespaces()

private static final String V2_URI = "http://api.nbn-resolving.org/sandbox/v2/";
private static final String DEFAULT_NASP_WILDCARD = "urn:nbn:de*";
private static UrnNamespaceRestClient naspRepository;


public static void main(String[] args) {
 	naspRepository = new UrnNamespaceRestClient(V2_URI);
	
	  final Optional<NamespaceFilter> naspFilter = Optional
                .of(new NamespaceFilter(NamespaceFilterKey.NAME, DEFAULT_NASP_WILDCARD));
        final NamespaceSortParameters naspsortparams = new NamespaceSortParameters().getDefault();
        naspsortparams.setSortBy(NamespaceSortKey.NAME);
        final PagingParameters pagingParameters = new PagingParameters().getDefault();

        UrnRestResultNamespaceObject result = null;

        try {
            result = naspRepository.getNamespacesWithFilter(ORG_LOGIN, ORG_PASSWORD, naspFilter, naspsortparams,
                    pagingParameters);
        } catch (final UrnRestApiNotAvailableException e) {
            System.out.println("The client cannot connect to the URN-REST-API.");
        }
}

Diese Anfrage liefert ein Ergebnisobjekt vom Typ UrnRestResultNamespaceObject. Das UrnRestResultNamespaceObject "wrapt" das ursprüngliche RESTNamespaceRepresentation-Objekt und fügt weitere wichtige Informationen hinzu (Anfrage erfolreich, Anzahl Treffer, weitere Trefferseiten verfügbar, ...).Die Ergebnisse werden paginiert innerhalb einer ArrayList abgespeichert. 

getNamespace()

Führt eine Suche nach einem bestimmten Namensraum durch.

Notwendige Parameter sind wieder ORG_LOGIN, ORG_PASSWORD, Name des zu suchenden Namespace. Der letzte Parameter ist nur für Admins relevant (runAs) und kann leer bleiben. 

private static final String V2_URI = "http://api.nbn-resolving.org/sandbox/v2/";
private static final String DEFAULT_NASP_WILDCARD = "urn:nbn:de*";
private static final String ORG_NAMESPACE = "urn:nbn:de:0007";
private static UrnNamespaceRestClient naspRepository;


public static void main(String[] args) {
 	naspRepository = new UrnNamespaceRestClient(V2_URI);
	
	UrnRestResultNamespaceObject result = null;

        try {
            result = naspRepository.getNamespaceViaName(ORG_LOGIN, ORG_PASSWORD, ORG_NAMESPACE, ORG_USER);
        } catch (final UrnRestApiNotAvailableException e) {
            LOGGER.error("The client cannot connect to the server. Is there an internet connection?");
        }

        LOGGER.info("Response End...");
}

Diese Anfrage liefert ein Ergebnisobjekt vom Typ UrnRestResultNamespaceObject. Die Ergebnisse werden paginiert ausgeliefert. Das UrnRestResultNamespaceObject "wrapt" das ursprüngliche RESTNamespaceRepresentation-Objekt und fügt weitere wichtige Informationen hinzu (Anfrage erfolreich, Anzahl Treffer, weitere Trefferseiten verfügbar, ...)

Verwandte Artikel

• Seite:
  Nutzungsbeispiele Java-Client