1   /*
2    * Copyright 2000-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  
17  /* 
18  
19   */
20  
21  package org.apache.wsrp4j.consumer;
22  
23  import java.util.Iterator;
24  
25  import org.apache.wsrp4j.exception.WSRPException;
26  
27  /**
28   * This interface defines a registry which can be used to store
29   * portlet driver objects.
30   * 
31   * @author Stephan Laertz
32   **/
33  public interface PortletDriverRegistry {
34  
35      /**
36       * Get an portlet driver for the given portlet. If there is no portlet driver
37       * object cached a new portlet driver will be created and returned.
38       * 
39       * @param portlet The portlet the returned portlet driver is bind to
40       * 
41       * @return The portlet driver for this portlet
42       **/
43      public PortletDriver getPortletDriver(WSRPPortlet portlet)
44              throws WSRPException;
45  
46      /**
47       * Get all cached portlet drivers.
48       * 
49       * @return Iterator with all portlet drivers in the registry
50       **/
51      public Iterator getAllPortletDrivers();
52  }