Install GroupDocs.Assembly for Java and Apply License Leave feedback

Before you can start generating documents with GroupDocs.Assembly for Java, you need to install the library and apply a license. This guide shows you how to add the package to your Maven or Gradle project and configure licensing to remove evaluation limitations.

The main classes involved are:

• License - for applying licenses
• DocumentAssembler - for assembling documents

Here are the steps to get started:

• Add the GroupDocs Artifact Repository and the GroupDocs.Assembly dependency to your Maven or Gradle build
• Apply a license from a file or stream using the License.setLicense method
• Verify that the license is applied correctly before using DocumentAssembler

Note

Calling License.setLicense multiple times is not harmful but wastes processor time. In desktop or console applications, call it once during startup (for example, at the beginning of the main method). In web applications, call it once during application initialization (for example, in the contextInitialized method of a ServletContextListener).

The easiest way to install GroupDocs.Assembly is to reference it in your Maven project. All GroupDocs packages are hosted at the GroupDocs Artifact Repository.

1. Add the GroupDocs Artifact Repository to your pom.xml file:

<repositories>
    <repository>
        <id>GroupDocs Artifact Repository</id>
        <name>GroupDocs Artifact Repository</name>
        <url>https://releases.groupdocs.com/java/repo/</url>
    </repository>
</repositories>

2. Add GroupDocs.Assembly as a dependency (use the latest available version):

<dependencies>
    <dependency>
        <groupId>com.groupdocs</groupId>
        <artifactId>groupdocs-assembly</artifactId>
        <version>26.10</version>
    </dependency>
</dependencies>

Alternatively, you can add the repository and the dependency to your build.gradle file:

repositories {
    maven { url 'https://releases.groupdocs.com/java/repo/' }
}

dependencies {
    implementation 'com.groupdocs:groupdocs-assembly:26.10'
}

After installation, apply your license file to remove evaluation limitations:

import com.groupdocs.assembly.*;

public static void applyLicenseFromFile() throws Exception
{
    // Path to your license file
    String licensePath = "GroupDocs.Assembly.lic";

    // Apply the license
    License license = new License();
    license.setLicense(licensePath);

    System.out.println("License applied successfully from file.");
}

You can also load a license from a stream:

import com.groupdocs.assembly.*;
import java.io.*;

public static void applyLicenseFromStream() throws Exception
{
    // Load license file into a stream
    try (InputStream stream = new FileInputStream("GroupDocs.Assembly.lic"))
    {
        License license = new License();
        license.setLicense(stream);

        System.out.println("License applied successfully from stream.");
    }
}

To verify that your license is applied correctly, call the isLicensed method of the License class. You can also check for evaluation watermarks in generated documents. If no watermarks appear, the license is active.

import com.groupdocs.assembly.*;

public static void verifyLicense() throws Exception
{
    License license = new License();
    license.setLicense("GroupDocs.Assembly.lic");

    // Check whether the license has been applied
    System.out.println("License applied: " + license.isLicensed());

    // Try to assemble a simple document
    DocumentAssembler assembler = new DocumentAssembler();
    // If license is valid, no evaluation watermark will appear
    System.out.println("License verification: Check generated documents for watermarks.");
}

Warning

The license file contains a digital signature. Do not modify the license file, as even adding an extra line break will invalidate it.

To learn more about licensing options including metered licensing, please refer to the advanced usage section.

You may easily run the code above and see the feature in action in our GitHub examples:

• GroupDocs.Assembly for Java examples, plugins, and showcase
• GroupDocs.Assembly for .NET examples, plugins, and showcase
• GroupDocs.Assembly for Python via .NET examples, plugins, and showcase

Along with the full-featured Java library, we provide simple but powerful free online apps.

To assemble documents from templates and data sources, you can use the online apps from the GroupDocs.Assembly App Product Family.