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>ClientEntry</CODE> interface represents one client inside
22   * of the client registry. It is accessed by the portlet container
23   * to get information about the clients.
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   */
29  public interface ClientEntry extends RegistryEntry
30  {
31      /***
32       * Returns the pattern parameter of this client. The pattern is used
33       * to match a client to the user agent used to access the portal. If
34       * the pattern matches the user agent string, this client is recognized
35       * as the one the user is currently working with.
36       *
37       * @return the pattern of this client
38       */
39      public String getUseragentpattern();
40  
41      /***
42       * Sets the pattern used to match the user agent.
43       *
44       * @param useragentpattern
45       *               the new pattern
46       */
47      public void setUseragentpattern(String useragentpattern);
48  
49      /***
50       * Returns the manufacturer of this client
51       *
52       * @return the manufacturer of this client
53       */
54      public String getManufacturer();
55  
56      /***
57       * Sets the new manufacturer of this client
58       *
59       * @param name   the new manufacturer
60       */
61      public void setManufacturer(String name);
62  
63      /***
64       * Returns the model of this client
65       *
66       * @return the model of this client
67       */
68      public String getModel();
69  
70      /***
71       * Sets the new model of this client
72       *
73       * @param name   the new model
74       */
75      public void setModel(String name);
76  
77      /***
78       * Returns the version of this client
79       *
80       * @return the version of this client
81       */
82      public String getVersion();
83  
84      /***
85       * Sets the new version of this client
86       *
87       * @param name   the new version
88       */
89      public void setVersion(String name);
90  
91      /***
92       * Returns all supported mimetypes as <CODE>MimeTypeMap</CODE>.
93       * The <CODE>MimeTypeMap</CODE> contains all mimetypes in decreasing
94       * order of importance.
95       *
96       * @return the MimeTypeMap
97       * @see MimeTypeMap
98       */
99      public MimetypeMap getMimetypeMap();
100 
101     /***
102      * Returns all supported capablities as <CODE>CapabilityMap</CODE>.
103      * The <CODE>CapabilityMap</CODE> contains all capabilities in arbitrary
104      * order.
105      *
106      * @return the CapabilityMap
107      * @see CapabilityMap
108      */
109     public CapabilityMap getCapabilityMap();
110 
111 }