/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.security.integration;
import java.security.Principal;
import javax.security.auth.Subject;
import org.jvnet.hk2.annotations.Contract;
import org.jvnet.hk2.annotations.Scoped;
import org.jvnet.hk2.component.PerLookup;
/**
* The SecurityContext Interface, also provide factory methods
*
*/
@Contract
@Scoped(PerLookup.class)
public interface AppServSecurityContext {
/**
* This method should be implemented by the subclasses to
* return the caller principal. This information may be redundant
* since the same information can be inferred by inspecting the
* Credentials of the caller.
* @return The caller Principal.
*/
public Principal getCallerPrincipal();
/**
* This method should be implemented by the subclasses to return
* the Credentials of the caller principal.
* @return A credentials object associated with the current client
* invocation.
*/
public Subject getSubject();
/**
* @return a new instance
*/
public AppServSecurityContext newInstance(String userName, Subject subject, String realm);
/**
* @return a new instance
*/
public AppServSecurityContext newInstance(String userName, Subject subject);
/**
* set the current security context
*/
public void setCurrentSecurityContext(AppServSecurityContext context);
/**
* @return the current security context
*/
public AppServSecurityContext getCurrentSecurityContext();
/**
* set the unauthenticated context
*/
public void setUnauthenticatedSecurityContext();
/**
* set the SecurityContext with given Principal
*/
public void setSecurityContextWithPrincipal(Principal principal);
}