How to Validate an XML File using Java

Lots of things can go wrong with XML files. That’s why it’s good practice to validate your XML files before storing them or using them. Our XML Validation API will do exactly that, and it’ll return key information about the file including an error count & warning count, along with a Boolean declaring if the file was password-protected. To help you take advantage of this API, we’ll walk through how to easily structure your API call using Java code snippets below.

To begin installing the Java SDK with Maven, add a reference to the pom.xml repository:

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

Next, include one in the pom.xml dependency:

<dependencies>
<dependency>
    <groupId>com.github.Cloudmersive</groupId>
    <artifactId>Cloudmersive.APIClient.Java</artifactId>
    <version>v4.25</version>
</dependency>
</dependencies>

With installation finished, add the import classes below and call the function:

// Import classes:
//import com.cloudmersive.client.invoker.ApiClient;
//import com.cloudmersive.client.invoker.ApiException;
//import com.cloudmersive.client.invoker.Configuration;
//import com.cloudmersive.client.invoker.auth.*;
//import com.cloudmersive.client.ValidateDocumentApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: Apikey
ApiKeyAuth Apikey = (ApiKeyAuth) defaultClient.getAuthentication("Apikey");
Apikey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.setApiKeyPrefix("Token");
ValidateDocumentApi apiInstance = new ValidateDocumentApi();
File inputFile = new File("/path/to/inputfile"); // File | Input file to perform the operation on.
try {
    DocumentValidationResult result = apiInstance.validateDocumentXmlValidation(inputFile);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ValidateDocumentApi#validateDocumentXmlValidation");
    e.printStackTrace();
}

To satisfy the API key parameter, register a free account on our website & you’ll receive an API key.

For your reference, a sample response model is available below:

{
  "DocumentIsValid": true,
  "PasswordProtected": true,
  "ErrorCount": 0,
  "WarningCount": 0,
  "ErrorsAndWarnings": [
    {
      "Description": "string",
      "Path": "string",
      "Uri": "string",
      "IsError": true
    }
  ]
}