IParentAwareSecurityContext.java

/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * 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:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>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.apereo.portal.security;

/**
 * This is a tag interface, indicating that the implementing {@link SecurityContext} class must be
 * <i>parent aware</i>.
 */
public interface IParentAwareSecurityContext {

    /**
     * Concrete {@link SecurityContext} classes that implement <code>IParentAwareSecurityContext
     * </code> will have this method called by {@link ChainingSecurityContext} instead of the no-arg
     * version.
     */
    public void authenticate(ISecurityContext parent) throws PortalSecurityException;
}