View Javadoc

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  package org.apache.jetspeed.om.registry;
18  
19  /***
20   * <P>
21   * The <CODE>ClientRegistry</CODE> interface allow to query the system
22   * Registry to find client implementations whose "User-agent" identification
23   * matches a specific regular expression as defined in a <code>ClientEntry</code>
24   * </P>
25   *
26   * @author <a href="shesmer@raleigh.ibm.com">Stephan Hesmer</a>
27   * @author <a href="raphael@apache.org">RaphaŽl Luta</a>
28   * @version $Id: ClientRegistry.java,v 1.2 2004/02/23 03:11:39 jford Exp $
29   */
30  public interface ClientRegistry extends Registry
31  {
32  
33      /***
34       * Returns the client which matches the given useragent string.
35       *
36       * @param useragent     the useragent to match
37       * @return the found client or null if the user-agent does not match any
38       *  defined client
39       */
40      public ClientEntry findEntry(String useragent);
41  
42  }