Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

PREV class NEXT class

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jetspeed.portlet
Interface Client

public interface Client

The Client interface represents the client device that the user connects to the portal with. It defines methods to obtain information about clients, e.g. browsers running on PCs, WAP phones, PDAs or on voice gateways.

Since:

4.1

Method Summary
java.lang.String	getManufacturer() Returns the name of the manufacturer of this client, or null if the name is not available.
java.lang.String	getMarkupName() Returns the preferred markup name that this client device supports.
java.lang.String	getMimeType() Returns the preferred mime-type that this client device supports.
java.lang.String	getModel() Returns the name of the model of this client, or null if the name is not available.
java.lang.String	getUserAgent() Returns the exact user agent that this client uses to identify itself to the portal.
java.lang.String	getVersion() Returns the version of the model of this client, or null if the version is not available.
boolean	isCapableOf(Capability capability) Returns whether this client has the given capability.
boolean	isCapableOf(Capability[] capabilities) Returns whether this client has the given capabilities.

Method Detail

getManufacturer

public java.lang.String getManufacturer()

Returns the name of the manufacturer of this client, or null if the name is not available.

Returns:

the manufacturer

getModel

public java.lang.String getModel()

Returns the name of the model of this client, or null if the name is not available.

Returns:

the model

getVersion

public java.lang.String getVersion()

Returns the version of the model of this client, or null if the version is not available.

Returns:

the version

getUserAgent

public java.lang.String getUserAgent()

Returns the exact user agent that this client uses to identify itself to the portal. If the client does not send a user agent, this method returns null.

Returns:

the user agent

isCapableOf

public boolean isCapableOf(Capability capability)

Returns whether this client has the given capability. If the portal does not know enough about the client, it has to be on the safe side and return false.

Returns:

true if the client has the given capability,
false otherwise

See Also:

isCapableOf(Capability[])

isCapableOf

public boolean isCapableOf(Capability[] capabilities)

Returns whether this client has the given capabilities. The array of capability is tested in its entirety, ie. only if the client is capable of every single capability this methods returns true.

Returns:

true if the client has the given capability,
false otherwise

See Also:

isCapableOf(Capability)

getMimeType

public java.lang.String getMimeType()

Returns the preferred mime-type that this client device supports.

Returns:

the mime-type

getMarkupName

public java.lang.String getMarkupName()

Returns the preferred markup name that this client device supports.

Returns:

the naem of the markup