URL Converter mit der wsclient Bibliothek

Mindestanforderungen​

  • Java-Version: 7
  • webPDF-Version: 7
  • wsclient-Version: 1

URL Converter

In diesem Beitrag zeigen wir, wie Sie Webseiten mit dem URL-Converter-Webservice in PDF umwandeln.

Wichtiger Hinweis: Das folgende Coding-Beispiel basiert auf der Nutzung der webPDF-wsclient-Bibliothek.

Webservice aufrufen​

Zu Beginn sollten Sie bereits eine REST- oder SOAP-Session erzeugt haben. Über die WebServiceFactory können Sie entweder ein UrlConverterWebService-Objekt (SOAP) oder ein UrlConverterRestWebService-Objekt (REST) erstellen.

SOAP:

UrlConverterWebService urlConverterWebService =
    WebServiceFactory.createInstance(
        session, WebServiceType.URLCONVERTER
    );

REST:

UrlConverterRestWebService urlConverterWebService =
    WebServiceFactory.createInstance(
        session, WebServiceType.URLCONVERTER
    );

Anschließend übergeben Sie per setDocument() ein RestDocument oder SoapDocument.

Webservice-Parameter​

Für schreibende Zugriffe kann das open- und/oder permission-Passwort erforderlich sein:

urlConverterWebService.getPassword().setOpen("password");
urlConverterWebService.getPassword().setPermission("password");

Dieser Schritt ist nur relevant, wenn das Dokument passwortgeschützt ist.

URL Converter Webservice​

Der URL Converter ist ein Endpunkt des webPDF-Servers, mit dem Webseiten in PDF-Dokumente konvertiert werden.

Das UrlConverterType-Objekt erhalten Sie so:

UrlConverterType urlConverter = urlConverterWebService.getOperation();

Parameter am Objekt urlConverter​

url (Standardwert: "")​

Legt die URL der zu konvertierenden Webseite fest:

urlConverter.setUrl("https://www.webpdf.de");

Das Objekt page​

Zur Steuerung von Seitendimensionen und Rändern fügen Sie ein PageType-Objekt hinzu:

PageType page = new PageType();
urlConverter.setPage(page);

Wichtige Parameter:

  • width (Standardwert: 210): page.setWidth(800);
  • height (Standardwert: 297): page.setHeight(1600);
  • bottom (Standardwert: 20): page.setBottom(10);
  • top (Standardwert: 20): page.setTop(10);
  • left (Standardwert: 20): page.setLeft(10);
  • right (Standardwert: 20): page.setRight(10);
  • metrics (Standardwert: "mm"): page.setMetrics(MetricsType.MM);

Verfügbare Maßeinheiten:

  • mm = Millimeter
  • px = Pixel

Das Objekt basicAuth​

Wenn die Ziel-URL eine HTTP-Authentifizierung benötigt, setzen Sie ein HttpBasicAuthType-Objekt:

HttpBasicAuthType basicAuth = new HttpBasicAuthType();
urlConverter.setBasicAuth(basicAuth);

Parameter:

  • username (Standardwert: ""): basicAuth.setUserName("username");
  • password (Standardwert: ""): basicAuth.setPassword("password");

Das Objekt proxy​

Wenn der Zugriff über einen Proxy erfolgt, verwenden Sie ein HttpProxyType-Objekt:

HttpProxyType proxy = new HttpProxyType();
urlConverter.setProxy(proxy);

Parameter:

  • username (Standardwert: ""): proxy.setUserName("username");
  • password (Standardwert: ""): proxy.setPassword("password");
  • address (Standardwert: ""): proxy.setAddress("Proxy Adresse");
  • port (Standardwert: 0): proxy.setPort(8080);

Beispiel für den Webservice-Aufruf (SOAP)​

try (
    // Aufbau einer Session mit dem webPDF-Server (hier SOAP):
    SoapSession session = SessionFactory.createInstance(
        WebServiceProtocol.SOAP,
        new URL("https://localhost:8080/webPDF/")
    );

    // Bereitstellen von Quell- und Zieldokument:
    SoapDocument soapDocument = new SoapDocument(
        new File("Pfad des Quelldokuments").toURI(),
        new File("Pfad des Zieldokuments")
    )
) {
    // Webservice-Aufruf und Verarbeitung
} catch (ResultException | MalformedURLException ex) {
    // Fehlerbehandlung
}
  • Weitere Infos zur URL-Converter-Parameterstruktur und zu Error-Codes finden Sie in der Dokumentation.
  • Bitte beachten: Parameter haben Standardwerte und müssen nur bei Abweichung gesetzt werden.

Weitere Coding-Beispiele zur wsclient-Bibliothek finden Sie hier.