View Javadoc

1   /*
2    * $Id: PrincipalAware.java 651946 2008-04-27 13:41:38Z apetrelli $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  package org.apache.struts2.interceptor;
23  
24  /***
25   * Actions that want access to the Principal information from HttpServletRequest object
26   * should implement this interface.
27   *
28   * <p>This interface is only relevant if the Action is used in a servlet environment.
29   * By using this interface you will not become tied to servlet environment.</p>
30   *
31   */
32  public interface PrincipalAware {
33      void setPrincipalProxy(PrincipalProxy principalProxy);
34  }