Java Doc for Capabilities.java in  » Portal » jetspeed-2.1.3 » org » apache » jetspeed » capabilities » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Portal » jetspeed 2.1.3 » org.apache.jetspeed.capabilities 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.jetspeed.capabilities.Capabilities

All known Subclasses:   org.apache.jetspeed.capabilities.impl.JetspeedCapabilities,
Capabilities
public interface Capabilities (Code)
Capabilities Component Interface
author:
   Roger Ruttimann
version:
   $Id: Capabilities.java 516448 2007-03-09 16:25:47Z ate $




Method Summary
public  CapabilitycreateCapability(String capabilityName)
    
public  ClientcreateClient(String clientName)
    
public  MediaTypecreateMediaType(String mediaTypeName)
    
public  MimeTypecreateMimeType(String mimeTypeName)
    
public  voiddeleteCapability(Capability capability)
    
 voiddeleteCapabilityMapCache()
     Clears CapabilityMap cache TODO: Roger, why is this on the public interface.
public  voiddeleteClient(Client client)
    
public  voiddeleteMediaType(MediaType mediaType)
    
public  voiddeleteMimeType(MimeType mimeType)
    
 ClientfindClient(String userAgent)
    
 IteratorgetCapabilities()
     Obtain an iterator of all existing capabilities.
 CapabilitygetCapability(String capability)
     Given a capability string, look up the corresponding capability object.
Parameters:
  capability - The string representation of a capability.
public  StringgetCapabilityBeanName()
    
 CapabilityMapgetCapabilityMap(String userAgent)
     Creates a Capability Map with Capabilities, Mimetypes and mediaTypes for the given UserAgentPattern
Parameters:
  userAgent - Agent from the request CapabilityMap populated with Capabilities, Mimetypes and Mediatypethat match the userAgent.
 ClientgetClient(String clientName)
     Given a client name, look up the corresponding client object.
Parameters:
  clientName - The name of the client.
public  StringgetClientBeanName()
    
 IteratorgetClients()
     Obtain an iterator of all existing clients.
 MediaTypegetMediaType(String mediaType)
     Given a media type string, look up the corresponding media type object.
Parameters:
  mediaType - The string representation of a media type.
public  StringgetMediaTypeBeanName()
    
public  MediaTypegetMediaTypeForMimeType(String mimeTypeName)
    
 IteratorgetMediaTypes()
     Obtain an iterator of all existing media types.
 CollectiongetMediaTypesForMimeTypes(Iterator mimetypes)
    
 MimeTypegetMimeType(String mimeType)
     Given a mime type string, look up the corresponding mime type object.
Parameters:
  mimeType - The string representation of a mime type.
public  StringgetMimeTypeBeanName()
    
 IteratorgetMimeTypes()
     Obtain an iterator of all existing mime types.
public  voidsetCapabilityBeanName(String capabilityBeanName)
    
public  voidsetClientBeanName(String clientBeanName)
    
public  voidsetMediaTypeBeanName(String mediaTypeBeanName)
    
public  voidsetMimeTypeBeanName(String mimeTypeBeanName)
    
public  voidstoreCapability(Capability capability)
    
public  voidstoreClient(Client client)
    
public  voidstoreMediaType(MediaType mediaType)
    
public  voidstoreMimeType(MimeType mimeType)
    



Method Detail
createCapability
public Capability createCapability(String capabilityName) throws ClassNotFoundException(Code)
Create a new capability in the system or return the existing one if already exists
Parameters:
  capabilityName - The string describing the capability A new (or existing) capability



createClient
public Client createClient(String clientName) throws ClassNotFoundException(Code)
Create a new client in the system or return the existing one if already exists
Parameters:
  clientName - The string describing the client A new (or existing) client



createMediaType
public MediaType createMediaType(String mediaTypeName) throws ClassNotFoundException(Code)
Create a new mediaType in the system or return the existing one if already exists
Parameters:
  mediaTypeName - The string describing the mediaType A new (or existing) MediaType



createMimeType
public MimeType createMimeType(String mimeTypeName) throws ClassNotFoundException(Code)
Create a new mimetype in the system or return the existing one if already exists
Parameters:
  mimeTypeName - The string describing the mimeType A new (or existing) MimeType



deleteCapability
public void deleteCapability(Capability capability) throws CapabilitiesException(Code)
delete existing capability from backend storage
Parameters:
  capability - valid capability object



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



deleteClient
public void deleteClient(Client client) throws CapabilitiesException(Code)
delete existing client from backend storage
Parameters:
  client - valid client object



deleteMediaType
public void deleteMediaType(MediaType mediaType) throws CapabilitiesException(Code)
delete existing media type from backend storage
Parameters:
  mediaType - valid mediatype object



deleteMimeType
public void deleteMimeType(MimeType mimeType) throws CapabilitiesException(Code)
delete existing mime type from backend storage
Parameters:
  mimeType - valid mimetype object



findClient
Client findClient(String userAgent)(Code)
Finds a client for a given userAgentPattern
Parameters:
  userAgent - Client that matches agent or null if no match is found



getCapabilities
Iterator getCapabilities()(Code)
Obtain an iterator of all existing capabilities. Returns an iterator for all existing Capabilities of type Capability



getCapability
Capability getCapability(String capability)(Code)
Given a capability string, look up the corresponding capability object.
Parameters:
  capability - The string representation of a capability. The found capability object or if not found, null.



getCapabilityBeanName
public String getCapabilityBeanName()(Code)
Obtain the name of the CapabilityBean reference ref-id of the capability bean



getCapabilityMap
CapabilityMap getCapabilityMap(String userAgent) throws UnableToBuildCapabilityMapException(Code)
Creates a Capability Map with Capabilities, Mimetypes and mediaTypes for the given UserAgentPattern
Parameters:
  userAgent - Agent from the request CapabilityMap populated with Capabilities, Mimetypes and Mediatypethat match the userAgent. Never returns null
throws:
  UnableToBuildCapabilityMapException - If a capability could not be created



getClient
Client getClient(String clientName)(Code)
Given a client name, look up the corresponding client object.
Parameters:
  clientName - The name of the client. The found client object or if not found, null.



getClientBeanName
public String getClientBeanName()(Code)
Obtain the name of the ClientBean reference ref-id of the client bean



getClients
Iterator getClients()(Code)
Obtain an iterator of all existing clients. Returns an iterator for all existing Clients



getMediaType
MediaType getMediaType(String mediaType)(Code)
Given a media type string, look up the corresponding media type object.
Parameters:
  mediaType - The string representation of a media type. The found media type object or if not found, null.



getMediaTypeBeanName
public String getMediaTypeBeanName()(Code)
Obtain the name of the Media Type reference ref-id of the media type bean



getMediaTypeForMimeType
public MediaType getMediaTypeForMimeType(String mimeTypeName)(Code)
Given a Mimetype string lookup the corresponding media type object
Parameters:
  mimeTypeName - to use for lookup MediaTypeEntry that matches the lookup in the MEDIATYPE_TO_MIMETYPE table



getMediaTypes
Iterator getMediaTypes()(Code)
Obtain an iterator of all existing media types. Returns an iterator for all existing media types of type MediaType



getMediaTypesForMimeTypes
Collection getMediaTypesForMimeTypes(Iterator mimetypes)(Code)
Returns a collection of MediaTypes that matches the MimeTypes defined in the mimetype parameter
Parameters:
  Mimetype - Collection of Mediatypes that matches the mimetypes



getMimeType
MimeType getMimeType(String mimeType)(Code)
Given a mime type string, look up the corresponding mime type object.
Parameters:
  mimeType - The string representation of a mime type. The found mime type object or if not found, null.



getMimeTypeBeanName
public String getMimeTypeBeanName()(Code)
Obtain the name of the Mime Type reference ref-id of the mime type bean



getMimeTypes
Iterator getMimeTypes()(Code)
Obtain an iterator of all existing mime types. Returns an iterator for all existing Mime Types of type MimeType



setCapabilityBeanName
public void setCapabilityBeanName(String capabilityBeanName)(Code)
Set the name of the CapabilityBean reference - used exclusively in IoC
Parameters:
  capabilityBeanName - The ref-id of the capability bean.



setClientBeanName
public void setClientBeanName(String clientBeanName)(Code)
Set the name of the ClientBean reference - used exclusively in IoC
Parameters:
  clientBeanName - The ref-id of the client bean.



setMediaTypeBeanName
public void setMediaTypeBeanName(String mediaTypeBeanName)(Code)
Set the name of the MediaType bean reference - used exclusively in IoC
Parameters:
  mediaTypeBeanName - The ref-id of the mediaType bean.



setMimeTypeBeanName
public void setMimeTypeBeanName(String mimeTypeBeanName)(Code)
Set the name of the MimeType bean reference - used exclusively in IoC
Parameters:
  mimeTypeBeanName - The ref-id of the mimeType bean.



storeCapability
public void storeCapability(Capability capability) throws CapabilitiesException(Code)
Save capability to backend storage
Parameters:
  capability - valid capability object



storeClient
public void storeClient(Client client) throws CapabilitiesException(Code)
Save client to backend storage
Parameters:
  client - valid Client object



storeMediaType
public void storeMediaType(MediaType mediaType) throws CapabilitiesException(Code)
Save media type to backend storage
Parameters:
  mediaType - valid mediatype object



storeMimeType
public void storeMimeType(MimeType mimeType) throws CapabilitiesException(Code)
Save mime type to backend storage
Parameters:
  mimeType - valid mimetype object



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.