blob: e6e1254a6b54077ed8b8bf323ee1bac9b11ec1b8 [file] [log] [blame]
/*
* Copyright (c) 2015 Eike Stepper (Berlin, Germany) and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Eike Stepper - initial API and implementation
*/
package org.eclipse.userstorage.spi;
import org.eclipse.userstorage.IStorage;
import org.eclipse.userstorage.internal.Credentials;
/**
* Provides the user's credentials for a given {@link IStorage storage}.
*
* @author Eike Stepper
*/
public interface ICredentialsProvider
{
/**
* Provides the user's credentials for the given {@link IStorage storage}.
* <p>
*
* @param storage the storage for which to provide the user's credentials, must not be <code>null</code>.<p>
* @return the user's credentials for the given {@link IStorage storage},
* or <code>null</code> as an indication to cancel the authentication process.<p>
*/
public Credentials provideCredentials(IStorage storage);
}