org.apache.jetspeed.capabilities
Interface Client

public interface Client

The ClientEntry interface represents one client inside of the client registry. It is accessed by the portlet container to get information about the clients.

Author:

Stephan Hesmer, Raphaël Luta, Roger Ruttimann

Method Summary

java.util.Collection	getCapabilities() Returns all supported capablities as CapabilityMap.
int	getClientId() Get Client ID
int	getEvalOrder()
java.lang.String	getManufacturer() Returns the manufacturer of this client
java.util.Collection	getMimetypes() Returns all supported mimetypes as MimeTypeMap.
java.lang.String	getModel() Returns the model of this client
java.lang.String	getName()
int	getPreferredMimeTypeId() getPreferredMimeTypeId
java.lang.String	getUserAgentPattern() Returns the pattern parameter of this client.
java.lang.String	getVersion() Returns the version of this client
void	setCapabilities(java.util.Collection capabilities) Assigns a list of capabilities
void	setClientId(int id) Set Client ID -- Assigns the Client ID
void	setEvalOrder(int evalOrder)
void	setManufacturer(java.lang.String name) Sets the new manufacturer of this client
void	setMimetypes(java.util.Collection mimetypes) Set MimeTypes
void	setModel(java.lang.String name) Sets the new model of this client
void	setName(java.lang.String name)
void	setPreferredMimeTypeId(int mimeTypeId) setPreferredMimeTypeId
void	setUserAgentPattern(java.lang.String useragentpattern) Sets the pattern used to match the user agent.
void	setVersion(java.lang.String name) Sets the new version of this client

Method Detail

setClientId

void setClientId(int id)

Set Client ID -- Assigns the Client ID

Parameters:

id -

getClientId

int getClientId()

Get Client ID

Returns:

Client ID

getEvalOrder

int getEvalOrder()

setEvalOrder

void setEvalOrder(int evalOrder)

getUserAgentPattern

java.lang.String getUserAgentPattern()

Returns the pattern parameter of this client. The pattern is used to match a client to the user agent used to access the portal. If the pattern matches the user agent string, this client is recognized as the one the user is currently working with.

Returns:

the pattern of this client

setUserAgentPattern

void setUserAgentPattern(java.lang.String useragentpattern)

Sets the pattern used to match the user agent.

Parameters:

useragentpattern - the new pattern

getManufacturer

java.lang.String getManufacturer()

Returns the manufacturer of this client

Returns:

the manufacturer of this client

setManufacturer

void setManufacturer(java.lang.String name)

Sets the new manufacturer of this client

Parameters:

name - the new manufacturer

getModel

java.lang.String getModel()

Returns the model of this client

Returns:

the model of this client

setModel

void setModel(java.lang.String name)

Sets the new model of this client

Parameters:

name - the new model

getVersion

java.lang.String getVersion()

Returns the version of this client

Returns:

the version of this client

setVersion

void setVersion(java.lang.String name)

Sets the new version of this client

Parameters:

name - the new version

getMimetypes

java.util.Collection getMimetypes()

Returns all supported mimetypes as MimeTypeMap. The MimeTypeMap contains all mimetypes in decreasing order of importance.

Returns:

the MimeTypeMap

See Also:

MimeTypeMap

setMimetypes

void setMimetypes(java.util.Collection mimetypes)

Set MimeTypes

Parameters:

mimetypes -

getName

java.lang.String getName()

setName

void setName(java.lang.String name)

getCapabilities

java.util.Collection getCapabilities()

Returns all supported capablities as CapabilityMap. The CapabilityMap contains all capabilities in arbitrary order.

Returns:

the CapabilityMap

See Also:

CapabilityMap

setCapabilities

void setCapabilities(java.util.Collection capabilities)

Assigns a list of capabilities

Parameters:

capabilities -

getPreferredMimeTypeId

int getPreferredMimeTypeId()

getPreferredMimeTypeId

Returns:

mimeTypeId

setPreferredMimeTypeId

void setPreferredMimeTypeId(int mimeTypeId)

setPreferredMimeTypeId

Parameters:

mimeTypeId - to be set as preferred mimeType