Java Doc for Publication.java in  » Content-Management-System » apache-lenya-2.0 » org » apache » lenya » cms » publication » 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 » Content Management System » apache lenya 2.0 » org.apache.lenya.cms.publication 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.lenya.cms.publication.Publication

All known Subclasses:   org.apache.lenya.cms.publication.PublicationConfiguration,  org.apache.lenya.cms.publication.PublicationImpl,
Publication
public interface Publication extends RepositoryItem(Code)
A Lenya publication.


Field Summary
 StringARCHIVE_AREA
    
 StringAUTHORING_AREA
    
 StringCONFIGURATION_PATH
    
 StringCONTENT_PATH
    
 StringDAV_AREA
    
 StringDELETE_PATH
    
 StringITEM_TYPE
     The item type.
 StringLIVE_AREA
    
 StringPENDING_PATH
    
 StringPUBLICATION_PREFIX
    
 StringPUBLICATION_PREFIX_URI
    
 StringSTAGING_AREA
    
 StringTRASH_AREA
    


Method Summary
 booleanexists()
    
 AreagetArea(String name)
    
Parameters:
  name - The name.
 String[]getAreaNames()
    
 StringgetBreadcrumbPrefix()
     Get the breadcrumb prefix.
 StringgetContentDir()
     Returns the content dir.
 FilegetContentDirectory(String area)
     Return the directory of a specific area.
Parameters:
  area - a File representing the root of the area content directory.
 StringgetContentURI(String area)
    
Parameters:
  area - The area.
 StringgetDefaultLanguage()
    
 FilegetDirectory()
     Returns the publication directory.
 DocumentBuildergetDocumentBuilder()
     Returns the document builder of this instance.
public  DocumentFactorygetFactory()
    
 StringgetId()
     Returns the publication ID.
 StringgetInstantiatorHint()
     Returns the publication template instantiator hint.
 String[]getLanguages()
    
 StringgetName()
    
 DocumentIdToPathMappergetPathMapper()
     Returns the path mapper.
 ProxygetProxy(Document document, boolean isSslProtected)
     Returns the proxy which is used for a particular document's area (see Publication.getProxy(String,boolean) ).
Parameters:
  document - The document.
Parameters:
  isSslProtected - A boolean value.
 ProxygetProxy(String area, boolean isSslProtected)
    

Returns the proxy which is used for the given area and the ssl parameter.

If no proxy is defined in the publication configuration file, a default proxy with the URL {contextPath}/{pubId}/{area} is returned.

If the area string is "root", the global proxy is returned.

 String[]getResourceTypeNames()
    
 FilegetServletContext()
     Returns the servlet context this publication belongs to (usually, the webapps/lenya directory).
 StringgetSiteManagerHint()
     Returns the hint of the site manager service that is used by this publication.
 StringgetSourceURI()
    
 String[]getTemplateIds()
    
 StringgetWorkflowSchema(ResourceType resourceType)
    
Parameters:
  resourceType - The resource type or null if no workflow is registered forthis resource type.
 voidsetDefaultLanguage(String language)
    
 voidsetPathMapper(DefaultDocumentIdToPathMapper mapper)
    

Field Detail
ARCHIVE_AREA
String ARCHIVE_AREA(Code)
ARCHIVE_AREA The archive area



AUTHORING_AREA
String AUTHORING_AREA(Code)
AUTHORING_AREA The authoring area



CONFIGURATION_PATH
String CONFIGURATION_PATH(Code)
CONFIGURATION_PATH The configuration path



CONTENT_PATH
String CONTENT_PATH(Code)
CONTENT_PATH The content path



DAV_AREA
String DAV_AREA(Code)
DAV_AREA The webDAV authoring area



DELETE_PATH
String DELETE_PATH(Code)
DELETE_PATH The delete path



ITEM_TYPE
String ITEM_TYPE(Code)
The item type.



LIVE_AREA
String LIVE_AREA(Code)
LIVE_AREA The live area



PENDING_PATH
String PENDING_PATH(Code)
PENDING_PATH The pending path



