KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > jetspeed > portlet > Client


1 /* ====================================================================
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
5  * reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by the
22  * Apache Software Foundation (http://www.apache.org/)."
23  * Alternately, this acknowledgment may appear in the software itself,
24  * if and wherever such third-party acknowledgments normally appear.
25  *
26  * 4. The names "Apache" and "Apache Software Foundation" and
27  * "Apache Jetspeed" must not be used to endorse or promote products
28  * derived from this software without prior written permission. For
29  * written permission, please contact apache@apache.org.
30  *
31  * 5. Products derived from this software may not be called "Apache" or
32  * "Apache Jetspeed", nor may "Apache" appear in their name, without
33  * prior written permission of the Apache Software Foundation.
34  *
35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Apache Software Foundation. For more
51  * information on the Apache Software Foundation, please see
52  * <http://www.apache.org/>.
53  */
54
55 package org.apache.jetspeed.portlet;
56
57 import java.util.Enumeration JavaDoc;
58
59 /**
60  ** The <CODE>Client</CODE> interface represents the client device that
61  ** the user connects to the portal with. It defines defines methods to
62  ** obtain information about clients, e.g. browsers running on PCs, WAP
63  ** phones, PDAs or on voice gateways.
64  **
65  ** <P>
66  ** <I>
67  ** This class may need to be reviewed once the picture on CC/PP is
68  ** much clearer.
69  ** </I>
70  **
71  ** @author <A HREF="mailto:tboehme@us.ibm.com">Thomas F. Boehme</A>
72  **/
73
74 public interface Client
75 {
76     /**
77      ** Returns the name of the manufacturer of this client. If the
78      ** name does not exist
79      **
80      ** @return the manufacturer
81      **/
82
83     public String JavaDoc getManufacturer ();
84
85     /**
86      ** Returns the name of the model of this client.
87      **
88      ** @return the model
89      **/
90
91     public String JavaDoc getModel ();
92
93     /**
94      ** Returns the version of the model of this client.
95      **
96      ** @return the version
97      **/
98
99     public String JavaDoc getVersion ();
100
101     /**
102      ** Returns the exact user agent that this client uses
103      ** to connect to the portal.
104      **
105      ** @return the user agent
106      **/
107
108     public String JavaDoc getUserAgent ();
109
110     /**
111      ** Returns whether this client has the given capability. If the
112      ** portal does not know enough about the client, it has to be
113      ** on the safe side and return <CODE>false</CODE>.
114      **
115      ** @return <CODE>true</CODE> if the client has the given
116      ** capability, <BR>
117      ** <CODE>false</CODE> otherwise
118      **
119      ** @see #isCapableOf(Capability[])
120      **/
121
122     public boolean isCapableOf (Capability capability);
123
124
125     /**
126      ** Returns whether this client has the given capabilities. The
127      ** array of capability is tested in its entirety, ie. only if
128      ** the client is capable of every single capability this methods
129      ** returns <CODE>true<CODE>.
130      **
131      ** @return <CODE>true</CODE> if the client has the given
132      ** capability, <BR>
133      ** <CODE>false</CODE> otherwise
134      **
135      ** @see #isCapableOf(Capability)
136      **/
137
138     public boolean isCapableOf (Capability [] capabilities);
139
140     /**
141      ** Returns the preferred mime-type that this client device supports.
142      **
143      ** @return the mime-type
144      **/
145
146     public String JavaDoc getMimeType ();
147
148     /**
149      ** Returns an array of mime-types in decreasing order of preferrence.
150      **
151      ** @return an enumeration of mime-types
152      **/
153
154     public Enumeration JavaDoc getMimeTypes ();
155 }
156
Popular Tags