org.apache.jetspeed.capabilities
Interface Capabilities

public interface Capabilities

Capabilities Component Interface

Version:

$Id: Capabilities.java 516448 2007-03-09 16:25:47Z ate $

Author:

Roger Ruttimann

Method Summary

Capability	createCapability(java.lang.String capabilityName) Create a new capability in the system or return the existing one if already exists
Client	createClient(java.lang.String clientName) Create a new client in the system or return the existing one if already exists
MediaType	createMediaType(java.lang.String mediaTypeName) Create a new mediaType in the system or return the existing one if already exists
MimeType	createMimeType(java.lang.String mimeTypeName) Create a new mimetype in the system or return the existing one if already exists
void	deleteCapability(Capability capability) delete existing capability from backend storage
void	deleteCapabilityMapCache() Clears CapabilityMap cache TODO: Roger, why is this on the public interface.
void	deleteClient(Client client) delete existing client from backend storage
void	deleteMediaType(MediaType mediaType) delete existing media type from backend storage
void	deleteMimeType(MimeType mimeType) delete existing mime type from backend storage
Client	findClient(java.lang.String userAgent) Finds a client for a given userAgentPattern
java.util.Iterator	getCapabilities() Obtain an iterator of all existing capabilities.
Capability	getCapability(java.lang.String capability) Given a capability string, look up the corresponding capability object.
java.lang.String	getCapabilityBeanName() Obtain the name of the CapabilityBean reference
CapabilityMap	getCapabilityMap(java.lang.String userAgent) Creates a Capability Map with Capabilities, Mimetypes and mediaTypes for the given UserAgentPattern
Client	getClient(java.lang.String clientName) Given a client name, look up the corresponding client object.
java.lang.String	getClientBeanName() Obtain the name of the ClientBean reference
java.util.Iterator	getClients() Obtain an iterator of all existing clients.
MediaType	getMediaType(java.lang.String mediaType) Given a media type string, look up the corresponding media type object.
java.lang.String	getMediaTypeBeanName() Obtain the name of the Media Type reference
MediaType	getMediaTypeForMimeType(java.lang.String mimeTypeName) Given a Mimetype string lookup the corresponding media type object
java.util.Iterator	getMediaTypes() Obtain an iterator of all existing media types.
java.util.Collection	getMediaTypesForMimeTypes(java.util.Iterator mimetypes) Returns a collection of MediaTypes that matches the MimeTypes defined in the mimetype parameter
MimeType	getMimeType(java.lang.String mimeType) Given a mime type string, look up the corresponding mime type object.
java.lang.String	getMimeTypeBeanName() Obtain the name of the Mime Type reference
java.util.Iterator	getMimeTypes() Obtain an iterator of all existing mime types.
void	setCapabilityBeanName(java.lang.String capabilityBeanName) Set the name of the CapabilityBean reference - used exclusively in IoC
void	setClientBeanName(java.lang.String clientBeanName) Set the name of the ClientBean reference - used exclusively in IoC
void	setMediaTypeBeanName(java.lang.String mediaTypeBeanName) Set the name of the MediaType bean reference - used exclusively in IoC
void	setMimeTypeBeanName(java.lang.String mimeTypeBeanName) Set the name of the MimeType bean reference - used exclusively in IoC
void	storeCapability(Capability capability) Save capability to backend storage
void	storeClient(Client client) Save client to backend storage
void	storeMediaType(MediaType mediaType) Save media type to backend storage
void	storeMimeType(MimeType mimeType) Save mime type to backend storage

Method Detail

getCapabilityMap

CapabilityMap getCapabilityMap(java.lang.String userAgent)
                               throws UnableToBuildCapabilityMapException

Creates a Capability Map with Capabilities, Mimetypes and mediaTypes for the given UserAgentPattern

Parameters:

userAgent - Agent from the request

Returns:

CapabilityMap populated with Capabilities, Mimetypes and Mediatype that match the userAgent. Never returns null

Throws:

UnableToBuildCapabilityMapException - If a capability could not be created

getClients

java.util.Iterator getClients()

Obtain an iterator of all existing clients.

Returns:

Returns an iterator for all existing Clients

findClient

Client findClient(java.lang.String userAgent)

Finds a client for a given userAgentPattern

Parameters:

userAgent -

Returns:

Client that matches agent or null if no match is found

getMediaTypesForMimeTypes

java.util.Collection getMediaTypesForMimeTypes(java.util.Iterator mimetypes)

Returns a collection of MediaTypes that matches the MimeTypes defined in the mimetype parameter

Parameters:

Mimetype -

Returns:

Collection of Mediatypes that matches the mimetypes

deleteCapabilityMapCache

void deleteCapabilityMapCache()

Clears CapabilityMap cache TODO: Roger, why is this on the public interface. It seems to be impl specific

getMediaType

MediaType getMediaType(java.lang.String mediaType)

Given a media type string, look up the corresponding media type object.

Parameters:

mediaType - The string representation of a media type.

Returns:

The found media type object or if not found, null.

getMediaTypeForMimeType

MediaType getMediaTypeForMimeType(java.lang.String mimeTypeName)

Given a Mimetype string lookup the corresponding media type object

Parameters:

mimeTypeName - to use for lookup

Returns:

MediaTypeEntry that matches the lookup in the MEDIATYPE_TO_MIMETYPE table

getCapability

Capability getCapability(java.lang.String capability)

