LoginSecurityContext.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF 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
 *
 * 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.apache.cxf.security;

import java.security.Principal;
import java.util.Set;

import javax.security.auth.Subject;

/**
 * LoginSecurityContext provides additional information about the
 * authenticated principal.
 *
 * {@link SecurityContext} implementations which can get the authenticated
 * Subject and/or the list of the user roles may implement this interface.
 */
public interface LoginSecurityContext extends SecurityContext {

    /**
     * Returns the Subject representing the current authenticated user.
     * @return the subject
     */
    Subject getSubject();
    /**
     * Returns a set of Principals representing the roles
     * assigned to the current authenticated user Principal
     * @return the roles
     */
    Set<Principal> getUserRoles();
}