01: /* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
02: *
03: * Licensed under the Apache License, Version 2.0 (the "License");
04: * you may not use this file except in compliance with the License.
05: * You may obtain a copy of the License at
06: *
07: * http://www.apache.org/licenses/LICENSE-2.0
08: *
09: * Unless required by applicable law or agreed to in writing, software
10: * distributed under the License is distributed on an "AS IS" BASIS,
11: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12: * See the License for the specific language governing permissions and
13: * limitations under the License.
14: */
15:
16: package org.acegisecurity.securechannel;
17:
18: import java.io.IOException;
19:
20: import javax.servlet.ServletException;
21: import javax.servlet.ServletRequest;
22: import javax.servlet.ServletResponse;
23:
24: /**
25: * May be used by a {@link ChannelProcessor} to launch a web channel.
26: *
27: * <P>
28: * <code>ChannelProcessor</code>s can elect to launch a new web channel
29: * directly, or they can delegate to another class. The
30: * <code>ChannelEntryPoint</code> is a pluggable interface to assist
31: * <code>ChannelProcessor</code>s in performing this delegation.
32: * </p>
33: *
34: * @author Ben Alex
35: * @version $Id: ChannelEntryPoint.java 1784 2007-02-24 21:00:24Z luke_t $
36: */
37: public interface ChannelEntryPoint {
38: //~ Methods ========================================================================================================
39:
40: /**
41: * Commences a secure channel.<P>Implementations should modify the headers on the
42: * <code>ServletResponse</code> as necessary to commence the user agent using the implementation's supported
43: * channel type.</p>
44: *
45: * @param request that a <code>ChannelProcessor</code> has rejected
46: * @param response so that the user agent can begin using a new channel
47: *
48: * @throws IOException DOCUMENT ME!
49: * @throws ServletException DOCUMENT ME!
50: */
51: void commence(ServletRequest request, ServletResponse response)
52: throws IOException, ServletException;
53: }
|