CredentialsAdapter.java

/*
 * Licensed to Jasig under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Jasig licenses this file to you 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 the following location:
 *
 *   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.
 */
package org.jasig.cas.authentication;

import org.jasig.cas.authentication.principal.Credentials;

/**
 * Adapts a CAS 4.0 {@link Credential} onto a CAS 3.x {@link Credentials}.
 *
 * @author Marvin S. Addison
 * @since 4.0
 */
public interface CredentialsAdapter {
    /**
     * Converts a CAS 4.0 credential to a CAS 3.0 credential.
     *
     * @return CAS 3.0 credential.
     */
    Credentials convert(Credential credential);
}