Package com.authlete.common.api

Class AuthleteApiFactory

java.lang.Object

com.authlete.common.api.AuthleteApiFactory

public class AuthleteApiFactory
extends Object

Factory to create an AuthleteApi instance.

Author:

Takahiko Kawasaki

Method Summary

Modifier and Type	Method	Description
static AuthleteApi	create(AuthleteConfiguration configuration)	Create an instance of AuthleteApi.
static AuthleteApi	create(AuthleteConfiguration configuration, String className)	Create an instance of AuthleteApi from the specified class.
static AuthleteApi	getDefaultApi()	Get the default instance of AuthleteApi.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static AuthleteApi create(AuthleteConfiguration configuration)

Create an instance of AuthleteApi.

This method repeats to call create(AuthleteConfiguration, String) until one of the known classes is successfully instantiated.

The classes listed below are the ones that the current implementation knows for Authlete API V3.

1. com.authlete.jaxrs.api.AuthleteApiImplV3
   (using JAX-RS 2.0 API, contained in com.authlete:authlete-java-jaxrs)
2. com.authlete.jakarta.api.AuthleteApiImplV3
   (using Jakarta REST client API, contained in com.authlete:authlete-java-jakarta)
3. com.authlete.common.api.AuthleteApiImplV3
   (using HttpURLConnection, contained in com.authlete:authlete-java-common)

The classes listed below are the ones that the current implementation knows for Authlete API V2.

1. com.authlete.jaxrs.api.AuthleteApiImpl
   (using JAX-RS 2.0 API, contained in com.authlete:authlete-java-jaxrs)
2. com.authlete.common.api.AuthleteApiImpl
   (using HttpURLConnection, contained in com.authlete:authlete-java-common since version 2.0)

Parameters:

configuration - Authlete configuration.

Returns:

An instance of AuthleteApi. If none of the known classes that implement AuthleteApi interface was successfully instantiated, null is returned.

create

public static AuthleteApi create(AuthleteConfiguration configuration,
                                 String className)

Create an instance of AuthleteApi from the specified class.

Parameters:

configuration - Authlete configuration.

className - The name of a class that implements AuthleteApi interface. The class must have a constructor which takes one argument of type AuthleteConfiguration.

Returns:

An instance of the specified class.

Throws:

IllegalArgumentException -

• configuration is null.
• className is null.
• The specified class is not found.
• The specified class does not implement AuthleteApi interface.
• The specified class does not have a constructor which takes one argument of type AuthleteConfiguration.

IllegalStateException - The constructor of the specified class threw an exception.

getDefaultApi

public static AuthleteApi getDefaultApi()

Get the default instance of AuthleteApi.

This method loads a configuration file (using AuthletePropertiesConfiguration) on the first call, creates an instance of AuthleteApi and caches the instance. The second and subsequent calls return the cached instance.

The default name of the configuration file is authlete.properties, but it can be changed by a system property authlete.configuration.file. The current directory and the classpath are searched for the configuration file in this order.

Returns:

An instance of AuthleteApi.

Since:

1.29