PUBLICATION_PREFIX
String PUBLICATION_PREFIX(Code)
PUBLICATION_PREFIX The publication prefix



PUBLICATION_PREFIX_URI
String PUBLICATION_PREFIX_URI(Code)
PUBLICATION_PREFIX_URI The publication prefix URI



STAGING_AREA
String STAGING_AREA(Code)
STAGING_AREA The staging area



TRASH_AREA
String TRASH_AREA(Code)
TRASH_AREA The trash area





Method Detail
exists
boolean exists()(Code)
if this publication exists.



getArea
Area getArea(String name) throws PublicationException(Code)

Parameters:
  name - The name. An area object.
throws:
  PublicationException - if an error occurs.



getAreaNames
String[] getAreaNames()(Code)
The names of all available areas.



getBreadcrumbPrefix
String getBreadcrumbPrefix()(Code)
Get the breadcrumb prefix. It can be used as a prefix if a publication is part of a larger site the breadcrumb prefix



getContentDir
String getContentDir()(Code)
Returns the content dir. If the publication does not specify a content dir, then null is returned. A base directory where all the content is located.



getContentDirectory
File getContentDirectory(String area)(Code)
Return the directory of a specific area.
Parameters:
  area - a File representing the root of the area content directory. the directory of the given content area.



getContentURI
String getContentURI(String area)(Code)

Parameters:
  area - The area. the URI base under which contents in this publication are accessed



getDefaultLanguage
String getDefaultLanguage()(Code)
Get the default language the default language



getDirectory
File getDirectory()(Code)
Returns the publication directory. A File object.



getDocumentBuilder
DocumentBuilder getDocumentBuilder()(Code)
Returns the document builder of this instance. A hint to use for service selection.



getFactory
public DocumentFactory getFactory()(Code)
The document factory.



getId
String getId()(Code)
Returns the publication ID. A string value.



getInstantiatorHint
String getInstantiatorHint()(Code)
Returns the publication template instantiator hint. If the publication does not allow templating, null is returned. A hint to use for service selection.



getLanguages
String[] getLanguages()(Code)
Get all available languages for this publication an Array of languages



getName
String getName()(Code)
The name of the publication as specified in the configuration file.



getPathMapper
DocumentIdToPathMapper getPathMapper()(Code)
Returns the path mapper. a DocumentIdToPathMapper



getProxy
Proxy getProxy(Document document, boolean isSslProtected)(Code)
Returns the proxy which is used for a particular document's area (see Publication.getProxy(String,boolean) ).
Parameters:
  document - The document.
Parameters:
  isSslProtected - A boolean value. A proxy.



getProxy
Proxy getProxy(String area, boolean isSslProtected)(Code)

Returns the proxy which is used for the given area and the ssl parameter.

If no proxy is defined in the publication configuration file, a default proxy with the URL {contextPath}/{pubId}/{area} is returned.

If the area string is "root", the global proxy is returned. If no global proxy is defined, a default global proxy with the URL {contextPath} is returned.


Parameters:
  area - area
Parameters:
  isSslProtected - A boolean value. A proxy.



getResourceTypeNames
String[] getResourceTypeNames()(Code)
The resource types that are supported by this publication.



getServletContext
File getServletContext()(Code)
Returns the servlet context this publication belongs to (usually, the webapps/lenya directory). A File object.



getSiteManagerHint
String getSiteManagerHint()(Code)
Returns the hint of the site manager service that is used by this publication. A hint to use for service selection.



getSourceURI
String getSourceURI()(Code)
the URI base for this publication



getTemplateIds
String[] getTemplateIds()(Code)
The templates of the publication.



getWorkflowSchema
String getWorkflowSchema(ResourceType resourceType)(Code)

Parameters:
  resourceType - The resource type or null if no workflow is registered forthis resource type. The workflow schema to use for this resource type.



setDefaultLanguage
void setDefaultLanguage(String language)(Code)
Set the default language
Parameters:
  language - the default language



setPathMapper
void setPathMapper(DefaultDocumentIdToPathMapper mapper)(Code)
Set the path mapper
Parameters:
  mapper - The path mapper



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