• Home
• com.softlayer.api
• softlayer-api-client
• 0.3.4
• source code
• ApiClient.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.softlayer.api.ApiClient Maven / Gradle / Ivy

package com.softlayer.api;

import com.softlayer.api.http.HttpCredentials;

/** Common interface for all API clients. {@link RestApiClient} is the preferred implementation */
public interface ApiClient {
    
    /**
     * Set the username and API key credentials. This is required for most service methods.
     *
     * @return This instance
     */
    ApiClient withCredentials(String username, String apiKey);

    /**
     * Uses a HTTP Bearer token for authentication instead of API key.
     *
     * @return This instance
     */
    ApiClient withBearerToken(String token);

    /**
    * Enables logging for client API calls
    *
    * @return This instance
    */
    ApiClient withLoggingEnabled();

    /**
    * Returns the HTTP Authorization header
    *
    * @return This instance
    */
    HttpCredentials getCredentials();

    /**
     * Get a service for the given sets of classes and optional ID. It is not recommended to call this
     * directly, but rather invoke the service method on the type class.
     * E.g. {@link com.softlayer.api.service.Account#service(ApiClient)}.
     */
     S createService(Class serviceClass, String id);
}