Capabilities (Jetspeed-2 Core API 2.3.1 API)

```
public interface Capabilities
```
Capabilities Component Interface

Version:

$Id: Capabilities.java 1536817 2013-10-29 17:11:29Z taylor $

Author:

Roger Ruttimann

Method Summary

Methods
Modifier and Type	Method and Description
`Capability`	`createCapability(String capabilityName)` Create a new capability in the system or return the existing one if already exists
`Client`	`createClient(String clientName)` Create a new client in the system or return the existing one if already exists
`MediaType`	`createMediaType(String mediaTypeName)` Create a new mediaType in the system or return the existing one if already exists
`MimeType`	`createMimeType(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
`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(String userAgent)` Finds a client for a given regex userAgentPattern
`Iterator<Capability>`	`getCapabilities()` Obtain an iterator of all existing capabilities.
`Capability`	`getCapability(String capability)` Given a capability string, look up the corresponding capability object.
`CapabilityMap`	`getCapabilityMap(String userAgent)` Creates a Capability Map with Capabilities, Mimetypes and mediaTypes for the given UserAgentPattern
`Client`	`getClient(String clientName)` Given a client name, look up the corresponding client object.
`Iterator<Client>`	`getClients()` Obtain an iterator of all existing clients.
`MediaType`	`getMediaType(String mediaType)` Given a media type string, look up the corresponding media type object.
`MediaType`	`getMediaTypeForMimeType(String mimeTypeName)` Given a Mimetype string lookup the corresponding media type object
`Iterator<MediaType>`	`getMediaTypes()` Obtain an iterator of all existing media types.
`Collection<MediaType>`	`getMediaTypesForMimeTypes(Iterator<MimeType> mimeTypes)` Returns a collection of MediaTypes that matches the MimeTypes defined in the mimetype parameter
`MimeType`	`getMimeType(String mimeType)` Given a mime type string, look up the corresponding mime type object.
`Iterator<MimeType>`	`getMimeTypes()` Obtain an iterator of all existing mime types.
`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(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
```
Iterator<Client> getClients()
```
    Obtain an iterator of all existing clients.
    
    Returns:
    Returns an iterator for all existing Clients
  - findClient
```
Client findClient(String userAgent)
```
    Finds a client for a given regex userAgentPattern
    
    Parameters:
    userAgent - the user agent regex pattern
    
    Returns:
    Client that matches agent or null if no match is found
  - getMediaTypesForMimeTypes
```
Collection<MediaType> getMediaTypesForMimeTypes(Iterator<MimeType> mimeTypes)
```
    Returns a collection of MediaTypes that matches the MimeTypes defined in the mimetype parameter
    
    Parameters:
    mimeTypes - the collection of mime types to match
    
    Returns:
    a collection of media types that matches the mime types
  - deleteCapabilityMapCache
```
void deleteCapabilityMapCache()
```
    Clears CapabilityMap cache
  - getMediaType
```
MediaType getMediaType(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(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(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(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(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
```
Iterator<Capability> getCapabilities()
```
    Obtain an iterator of all existing capabilities.
    
    Returns:
    Returns an iterator for all existing Capabilities of type Capability
  - getMimeTypes
```
Iterator<MimeType> getMimeTypes()
```
    Obtain an iterator of all existing mime types.
    
    Returns:
    Returns an iterator for all existing Mime Types of type MimeType
  - getMediaTypes
```
Iterator<MediaType> getMediaTypes()
```
    Obtain an iterator of all existing media types.
    
    Returns:
    Returns an iterator for all existing media types of type MediaType
  - createCapability
```
Capability createCapability(String capabilityName)
                            throws 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:
    
    ClassNotFoundException
  - createMimeType
```
MimeType createMimeType(String mimeTypeName)
                        throws 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:
    
    ClassNotFoundException
  - createMediaType
```
MediaType createMediaType(String mediaTypeName)
                          throws 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:
    
    ClassNotFoundException
  - createClient
```
Client createClient(String clientName)
                    throws 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:
    
    ClassNotFoundException
  - storeMediaType
```
void storeMediaType(MediaType mediaType)
                    throws CapabilitiesException
```
    Save media type to backend storage
    
    Parameters:
    mediaType - a valid media type object
    
    Throws:
    
    CapabilitiesException
  - deleteMediaType
```
void deleteMediaType(MediaType mediaType)
                     throws CapabilitiesException
```
    Delete existing media type from backend storage
    
    Parameters:
    mediaType - a valid media type 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 mime type object
    
    Throws:
    
    CapabilitiesException
  - deleteMimeType
```
void deleteMimeType(MimeType mimeType)
                    throws CapabilitiesException
```
    delete existing mime type from backend storage
    
    Parameters:
    mimeType - valid mime type 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

Interface Capabilities

Method Summary

Method Detail

getCapabilityMap

getClients

findClient

getMediaTypesForMimeTypes

deleteCapabilityMapCache

getMediaType

getMediaTypeForMimeType

getCapability

getMimeType

getClient

getCapabilities

getMimeTypes

getMediaTypes

createCapability

createMimeType

createMediaType

createClient

storeMediaType

deleteMediaType

storeCapability

deleteCapability

storeMimeType

deleteMimeType

storeClient

deleteClient