com.hp.autonomy.hod.client.api.textindex.status.TextIndexStatusService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-hod-client Show documentation

Java Client for communicating with HP Haven OnDemand

There is a newer version: 0.25.3

package com.hp.autonomy.hod.client.api.textindex.status;

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

public interface TextIndexStatusService {

    /**
     * Get status information for the given text index, using a TokenProxyService for authentication.
     * @param index The index identifier
     * @return Status information for the text index
     * @throws NullPointerException If a TokenProxyService has not been defined
     * @throws HodErrorException If HOD returns an error
     */
    TextIndexStatus getIndexStatus(ResourceIdentifier index) throws HodErrorException;

    /**
     * Get status information for the given text index, using the given token proxy for authentication.
     * @param tokenProxy Token proxy to authenticate the request
     * @param index The index identifier
     * @return Status information for the text index
     * @throws HodErrorException If HOD returns an error
     */
    TextIndexStatus getIndexStatus(TokenProxy tokenProxy, ResourceIdentifier index) throws HodErrorException;

}