com.ontotext.s4.service.ServiceClientsFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of s4-client Show documentation
The Self-Service Semantic Suite (S4) provides a set of services for low-cost, on-demand text analytics and metadata management in the cloud.
The newest version!
/*
 * S4 Java client library
 * Copyright 2016 Ontotext AD
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.ontotext.s4.service;

import java.net.URL;

import com.ontotext.s4.catalog.ServiceDescriptor;
import com.ontotext.s4.catalog.ServicesCatalog;
import com.ontotext.s4.service.impl.S4AnnotationClientImpl;
import com.ontotext.s4.service.impl.S4ClassificationClientImpl;


public class ServiceClientsFactory {
    /**
     * Constructs an {@link S4AnnotationClient} to be used with the text annotation services ('news', 'news-de', 'sbt', 'twitie', etc.)
     *
     * @param service The service name to be used 
     * @param apiKey Your S4 API Key
     * @param keySecret Your S4 Key Secret
     * @return An {@link S4AnnotationClient} to access the S4 text annotation services
     */
    public static S4AnnotationClient createAnnotationClient (String service, String apiKey, String keySecret) {
        return createAnnotationClient(ServicesCatalog.getItem(service), apiKey, keySecret);
    }
    
    /**
     * Constructs an {@link S4AnnotationClient} to be used with the text annotation services ('news', 'news-de', 'sbt', 'twitie', etc.)
     *
     * @param serviceDescriptor Wrap object for the service URL
     * @param apiKey Your S4 API Key
     * @param keySecret Your S4 Key Secret
     * @return An {@link S4AnnotationClient} to access the S4 text annotation 'news', 'news-de', 'sbt' or 'twitie' services
     */
    public static S4AnnotationClient createAnnotationClient (ServiceDescriptor serviceDescriptor, String apiKey, String keySecret) {
        return new S4AnnotationClientImpl(serviceDescriptor, apiKey, keySecret);
    }

    /**
     * Constructs an {@link S4AnnotationClient} to be used with the text annotation services ('news', 'news-de', 'sbt', 'twitie', etc.)
     *
     * @param serviceURL The service endpoint URL
     * @param apiKey Your S4 API Key
     * @param keySecret Your S4 Key Secret
     * @return An {@link S4AnnotationClient} to access the S4 text annotation 'news', 'news-de', 'sbt' or 'twitie' services
     */
    public static S4AnnotationClient createAnnotationClient (URL serviceURL, String apiKey, String keySecret) {
        return new S4AnnotationClientImpl(serviceURL, apiKey, keySecret);
    }

    /**
     * Constructs an {@link S4ClassificationClient} to be used with the text classification service ('news-classifier')
     *
     * @param apiKey Your S4 Api Key
     * @param keySecret Your S4 Key Secret
     * @return An {@link S4ClassificationClient} to access the S4 'news-classifier' service
     */
    public static S4ClassificationClient createClassificationClient(String apiKey, String keySecret) {
        return new S4ClassificationClientImpl(ServicesCatalog.getItem("news-classifier"), apiKey, keySecret);
    }
    
    
    /**
     * Constructs an {@link S4ClassificationClient} to be used with the text classification service ('news-classifier')
     *
     * @param serviceURL The URL of the classification service
     * @param apiKey Your S4 Api Key
     * @param keySecret Your S4 Key Secret
     * @return An {@link S4ClassificationClient} to access the S4 'news-classifier' service
     */
    public static S4ClassificationClient createClassificationClient(URL serviceURL, String apiKey, String keySecret) {
        return new S4ClassificationClientImpl(serviceURL, apiKey, keySecret);
    }
}