com.hp.autonomy.searchcomponents.hod.databases.ResourceMapper Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 Hewlett-Packard Development Company, L.P.
 * Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
 */

package com.hp.autonomy.searchcomponents.hod.databases;

import com.hp.autonomy.hod.client.api.authentication.TokenType;
import com.hp.autonomy.hod.client.api.resource.Resource;
import com.hp.autonomy.hod.client.error.HodErrorException;
import com.hp.autonomy.hod.client.token.TokenProxy;

import java.util.Set;

/**
 * Maps resource names into databases
 */
public interface ResourceMapper {

    /**
     * Maps the given resource names in the given domain into instances of {@link Database}
     * @param tokenProxy The token proxy to use. May be null.
     * @param resources The resources to map.
     * @param domain The domain in which the resources reside.
     * @return A set of Databases corresponding to the resource names
     * @throws HodErrorException
     */
    Set map(TokenProxy tokenProxy, Set resources, String domain) throws HodErrorException;

}