Uses of Class
net.webpdf.wsclient.exception.ResultException
-
-
Uses of ResultException in net.webpdf.wsclient.exception
Subclasses of ResultException in net.webpdf.wsclient.exception Modifier and Type Class Description classAuthResultExceptionAn instance ofAuthResultExceptionindicates some error during the execution of a usedAuthProvider.
The actualExceptioncan be requested by callingThrowable.getCause().classClientResultExceptionAn instance ofClientResultExceptionwill be encountered in case a wsclient operation failed on the client´s side.classServerResultExceptionAn instance ofServerResultExceptionindicates, that some fail state occurred webPDF server while executing your request.Methods in net.webpdf.wsclient.exception that return ResultException Modifier and Type Method Description @NotNull ResultExceptionClientResultException. appendMessage(@Nullable String message)Appends the given text to the end of the message describing thisResultException. -
Uses of ResultException in net.webpdf.wsclient.session
Methods in net.webpdf.wsclient.session that throw ResultException Modifier and Type Method Description voidSession. close()Close theSession.static <T_SESSION extends Session>
T_SESSIONSessionFactory. createInstance(@NotNull SessionContext sessionContext)Creates a HTTP or HTTPSSessionwith a webPDF server, based on the givenSessionContext.static <T_SESSION extends Session>
T_SESSIONSessionFactory. createInstance(@NotNull SessionContext sessionContext, @NotNull AuthProvider authProvider)Creates a HTTP or HTTPSSessionwith a webPDF server, based on the givenSessionContextandAuthProvider.@NotNull AuthMaterialAbstractSession. getAuthMaterial()ProvidesAuthMaterialfor the authorization of theSession´s requests, using theSession´sAuthProvider.@NotNull AuthMaterialSession. getAuthMaterial()ProvidesAuthMaterialfor the authorization of theSession´s requests, using theSession´sAuthProvider.@NotNull URIAbstractSession. getURI(@NotNull String subPath)Returns anURIpointing to the webservice interface of the session.@NotNull URIAbstractSession. getURI(@NotNull String subPath, List<org.apache.hc.core5.http.NameValuePair> parameters)Returns anURIpointing to the webservice interface of the session.@NotNull URISession. getURI(@NotNull String subPath, List<org.apache.hc.core5.http.NameValuePair> parameters)Returns anURIpointing to the webservice interface of the session.@NotNull URISession. getURI(String subPath)Returns anURIpointing to the webservice interface of the session.Constructors in net.webpdf.wsclient.session that throw ResultException Constructor Description AbstractSession(@NotNull WebServiceProtocol webServiceProtocol, @NotNull SessionContext serverContext, @NotNull AuthProvider authProvider)Creates a newAbstractRestSessioninstance providing connection information and authorization objects for a webPDF server-clientSession. -
Uses of ResultException in net.webpdf.wsclient.session.auth
Constructors in net.webpdf.wsclient.session.auth that throw ResultException Constructor Description UserAuthProvider(@NotNull String userName, char @NotNull [] password)Creates a newUserAuthProviderprovider for the given userName and password.
Be aware: The given values may not be empty.UserAuthProvider(@NotNull String userName, @NotNull String password)Creates a newUserAuthProviderfor the given userName and password.
Be aware: The given values may not be empty. -
Uses of ResultException in net.webpdf.wsclient.session.connection.http
Methods in net.webpdf.wsclient.session.connection.http that throw ResultException Modifier and Type Method Description @NotNull HttpRestRequestHttpRestRequest. buildRequest(@NotNull HttpMethod httpMethod, @NotNull String path, @Nullable org.apache.hc.core5.http.HttpEntity httpEntity)Prepare theHttpRestRequestto execute the selectedHttpMethodon the given resource path (URI) and providing the givenHttpEntityas it´s data transfer object (parameters).@NotNull HttpRestRequestHttpRestRequest. buildRequest(@NotNull HttpMethod httpMethod, @NotNull String path, @Nullable org.apache.hc.core5.http.HttpEntity httpEntity, @Nullable AuthMaterial authMaterial)Prepare theHttpRestRequestto execute the selectedHttpMethodon the given resource path (URI) and providing the givenHttpEntityas it´s data transfer object (parameters).@NotNull HttpRestRequestHttpRestRequest. buildRequest(@NotNull HttpMethod httpMethod, @NotNull URI uri, @Nullable org.apache.hc.core5.http.HttpEntity httpEntity)Prepare theHttpRestRequestto execute the selectedHttpMethodon the given resource path (URI) and providing the givenHttpEntityas it´s data transfer object (parameters).@NotNull HttpRestRequestHttpRestRequest. buildRequest(@NotNull HttpMethod httpMethod, @NotNull URI uri, @Nullable org.apache.hc.core5.http.HttpEntity httpEntity, @Nullable AuthMaterial authMaterial)Prepare theHttpRestRequestto execute the selectedHttpMethodon the given (URI) and providing the givenHttpEntityas it´s data transfer object (parameters).voidHttpRestRequest. executeRequest(@NotNull OutputStream outputStream)Executes thisHttpRestRequestand shall write the contained data transfer objectHttpEntityto the givenOutputStream.<T> THttpRestRequest. executeRequest(@NotNull Class<T> type)ExecutesHttpRestRequestand shall attempt to translate the response´s data transfer object (HttpEntity) to an instance of the given type. -
Uses of ResultException in net.webpdf.wsclient.session.connection.https
Methods in net.webpdf.wsclient.session.connection.https that throw ResultException Modifier and Type Method Description @NotNull SSLContextTLSContext. create()Returns (and/or initializes) theSession´sSSLContext. -
Uses of ResultException in net.webpdf.wsclient.session.rest
Methods in net.webpdf.wsclient.session.rest that throw ResultException Modifier and Type Method Description voidAbstractRestSession. close()Close theRestSession.<T_WEBSERVICE extends RestWebService<?,?,?>>
T_WEBSERVICERestSession. createWebServiceInstance(@NotNull WebServiceType webServiceType)Creates a matchingRestWebServiceinstance to execute a webPDF operation for the current session.<T_WEBSERVICE extends RestWebService<?,?,?>>
T_WEBSERVICERestWebServiceSession. createWebServiceInstance(@NotNull WebServiceType webServiceType)Creates a matchingRestWebServiceinstance to execute a webPDF operation for the current session.T_REST_DOCUMENTRestSession. uploadDocument(@NotNull File source)This is a shortcut forDocumentManager.uploadDocument(File)and uploads the given source to the webPDF server.T_REST_DOCUMENTRestSession. uploadDocument(@NotNull InputStream source, @NotNull String documentName)This is a shortcut forDocumentManager.uploadDocument(InputStream, String)and uploads the given source to the webPDF server.@NotNull RestWebServiceDocumentRestWebServiceSession. uploadDocument(@NotNull File source)This is a shortcut forDocumentManager.uploadDocument(File)and uploads the given source to the webPDF server.@NotNull RestWebServiceDocumentRestWebServiceSession. uploadDocument(@NotNull InputStream source, @NotNull String documentName)This is a shortcut forDocumentManager.uploadDocument(InputStream, String)and uploads the given source to the webPDF server.Constructors in net.webpdf.wsclient.session.rest that throw ResultException Constructor Description AbstractRestSession(@NotNull SessionContext serverContext, @NotNull AuthProvider authProvider)Creates a newAbstractRestSessioninstance providing connection information, authorization objects and aDocumentManagerfor a webPDF server-clientRestSession.RestWebServiceSession(@NotNull SessionContext serverContext, @NotNull AuthProvider authProvider)Creates a newRestWebServiceSessioninstance providing connection information, authorization objects and aRestWebServiceDocumentManagerfor a webPDF server-clientRestSession. -
Uses of ResultException in net.webpdf.wsclient.session.rest.documents
Methods in net.webpdf.wsclient.session.rest.documents that throw ResultException Modifier and Type Method Description protected abstract T_REST_DOCUMENTAbstractDocumentManager. createDocument(@NotNull String documentId)Creates a newRestDocumentfor the given document ID.voidAbstractDocumentManager. deleteDocument(@NotNull String documentId)Deletes theRestDocumentwith the given document ID from the webPDF server.voidDocumentManager. deleteDocument(@NotNull String documentId)Deletes theRestDocumentwith the given document ID from the webPDF server.voidAbstractDocumentManager. downloadDocument(@NotNull String documentId, @NotNull OutputStream outputStream)Downloads theRestDocumentwith the given document ID and writes it to the givenOutputStream.voidAbstractDocumentManager. downloadDocument(@Nullable RestDocument document, @NotNull OutputStream outputStream)Downloads theRestDocumentand writes it to the givenOutputStream.voidDocumentManager. downloadDocument(@NotNull String documentId, @NotNull OutputStream outputStream)Downloads theRestDocumentwith the given document ID and writes it to the givenOutputStream.voidDocumentManager. downloadDocument(@Nullable RestDocument document, @NotNull OutputStream outputStream)Downloads theRestDocumentand writes it to the givenOutputStream.voidRestDocument. downloadDocument(@NotNull File target)This is a shortcut forDocumentManager.downloadDocument(RestDocument, OutputStream)and Attempts to download and write theRestDocumentto the givenFile.voidRestDocument. downloadDocument(@NotNull OutputStream target)This is a shortcut forDocumentManager.downloadDocument(RestDocument, OutputStream)and Attempts to download and write theRestDocumentto the givenOutputStream.voidRestWebServiceDocument. downloadDocument(@NotNull File target)This is a shortcut forDocumentManager.downloadDocument(RestDocument, OutputStream)and Attempts to download write theRestDocumentto the givenFile.voidRestWebServiceDocument. downloadDocument(@NotNull OutputStream target)This is a shortcut forDocumentManager.downloadDocument(RestDocument, OutputStream)and Attempts to download and write theRestDocumentto the givenOutputStream.T_REST_DOCUMENTAbstractDocumentManager. getDocument(@NotNull String documentId)Returns theRestDocumentthat is known to theDocumentManagerfor the given document ID.T_REST_DOCUMENTDocumentManager. getDocument(@NotNull String documentId)Returns theRestDocumentthat is known to theDocumentManagerfor the given document ID.@NotNull List<HistoryEntry>AbstractDocumentManager. getDocumentHistory(@NotNull String documentId)Returns theHistoryEntrys known for theRestDocumentwith the given document ID.@NotNull List<HistoryEntry>DocumentManager. getDocumentHistory(@NotNull String documentId)Returns theHistoryEntrys known for theRestDocumentwith the given document ID.@NotNull HistoryEntryAbstractDocumentManager. getDocumentHistoryEntry(@NotNull String documentId, int historyId)Returns theHistoryEntrywith the given history ID for theRestDocumentwith the given document ID.@NotNull HistoryEntryDocumentManager. getDocumentHistoryEntry(@NotNull String documentId, int historyId)Returns theHistoryEntrywith the given history ID for theRestDocumentwith the given document ID.@NotNull StringAbstractDocumentManager. getDocumentID(@NotNull DocumentFile document)Returns the document ID the givenDocumentFileis known by to thisDocumentManager.@NotNull StringDocumentManager. getDocumentID(@NotNull DocumentFile document)Returns the document ID the givenDocumentFileis known by to thisDocumentManager.@NotNull HistoryEntryRestDocument. getHistoryEntry(int historyId)Returns aHistoryEntryfrom the internal history map, by given history ID.@NotNull HistoryEntryRestDocumentState. getHistoryEntry(int historyId)Returns aHistoryEntryfrom the internal history map, by given history ID.@NotNull HistoryEntryRestWebServiceDocument. getHistoryEntry(int historyId)Returns aHistoryEntryfrom the internal history map, by given history ID.@NotNull HistoryEntryRestWebServiceDocumentState. getHistoryEntry(int historyId)Returns aHistoryEntryfrom the internal history map, by given history ID.@NotNull HistoryEntryRestWebServiceDocumentState. lastHistory()Returns the most recentHistoryEntry.T_REST_DOCUMENTAbstractDocumentManager. renameDocument(@NotNull String documentId, @NotNull String fileName)Rename theRestDocumentwith the given document ID.T_REST_DOCUMENTDocumentManager. renameDocument(@NotNull String documentId, @NotNull String fileName)Rename theRestDocumentwith the given document ID.voidAbstractDocumentManager. setDocumentHistoryActive(boolean documentHistoryActive)Sets whether a document history shall be collected for managedRestDocuments.voidDocumentManager. setDocumentHistoryActive(boolean documentHistoryActive)Sets whether a document history shall be collected for managedRestDocuments.voidRestDocumentState. setHistory(@NotNull HistoryEntry[] historyEntries)Replaces the internally storedHistoryEntrylist of the managedRestDocumentvoidRestWebServiceDocumentState. setHistory(@NotNull HistoryEntry[] historyEntries)Replaces the internally storedHistoryEntrylist of the managedRestDocument@NotNull List<T_REST_DOCUMENT>AbstractDocumentManager. synchronize()Synchronizes theRestDocuments of thisDocumentManagerwith the actually uploaded documents of the webPDF server.T_REST_DOCUMENTAbstractDocumentManager. synchronize(@NotNull DocumentFile documentFile)@NotNull List<T_REST_DOCUMENT>DocumentManager. synchronize()Synchronizes theRestDocuments of thisDocumentManagerwith the actually uploaded documents of the webPDF server.T_REST_DOCUMENTDocumentManager. synchronize(@NotNull DocumentFile documentFile)@Nullable HistoryEntryAbstractDocumentManager. updateDocumentHistory(@NotNull String documentId, @NotNull HistoryEntry historyEntry)Updates the history of theRestDocumentwith the given document ID using the givenHistoryEntry.@Nullable HistoryEntryDocumentManager. updateDocumentHistory(@NotNull String documentId, @NotNull HistoryEntry historyEntry)Updates the history of theRestDocumentwith the given document ID using the givenHistoryEntry.voidRestDocumentState. updateHistoryEntry(@NotNull HistoryEntry historyEntry)Updates the givenHistoryEntryin the internally managed document history.voidRestWebServiceDocumentState. updateHistoryEntry(@NotNull HistoryEntry historyEntry)Updates the givenHistoryEntryin the internally managed document history.T_REST_DOCUMENTAbstractDocumentManager. uploadDocument(@NotNull File file)Uploads the givenFileto the webPDF server, adds it to thisDocumentManagerand returns the resultingRestDocumenthandle.T_REST_DOCUMENTAbstractDocumentManager. uploadDocument(@NotNull InputStream data, @NotNull String fileName)Uploads the givenInputStreamto the webPDF server as a document resource with the given file name, adds it to thisDocumentManagerand returns the resultingRestDocumenthandle.T_REST_DOCUMENTDocumentManager. uploadDocument(@NotNull File file)Uploads the givenFileto the webPDF server, adds it to thisDocumentManagerand returns the resultingRestDocumenthandle.T_REST_DOCUMENTDocumentManager. uploadDocument(@NotNull InputStream data, @NotNull String fileName)Uploads the givenInputStreamto the webPDF server as a document resource with the given file name, adds it to thisDocumentManagerand returns the resultingRestDocumenthandle. -
Uses of ResultException in net.webpdf.wsclient.session.soap
Methods in net.webpdf.wsclient.session.soap that throw ResultException Modifier and Type Method Description T_SOAP_DOCUMENTSoapSession. createDocument(@NotNull File source)Creates aSoapDocumentoriginating from the givenFile.T_SOAP_DOCUMENTSoapSession. createDocument(@NotNull InputStream source)Creates aSoapDocumentoriginating from the givenInputStream.
Be aware: This copies all remaining bytes from the givenInputStreamto an array, to create a reusableBinaryDataSource.
Especially for large files using this is ill advised, using the alternative constructorsSoapSession.createDocument(URI)orSoapSession.createDocument(File)is always recommended.T_SOAP_DOCUMENTSoapSession. createDocument(@NotNull URI source)Creates aSoapDocumentoriginating from the givenURI.@NotNull SoapWebServiceDocumentSoapWebServiceSession. createDocument(@NotNull File source)Creates aSoapDocumentoriginating from the givenFile.@NotNull SoapWebServiceDocumentSoapWebServiceSession. createDocument(@NotNull InputStream source)Creates aSoapDocumentoriginating from the givenInputStream.@NotNull SoapWebServiceDocumentSoapWebServiceSession. createDocument(@NotNull URI source)Creates aSoapDocumentoriginating from the givenURI.<T_WEBSERVICE extends SoapWebService<?,?,?>>
T_WEBSERVICESoapSession. createWebServiceInstance(@NotNull WebServiceType webServiceType)Creates a matchingSoapWebServiceinstance to execute a webPDF operation for the current session.<T_WEBSERVICE extends SoapWebService<?,?,?>>
T_WEBSERVICESoapWebServiceSession. createWebServiceInstance(@NotNull WebServiceType webServiceType)Creates a matchingSoapWebServiceinstance to execute a webPDF operation for the current session.Constructors in net.webpdf.wsclient.session.soap that throw ResultException Constructor Description AbstractSoapSession(@NotNull SessionContext serverContext, @NotNull AuthProvider authProvider)Creates a newAbstractSoapSessioninstance providing connection information and authorization objects for a webPDF server-clientSoapSession.SoapWebServiceSession(@NotNull SessionContext serverContext, @NotNull AuthProvider authProvider)Creates a newSoapWebServiceSessioninstance providing connection information, authorization objects for a webPDF server-clientSoapSession. -
Uses of ResultException in net.webpdf.wsclient.session.soap.documents
Methods in net.webpdf.wsclient.session.soap.documents that throw ResultException Modifier and Type Method Description voidSoapDocument. close()Closes the documentsDataHandlers.voidSoapWebServiceDocument. close()Closes the documentsDataHandlers.voidSoapDocument. writeResult(@NotNull File target)Attempts to write theWebServiceProtocol.SOAPresponse document to the givenFile.voidSoapDocument. writeResult(@NotNull OutputStream target)Attempts to write theWebServiceProtocol.SOAPresponse document to the givenOutputStream.voidSoapWebServiceDocument. writeResult(@NotNull File target)Attempts to write theWebServiceProtocol.SOAPresponse document to the givenFile.voidSoapWebServiceDocument. writeResult(@NotNull OutputStream target)Attempts to write the responseSoapDocumentto the givenDataHandler.Constructors in net.webpdf.wsclient.session.soap.documents that throw ResultException Constructor Description SoapWebServiceDocument(@NotNull File source)Manages aSoapDocumentoriginating from the givenFile.SoapWebServiceDocument(@NotNull InputStream source)Manages aSoapDocumentoriginating from the givenInputStream.SoapWebServiceDocument(@NotNull URI source)Manages aSoapDocumentoriginating from the givenURI. -
Uses of ResultException in net.webpdf.wsclient.session.soap.documents.datasource
Methods in net.webpdf.wsclient.session.soap.documents.datasource that throw ResultException Modifier and Type Method Description voidBinaryDataSource. close()Deletes the underlying tempFile. -
Uses of ResultException in net.webpdf.wsclient.tools
Methods in net.webpdf.wsclient.tools that throw ResultException Modifier and Type Method Description static <T> TSerializeHelper. fromJSON(@Nullable StreamSource streamSource, @NotNull Class<T> type)Deserialize the data transfer object to the given type from the givenDataFormat.JSONStreamSource.static <T> TSerializeHelper. fromJSON(@Nullable org.apache.hc.core5.http.HttpEntity httpEntity, @NotNull Class<T> type)Deserialize the data transfer object to the given type from the givenDataFormat.JSONHttpEntity.static <T> TSerializeHelper. fromXML(@Nullable StreamSource streamSource, @NotNull Class<T> type)Deserialize the data transfer object to the given type from the givenDataFormat.XMLStreamSource.static <T> TSerializeHelper. fromXML(@Nullable org.apache.hc.core5.http.HttpEntity httpEntity, @NotNull Class<T> type)Deserialize the data transfer object to the given type from the givenDataFormat.XMLHttpEntity.static @NotNull StringSerializeHelper. toJSON(@Nullable Object object)Serialize a data transfer object toDataFormat.JSONstatic @NotNull StringSerializeHelper. toXML(@Nullable Object object, @NotNull Class<?> type)Serialize a data transfer object toDataFormat.XML. -
Uses of ResultException in net.webpdf.wsclient.webservice
Methods in net.webpdf.wsclient.webservice that throw ResultException Modifier and Type Method Description static <T_DOCUMENT extends Document,T_WEBSERVICE extends WebService<?,?,T_DOCUMENT,?,?,?>>
T_WEBSERVICEWebServiceFactory. createInstance(@NotNull Session session, @NotNull StreamSource streamSource)Creates a matchingWebServiceinstance to execute a webPDF operation.static <T_DOCUMENT extends Document,T_WEBSERVICE extends WebService<?,?,T_DOCUMENT,?,?,?>>
T_WEBSERVICEWebServiceFactory. createInstance(@NotNull Session session, @NotNull WebServiceType webServiceType)Creates a matchingWebServiceinstance to execute a webPDF operation.T_DOCUMENTWebService. process()Execute the webservice operation and return the resultingWebService.T_DOCUMENTWebService. process(T_DOCUMENT sourceDocument)Execute the webservice operation for the given sourceWebServiceand return the resultingWebService. -
Uses of ResultException in net.webpdf.wsclient.webservice.rest
Methods in net.webpdf.wsclient.webservice.rest that throw ResultException Modifier and Type Method Description T_REST_DOCUMENTRestWebService. process()Execute the webservice operation and return the resultingRestWebService.protected T_REST_DOCUMENTRestWebService. process(@NotNull String urlPath)Execute the webservice operation for the given urlPath and return the resultingRestWebService.T_REST_DOCUMENTRestWebService. process(T_REST_DOCUMENT sourceDocument)Execute the webservice operation for the given sourceRestWebServiceand return the resultingRestWebService. -
Uses of ResultException in net.webpdf.wsclient.webservice.soap
Methods in net.webpdf.wsclient.webservice.soap that throw ResultException Modifier and Type Method Description protected @NotNull URLSoapWebService. getWsdlDocumentLocation()Returns theURLof the wsdl document.T_SOAP_DOCUMENTSoapWebService. process()Execute the webservice operation and return the resultingSoapWebService.
You can write the result of the webservice call via:SoapDocument.writeResult(File)orSoapDocument.writeResult(OutputStream)T_SOAP_DOCUMENTSoapWebService. process(T_SOAP_DOCUMENT sourceDocument)Execute the webservice operation for the given sourceSoapWebServiceand return the resultingSoapWebService.
You can write the result of the webservice call via:SoapDocument.writeResult(File)orSoapDocument.writeResult(OutputStream)on either the returned or the source document.protected @NotNull BarcodeBarcodeWebService. provideWebServicePort()Create a matchingBarcodewebservice port for future executions of thisSoapWebService.protected @NotNull ConverterConverterWebService. provideWebServicePort()Create a matchingConverterwebservice port for future executions of thisSoapWebService.protected @NotNull OCROcrWebService. provideWebServicePort()Create a matchingOCRwebservice port for future executions of thisSoapWebService.protected @NotNull PdfaPdfaWebService. provideWebServicePort()Create a matchingPdfawebservice port for future executions of thisSoapWebService.protected @NotNull SignatureSignatureWebService. provideWebServicePort()Create a matchingSignaturewebservice port for future executions of thisSoapWebService.protected abstract T_WEBPDF_PORTSoapWebService. provideWebServicePort()Create a matching webservice port for future executions of thisSoapWebService.protected @NotNull ToolboxToolboxWebService. provideWebServicePort()Create a matchingToolboxwebservice port for future executions of thisSoapWebService.protected @NotNull URLConverterUrlConverterWebService. provideWebServicePort()Create a matchingURLConverterwebservice port for future executions of thisSoapWebService.
-