CredentialProvider.java

package de.zib.gndms.kit.security;

/*
 * Copyright 2008-2011 Zuse Institute Berlin (ZIB)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */



import java.util.List;

/**
 * Interface that hides the credential mechanism.
 *
 * Implementations of this interface should provided the ability to install credentials in a specific object.
 *
 * @author  try ma ik jo rr a zib
 * @version $Id$
 *          <p/>
 *          User: mjorra, Date: 18.06.2010, Time: 10:12:35
 */
public interface CredentialProvider<T> {

    /**
     * installs the credentials in the given object o.
     * @param o The object which accepts credentials, e.g. an instance of some client.
     */
    void installCredentials( Object o );

    /**
     * Delivers a credential
     * @return same as getCredentials().get( 0 );
     */
    T getCredential( );

    /**
     * Allows setting of a credential installer if required.
     * @param credentialInstaller  An installer instance.
     */
    void setInstaller( CredentialInstaller credentialInstaller );
}