Configure Custom Dependency

To configure custom dependency from the NCache Management Center, you need to provide the required provider details. Follow the steps shown below to configure custom dependency:

Important

For Java, before deploying your JAR files, ensure that your Environment Variable for Java Home is set and have the appropriate JDK installed as discussed in the NCache Installation Guide.

Using the NCache Management Center

  • Launch the NCache Management Center by browsing to http://localhost:8251 or <server-ip>:8251 for Windows and Linux.

  • In the left navigation bar, click on Clustered Caches or Local Caches based on the cache to configure.

Make sure that the cache is stopped.

NCache Management Center Clustered Caches

  • Against the required cache name, click on View Details.

  • This redirects to the detailed configuration page for the cache. Go to the Advanced Settings tab and left-click on Custom Dependency.

  • Check the Enable Custom Dependency box and click on the button to add a provider.

NCache Management Center Configure Custom Dependency

  • This will redirect you to the Add Custom Dependency Provider window. Here, enter the provider name in the Provider Name text box.

  • Click on the Browse button to select the JAR implementing the Custom Dependency Provider interface. Select the class name from the dropdown list.

NCache Management Center Add Custom Dependency Provider

  • You can also add parameters and their values to your custom dependency provider in the Parameter field. This step is optional.

NCache Management Center Custom Dependency Add Parameters

  • Click the OK button.

  • Your added provider will be listed under Custom Dependency in the Custom Dependency tab.

  • Now you need to deploy the custom dependency provider library along with its dependent assemblies, if there are any. For this, click on the Deploy Custom Dependency Provider button on the left bottom of the Custom Dependency tag.

NCache Management Center Deploy Custom Dependency Provider

  • From the pop-up window, Browse and select the required assemblies. Click Open to deploy these assemblies.

  • After applying all the changes, click on Save Changes.

Manually Editing Configuration

You can configure custom dependency through config.ncconf as follows:

<custom-dependency enable-custom-dependency="True">
    <provider provider-name="MyCustomDependencyProvider" assembly-name="CustomDependencyImpl, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" class-name="com.alachisoft.ncache.Samples.Providers.CustomDependencyProvider" full-name="CustomDependencyImpl.jar">
        <parameters name="server" value="server1"/>
        <parameters name="admin" value="admin1"/>
        <parameters name="password" value="password1"/>
    </provider>
</custom-dependency>
Note

Edit the service config tags to customize custom dependency, shown in the Custom Dependency section of NCache Service config.

Using Command Line Tools

Configure Custom Dependency

The add-customdependency tool configures custom dependency providers for the specified cache.

The following command enables the custom dependency provider against cache demoCache on server 20.200.20.40.

add-customdependency -cachename demoCache -assemblypath /user/CustomDependencyImpl.jar -class com.alachisoft.ncache.Samples.Providers.CustomDependencyProvider -providername MyCustomDependencyProvider -parameters key=value -server 20.200.20.40

Remove Custom Dependency

The remove-customdependency tool removes the preconfigured custom dependency provider from the cache or the specified server.

The following command removes the preconfigured custom dependency provider named MyCustomDependencyProvider from demoCache.

remove-customdependency -cachename demoCache -providername MyCustomDependencyProvider

See Also

Deploy Providers
Sync Cache Using Extensible Dependency
Sync Cache Using Bulk Extensible Dependency
Sync Cache Using Notification Extensible Dependency