org.johnnei.enjin.IEnjinApiFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of enjin-api-spec Show documentation

The specification of the Enjin API

The newest version!

package org.johnnei.enjin;

public interface IEnjinApiFactory {

	/**
	 * Creates an {@link IEnjinApi} instance for the given url
	 * @param url
	 *        The url on which the Enjin API is available.
	 */
	IEnjinApi createForDomain(String url);

	/**
	 * Creates an {@link IEnjinApi} instance for the given url
	 * @param url
	 *        The url on which the Enjin API is available.
	 * @param readOnly
	 *        If the API access at the given url is configured to be read-only.
	 */
	IEnjinApi createForDomain(String url, boolean readOnly);

	/**
	 * Creates an {@link IEnjinApi} instance for the given url
	 * @param url
	 *        The url on which the Enjin API is available.
	 * @param readOnly
	 *        If the API access at the given url is configured to be read-only.
	 * @param apiKey
	 *        The API key to authenticate as the website. null will be treated as not allowed to
	 *        authenticate as the website.
	 */
	IEnjinApi createForDomain(String url, boolean readOnly, String apiKey);

}