001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *  http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    
020    //
021    // This source code implements specifications defined by the Java
022    // Community Process. In order to remain compliant with the specification
023    // DO NOT add / change / or delete method signatures!
024    //
025    
026    package javax.resource.spi.work;
027    
028    import javax.security.auth.callback.CallbackHandler;
029    import javax.security.auth.Subject;
030    
031    /**
032     * @since 1.6
033     * @version $Rev: 920245 $ $Date: 2010-03-08 04:25:34 -0500 (Mon, 08 Mar 2010) $
034     */
035    public abstract class SecurityContext implements WorkContext {
036    
037        private static final long serialVersionUID = 7730296651802712658L;
038        private static final String NAME = "SecurityContext";
039        private static final String DESCRIPTION = "SecurityContext";
040        /**
041         * Human readable name of the inflow context
042         *
043         * @return human readable name of the inflow context
044         */
045        public String getName() {
046            return NAME;
047        }
048    
049        /**
050         * Human readable description of the inflow context
051         *
052         * @return human-readable description of the inflow context
053         */
054        public String getDescription() {
055            return DESCRIPTION;
056        }
057    
058        /**
059         * Use the info supplied by the container to set up the security context in the work instance.
060         * @param callbackHandler CallbackHandler that can handle the jaspi callbacks 
061         * @param executionSubject non-null client subject to be filled in by the inflow context
062         * @param serviceSubject non-null service subject that identifies the app server container
063         */
064        public abstract void setupSecurityContext(CallbackHandler callbackHandler,
065                                                  Subject executionSubject,
066                                                  Subject serviceSubject);
067    }