View Javadoc

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