1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.jetspeed.pipeline.valve;
18
19 import org.apache.jetspeed.security.impl.SecurityValveImpl;
20
21 /***
22 * Authenticates the User or redirects to Login if necessary, add
23 * authenticated Subject to RequestContext
24 *
25 * <br/>
26 * Read from the ValveContext:
27 * <ul>
28 * </ul>
29 *
30 * <br/>
31 * Written into the ValveContext:
32 * <ul>
33 * </ul>
34 *
35 * <br>
36 * Note: The primary purpose of this interface is primary for documention.
37 *
38 * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
39 * @version $Id: SecurityValve.java 516448 2007-03-09 16:25:47Z ate $
40 *
41 * @see ValveContext
42 */
43 public interface SecurityValve extends Valve
44 {
45 final String IP_ADDRESS = SecurityValveImpl.class.getName() + ".ipaddress";
46 }