Given a capability string, look up the corresponding capability object.

Parameters:

capability - The string representation of a capability.

Returns:

The found capability object or if not found, null.

getMimeType

MimeType getMimeType(java.lang.String mimeType)

Given a mime type string, look up the corresponding mime type object.

Parameters:

mimeType - The string representation of a mime type.

Returns:

The found mime type object or if not found, null.

getClient

Client getClient(java.lang.String clientName)

Given a client name, look up the corresponding client object.

Parameters:

clientName - The name of the client.

Returns:

The found client object or if not found, null.

getCapabilities

java.util.Iterator getCapabilities()

Obtain an iterator of all existing capabilities.

Returns:

Returns an iterator for all existing Capabilities of type Capability

getMimeTypes

java.util.Iterator getMimeTypes()

Obtain an iterator of all existing mime types.

Returns:

Returns an iterator for all existing Mime Types of type MimeType

getMediaTypes

java.util.Iterator getMediaTypes()

Obtain an iterator of all existing media types.

Returns:

Returns an iterator for all existing media types of type MediaType

getCapabilityBeanName

java.lang.String getCapabilityBeanName()

Obtain the name of the CapabilityBean reference

Returns:

ref-id of the capability bean

setCapabilityBeanName

void setCapabilityBeanName(java.lang.String capabilityBeanName)

Set the name of the CapabilityBean reference - used exclusively in IoC

Parameters:

capabilityBeanName - The ref-id of the capability bean.

getClientBeanName

java.lang.String getClientBeanName()

Obtain the name of the ClientBean reference

Returns:

ref-id of the client bean

setClientBeanName

void setClientBeanName(java.lang.String clientBeanName)

Set the name of the ClientBean reference - used exclusively in IoC

Parameters:

clientBeanName - The ref-id of the client bean.

getMediaTypeBeanName

java.lang.String getMediaTypeBeanName()

Obtain the name of the Media Type reference

Returns:

ref-id of the media type bean

setMediaTypeBeanName

void setMediaTypeBeanName(java.lang.String mediaTypeBeanName)

Set the name of the MediaType bean reference - used exclusively in IoC

Parameters:

mediaTypeBeanName - The ref-id of the mediaType bean.

getMimeTypeBeanName

java.lang.String getMimeTypeBeanName()

Obtain the name of the Mime Type reference

Returns:

ref-id of the mime type bean

setMimeTypeBeanName

void setMimeTypeBeanName(java.lang.String mimeTypeBeanName)

Set the name of the MimeType bean reference - used exclusively in IoC

Parameters:

mimeTypeBeanName - The ref-id of the mimeType bean.

createCapability

Capability createCapability(java.lang.String capabilityName)
                            throws java.lang.ClassNotFoundException

Create a new capability in the system or return the existing one if already exists

Parameters:

capabilityName - The string describing the capability

Returns:

A new (or existing) capability

Throws:

java.lang.ClassNotFoundException

createMimeType

MimeType createMimeType(java.lang.String mimeTypeName)
                        throws java.lang.ClassNotFoundException

Create a new mimetype in the system or return the existing one if already exists

Parameters:

mimeTypeName - The string describing the mimeType

Returns:

A new (or existing) MimeType

Throws:

java.lang.ClassNotFoundException

createMediaType

MediaType createMediaType(java.lang.String mediaTypeName)
                          throws java.lang.ClassNotFoundException

Create a new mediaType in the system or return the existing one if already exists

Parameters:

mediaTypeName - The string describing the mediaType

Returns:

A new (or existing) MediaType

Throws:

java.lang.ClassNotFoundException

createClient

Client createClient(java.lang.String clientName)
                    throws java.lang.ClassNotFoundException

Create a new client in the system or return the existing one if already exists

Parameters:

clientName - The string describing the client

Returns:

A new (or existing) client

Throws:

java.lang.ClassNotFoundException

storeMediaType

void storeMediaType(MediaType mediaType)
                    throws CapabilitiesException

Save media type to backend storage

Parameters:

mediaType - valid mediatype object

Throws:

CapabilitiesException

deleteMediaType

void deleteMediaType(MediaType mediaType)
                     throws CapabilitiesException

delete existing media type from backend storage

Parameters:

mediaType - valid mediatype object

Throws:

CapabilitiesException

storeCapability

void storeCapability(Capability capability)
                     throws CapabilitiesException

Save capability to backend storage

Parameters:

capability - valid capability object

Throws:

CapabilitiesException

deleteCapability

void deleteCapability(Capability capability)
                      throws CapabilitiesException

delete existing capability from backend storage

Parameters:

capability - valid capability object

Throws:

CapabilitiesException

storeMimeType

void storeMimeType(MimeType mimeType)
                   throws CapabilitiesException

Save mime type to backend storage

Parameters:

mimeType - valid mimetype object

Throws:

CapabilitiesException

deleteMimeType

void deleteMimeType(MimeType mimeType)
                    throws CapabilitiesException

delete existing mime type from backend storage

Parameters:

mimeType - valid mimetype object

Throws:

CapabilitiesException

storeClient

void storeClient(Client client)
                 throws CapabilitiesException

Save client to backend storage

Parameters:

client - valid Client object

Throws:

CapabilitiesException

deleteClient

void deleteClient(Client client)
                  throws CapabilitiesException

delete existing client from backend storage

Parameters:

client - valid client object

Throws:

CapabilitiesException