KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cactus > client > authentication > Authentication


1 /*
2  * ========================================================================
3  *
4  * Copyright 2001-2003 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  * ========================================================================
19  */
20 package org.apache.cactus.client.authentication;
21
22 import org.apache.cactus.WebRequest;
23 import org.apache.cactus.internal.configuration.Configuration;
24 import org.apache.commons.httpclient.HttpMethod;
25 import org.apache.commons.httpclient.HttpState;
26
27 /**
28  * Interface for different authentication modules. An authentication class is
29  * invoked on the client side to perform the actual authentication, for example
30  * by modifying the request to includes credentials.
31  *
32  * @since 1.5
33  *
34  * @version $Id: Authentication.java,v 1.1 2004/05/22 11:34:48 vmassol Exp $
35  */
36 public interface Authentication
37 {
38
39     /**
40      * Modifies the request so that it will carry authentication information.
41      *
42      * @param theState The HttpClient state object that can be used to ask
43      * HttpClient to set up authentication
44      * @param theMethod the HttpClient HTTP method that will be used to connect
45      * to the server side
46      * @param theRequest The request object that will be sent to the Cactus
47      * Redirector over HTTP
48      * @param theConfiguration The Cactus configuration so that
49      * authentication methods can get access to Cactus configuration
50      * properties
51      */
52     void configure(HttpState theState, HttpMethod theMethod,
53         WebRequest theRequest, Configuration theConfiguration);
54
55 }
56
Popular Tags