Client Service Provider Interface (SPI) Java API

The following is the Java API of the client service provider interface:

/**
 * ClientAdapter is the interface use by OpenID Provider to authenticate client.
 * It is also for OpenID Provider to retrieve the clients scopes.
 * <p/>
 * A ClientAdapter is implemented by Portal Service who manages the client registration.
 *
 */
public interface ClientAdapter {
	 /**
	  * This method is called when the instance of the adapter is first loaded.
	  * The properties is a map of properties from SecurityRuntime.cfg.
	  * The adapter may initialize itself using these properties.
	  *
	 * @param properties a map of properties from SecurityRuntime.cfg.
	 */
	 public void init(Map<String, String> properties);
    /**
     * Authenticate the client with the specify id and secret.
     *
     * @param clientId client id to authenticate.
     * @param secret   secret to authenticate.
     * @return a DirectoryResult that has the result of the authentication.
     */
    public ClientResult authenticateClient(String clientId, String secret);
    /**
     * Retrieve scopes for the specify client.
     *
     * @param clientId the clientId to retrieve the scope.
     * @return return a map that contains information of the scopes.
     *         scope -> array of scopes
     *         description -> array of descriptions
     * @throws AdapterException an exception if failed to retrieve the scopes of the client.
     */
    public Map<String, String> getClientAttributes(String clientId)
            throws AdapterException;
}

Copyright © Cloud Software Group, Inc. All rights reserved.