View Javadoc

1   /*
2    * Copyright 2001-2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.portletbridge.portlet;
17  
18  import javax.portlet.RenderRequest;
19  
20  import org.apache.commons.httpclient.Credentials;
21  import org.portletbridge.ResourceException;
22  
23  /***
24   * Interface for supporting pluggable authentication. 
25   * This needs to be configured as an init parameter in
26   * portlet xml called "authenticatorClassName".
27   * @author jmccrindle
28   *
29   */
30  public interface BridgeAuthenticator {
31      /***
32       * @param request the render request.
33       * @return a subclass of Credentials for HttpClient to use
34       * @throws ResourceException if there was a problem getting
35       *          the credentials.
36       */
37      Credentials getCredentials(RenderRequest request) throws ResourceException;
38  }