|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Publication
A Lenya publication.
Field Summary | |
---|---|
static java.lang.String |
ADMIN_AREA
|
static java.lang.String |
ARCHIVE_AREA
|
static java.lang.String |
ATTRIBUTE_TYPE
|
static java.lang.String |
AUTHORING_AREA
|
static java.lang.String |
BREADCRUMB_PREFIX
|
static java.lang.String |
CONFIGURATION_FILE
|
static java.lang.String |
CONFIGURATION_PATH
|
static java.lang.String |
CONTENT_PATH
|
static java.lang.String |
DEFAULT_LANGUAGE_ATTR
|
static java.lang.String |
DELETE_PATH
|
static java.lang.String |
ELEMENT_DOCUMENT_BUILDER
|
static java.lang.String |
ELEMENT_PATH_MAPPER
|
static java.lang.String |
ELEMENT_SITE_STRUCTURE
|
static java.lang.String |
INFO_AREA_PREFIX
|
static java.lang.String |
LANGUAGE
|
static java.lang.String |
LANGUAGES
|
static java.lang.String |
LIVE_AREA
|
static java.lang.String |
LIVE_MOUNT_POINT
|
static java.lang.String |
PENDING_PATH
|
static java.lang.String |
PUBLICATION_PREFIX
|
static java.lang.String |
PUBLICATION_PREFIX_URI
|
static java.lang.String |
SEARCH_AREA_PREFIX
|
static java.lang.String |
SSL_PREFIX
|
static java.lang.String |
STAGING_AREA
|
static java.lang.String |
TRASH_AREA
|
Method Summary | |
---|---|
void |
copyDocument(Document sourceDocument,
Document destinationDocument)
Copies a document from one location to another location. |
void |
copyDocumentSetToArea(DocumentSet documentSet,
java.lang.String destinationArea)
Copies a document set to another area. |
void |
copyDocumentToArea(Document sourceDocument,
java.lang.String destinationArea)
Copies a document to another area. |
void |
deleteDocument(Document document)
Deletes a document. |
Document |
getAreaVersion(Document document,
java.lang.String area)
Creates a version of the document object in another area. |
java.lang.String |
getBreadcrumbPrefix()
Get the breadcrumb prefix. |
java.io.File |
getContentDirectory(java.lang.String area)
Return the directory of a specific area. |
java.lang.String |
getDefaultLanguage()
Get the default language |
java.io.File |
getDirectory()
Returns the publication directory. |
DocumentBuilder |
getDocumentBuilder()
Returns the document builder of this instance. |
PublishingEnvironment |
getEnvironment()
Deprecated. It is planned to decouple the environments from the publication. |
java.lang.String |
getId()
Returns the publication ID. |
java.lang.String[] |
getLanguages()
Get all available languages for this publication |
java.lang.String |
getLiveMountPoint()
Get the Live mount point. |
DocumentIdToPathMapper |
getPathMapper()
Returns the path mapper. |
Proxy |
getProxy(Document document,
boolean isSslProtected)
Returns the proxy which is used for a particular document. |
java.lang.String[] |
getRewriteAttributeXPaths()
Returns an array of XPaths representing attributes to be rewritten when a document URL has changed. |
java.io.File |
getServletContext()
Returns the servlet context this publication belongs to (usually, the webapps/lenya directory). |
DefaultSiteTree |
getSiteTree(java.lang.String area)
Deprecated. Please use getTree() because this method returns the interface and not a specific implementation |
java.lang.String |
getSSLPrefix()
Get the SSL prefix. |
SiteTree |
getTree(java.lang.String area)
Get the sitetree for a specific area of this publication. |
void |
moveDocument(Document sourceDocument,
Document destinationDocument)
Moves a document from one location to another. |
void |
setDefaultLanguage(java.lang.String language)
Set the default language |
void |
setPathMapper(DefaultDocumentIdToPathMapper mapper)
DOCUMENT ME! |
Field Detail |
---|
static final java.lang.String AUTHORING_AREA
static final java.lang.String STAGING_AREA
static final java.lang.String LIVE_AREA
static final java.lang.String ADMIN_AREA
static final java.lang.String ARCHIVE_AREA
static final java.lang.String TRASH_AREA
static final java.lang.String ELEMENT_PATH_MAPPER
static final java.lang.String ELEMENT_DOCUMENT_BUILDER
static final java.lang.String ELEMENT_SITE_STRUCTURE
static final java.lang.String ATTRIBUTE_TYPE
static final java.lang.String LANGUAGES
static final java.lang.String LANGUAGE
static final java.lang.String DEFAULT_LANGUAGE_ATTR
static final java.lang.String BREADCRUMB_PREFIX
static final java.lang.String SSL_PREFIX
static final java.lang.String LIVE_MOUNT_POINT
static final java.lang.String PUBLICATION_PREFIX
static final java.lang.String PUBLICATION_PREFIX_URI
static final java.lang.String CONFIGURATION_PATH
static final java.lang.String CONTENT_PATH
static final java.lang.String PENDING_PATH
static final java.lang.String DELETE_PATH
static final java.lang.String INFO_AREA_PREFIX
static final java.lang.String SEARCH_AREA_PREFIX
static final java.lang.String CONFIGURATION_FILE
Method Detail |
---|
java.lang.String getId()
PublishingEnvironment getEnvironment()
PublishingEnvironment
object.java.io.File getServletContext()
webapps/lenya
directory).
File
object.java.io.File getDirectory()
File
object.java.io.File getContentDirectory(java.lang.String area)
area
- a File
representing the root of the area content directory.
void setPathMapper(DefaultDocumentIdToPathMapper mapper)
mapper
- DOCUMENT ME!DocumentIdToPathMapper getPathMapper()
DocumentIdToPathMapper
java.lang.String getDefaultLanguage()
void setDefaultLanguage(java.lang.String language)
language
- the default languagejava.lang.String[] getLanguages()
Array
of languagesjava.lang.String getBreadcrumbPrefix()
java.lang.String getSSLPrefix()
java.lang.String getLiveMountPoint()
SiteTree getTree(java.lang.String area) throws SiteTreeException
area
- the area
SiteTreeException
- if an error occursDefaultSiteTree getSiteTree(java.lang.String area) throws SiteTreeException
area
- the area
SiteTreeException
- if an error occursgetTree()
DocumentBuilder getDocumentBuilder()
void copyDocument(Document sourceDocument, Document destinationDocument) throws PublicationException
sourceDocument
- The document to copy.destinationDocument
- The destination document.
PublicationException
- if a document which destinationDocument depends on
does not exist.void copyDocumentToArea(Document sourceDocument, java.lang.String destinationArea) throws PublicationException
sourceDocument
- The document to copy.destinationArea
- The destination area.
PublicationException
- if a document which the
destination document depends on does not exist.void copyDocumentSetToArea(DocumentSet documentSet, java.lang.String destinationArea) throws PublicationException
documentSet
- The document set to copy.destinationArea
- The destination area.
PublicationException
- if a document which one of the
destination documents depends on does not exist.void deleteDocument(Document document) throws PublicationException
document
- The document to delete.
PublicationException
- when something went wrong.void moveDocument(Document sourceDocument, Document destinationDocument) throws PublicationException
sourceDocument
- The source document.destinationDocument
- The destination document.
PublicationException
- if a document which the
destination document depends on does not exist.Document getAreaVersion(Document document, java.lang.String area) throws PublicationException
document
- The document to clone.area
- The destination area.
PublicationException
- when an error occurs.Proxy getProxy(Document document, boolean isSslProtected)
document
- The document.isSslProtected
- A boolean value.
null
if no proxy is defined
for this version.java.lang.String[] getRewriteAttributeXPaths()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |