org.apache.jetspeed.om.folder.impl
Class FolderImpl

java.lang.Object
  extended byorg.apache.jetspeed.om.page.psml.AbstractBaseElement
      extended byorg.apache.jetspeed.page.document.AbstractNode
          extended byorg.apache.jetspeed.om.folder.impl.FolderImpl
All Implemented Interfaces:
org.apache.jetspeed.om.page.BaseElement, org.apache.jetspeed.om.folder.Folder, org.apache.jetspeed.page.document.Node, org.apache.jetspeed.om.folder.Reset, org.apache.jetspeed.om.common.SecuredResource, Serializable

public class FolderImpl
extends AbstractNode
implements org.apache.jetspeed.om.folder.Folder, org.apache.jetspeed.om.folder.Reset

FolderImpl

Version:
$Id: FolderImpl.java 219058 2005-07-14 16:29:27Z rwatler $
Author:
David Sean Taylor , Jeremy Ford , Scott T. Weaver
See Also:
Serialized Form

Field Summary
private  org.apache.jetspeed.page.document.NodeSet allNodes
           
private  String defaultTheme
           
private  File directory
           
private static String FOLDER_PERMISSION_WILD_CHAR
           
private  org.apache.jetspeed.page.document.FolderHandler folderHandler
           
private static org.apache.commons.logging.Log log
           
private  org.apache.jetspeed.om.folder.FolderMetaData metadata
           
private static String RESERVED_COUNTRY_FOLDER_NAME
           
private static String RESERVED_FOLDER_PREFIX
           
private static String RESERVED_GROUP_FOLDER_NAME
           
private static String RESERVED_LANGUAGE_FOLDER_NAME
           
private static String RESERVED_MEDIATYPE_FOLDER_NAME
           
private static String RESERVED_ROLE_FOLDER_NAME
           
private static String RESERVED_SUBSITES_FOLDER_NAME
           
private static String RESERVED_USER_FOLDER_NAME
           
private  int reservedType
           
 
Fields inherited from class org.apache.jetspeed.page.document.AbstractNode
 
Fields inherited from class org.apache.jetspeed.om.page.psml.AbstractBaseElement
 
Fields inherited from interface org.apache.jetspeed.om.folder.Folder
FALLBACK_DEFAULT_PAGE, FOLDER_TYPE, GROUP_FOLDER, PAGE_NOT_FOUND_PAGE, RESERVED_FOLDER_COUNTRY, RESERVED_FOLDER_GROUPS, RESERVED_FOLDER_LANGUAGE, RESERVED_FOLDER_MEDIATYPE, RESERVED_FOLDER_NONE, RESERVED_FOLDER_OTHER, RESERVED_FOLDER_ROLES, RESERVED_FOLDER_SUBSITES, RESERVED_FOLDER_USERS, ROLE_FOLDER, USER_FOLDER
 
Fields inherited from interface org.apache.jetspeed.page.document.Node
PATH_SEPARATOR, PATH_SEPARATOR_CHAR
 
Fields inherited from interface org.apache.jetspeed.om.common.SecuredResource
EDIT_ACTION, VIEW_ACTION
 
Constructor Summary
FolderImpl()
           
FolderImpl(String path, org.apache.jetspeed.page.document.DocumentHandlerFactory handlerFactory, org.apache.jetspeed.page.document.FolderHandler folderHandler)
           
FolderImpl(String path, org.apache.jetspeed.om.folder.FolderMetaData metadata, org.apache.jetspeed.page.document.DocumentHandlerFactory handlerFactory, org.apache.jetspeed.page.document.FolderHandler folderHandler)
           
 
Method Summary
 void checkPermissions(String path, String actions, boolean checkNodeOnly, boolean checkParentsOnly)
           checkPermissions
 org.apache.jetspeed.page.document.NodeSet getAll()
           
 org.apache.jetspeed.page.document.NodeSet getAllNodes()
           getAllNodes
 String getDefaultPage(boolean allowDefaulting)
           
 String getDefaultTheme()
           
 org.apache.jetspeed.om.folder.Folder getFolder(String name)
           
 org.apache.jetspeed.om.folder.Folder getFolder(String name, boolean checkAccess)
           getFolder
 org.apache.jetspeed.om.folder.FolderMetaData getFolderMetaData()
           getFolderMetaData
 org.apache.jetspeed.page.document.NodeSet getFolders()
           
 org.apache.jetspeed.page.document.NodeSet getFolders(boolean checkAccess)
           getFolders
 org.apache.jetspeed.om.page.Link getLink(String name)
           
 org.apache.jetspeed.om.page.Link getLink(String name, boolean checkAccess)
           getLink
 org.apache.jetspeed.page.document.NodeSet getLinks()
           
 org.apache.jetspeed.page.document.NodeSet getLinks(boolean checkAccess)
           getLinks
 List getMenuDefinitions()
          getMenuDefinitions - get list of menu definitions
 org.apache.jetspeed.om.common.GenericMetadata getMetadata()
           getMetadata
 org.apache.jetspeed.om.page.Page getPage(String name)
           
 org.apache.jetspeed.om.page.Page getPage(String name, boolean checkAccess)
           getPage
 org.apache.jetspeed.page.document.NodeSet getPages()
           
 org.apache.jetspeed.page.document.NodeSet getPages(boolean checkAccess)
           getPages
 org.apache.jetspeed.om.page.PageSecurity getPageSecurity()
           
 org.apache.jetspeed.om.page.PageSecurity getPageSecurity(boolean checkAccess)
           getPageSecurity
 int getReservedType()
           
 org.apache.jetspeed.om.common.SecurityConstraints getSecurityConstraints()
           getSecurityConstraints
 String getShortTitle()
           getShortTitle
 String getShortTitle(Locale locale)
           getShortTitle
 String getTitle()
           getTitle
 String getTitle(Locale locale)
           getTitle
 String getType()
           getType
 boolean isHidden()
           isHidden
 boolean isReserved()
           
 void reset()
           
 void setDefaultPage(String defaultPage)
           
 void setDefaultTheme(String defaultTheme)
           
 void setFolderHandler(org.apache.jetspeed.page.document.FolderHandler handler)
           setFolderHandler
 void setHidden(boolean hidden)
           setHidden
 void setMenuDefinitions(List definitions)
          setMenuDefinitions - set list of menu definitions
private  void setReservedType()
           
 void setSecurityConstraints(org.apache.jetspeed.om.common.SecurityConstraints constraints)
           setSecurityConstraints
 void setShortTitle(String title)
           setShortTitle
 void setTitle(String title)
           setTitle
 void unmarshalled()
          unmarshalled - notification that this instance has been loaded from the persistent store
 
Methods inherited from class org.apache.jetspeed.page.document.AbstractNode
checkConstraints, getLogicalPermissionPath, getMetadataFields, getName, getParent, getParent, getPath, getPhysicalPermissionPath, getProfiledPath, getTitleName, getUrl, setMetadata, setMetadataFields, setParent, setPath, setProfiledPath, setUrl
 
Methods inherited from class org.apache.jetspeed.om.page.psml.AbstractBaseElement
checkAccess, checkAccess, checkConstraints, checkPermissions, checkPermissions, clone, equals, getConstraintsEnabled, getHandlerFactory, getId, getPermissionsEnabled, grantViewActionAccess, hashCode, marshalling, setConstraintsEnabled, setHandlerFactory, setId, setPermissionsEnabled, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.jetspeed.page.document.Node
getName, getParent, getPath, getUrl, setParent, setPath
 
Methods inherited from interface org.apache.jetspeed.om.page.BaseElement
getId, setId
 
Methods inherited from interface org.apache.jetspeed.om.common.SecuredResource
checkAccess, checkConstraints, checkPermissions, getConstraintsEnabled, getPermissionsEnabled
 

Field Detail

FOLDER_PERMISSION_WILD_CHAR

private static final String FOLDER_PERMISSION_WILD_CHAR

defaultTheme

private String defaultTheme

allNodes

private org.apache.jetspeed.page.document.NodeSet allNodes

directory

private File directory

metadata

private org.apache.jetspeed.om.folder.FolderMetaData metadata

folderHandler

private org.apache.jetspeed.page.document.FolderHandler folderHandler

reservedType

private int reservedType

log

private static final org.apache.commons.logging.Log log

RESERVED_FOLDER_PREFIX

private static final String RESERVED_FOLDER_PREFIX
See Also:
Constant Field Values

RESERVED_USER_FOLDER_NAME

private static final String RESERVED_USER_FOLDER_NAME
See Also:
Constant Field Values

RESERVED_ROLE_FOLDER_NAME

private static final String RESERVED_ROLE_FOLDER_NAME
See Also:
Constant Field Values

RESERVED_GROUP_FOLDER_NAME

private static final String RESERVED_GROUP_FOLDER_NAME
See Also:
Constant Field Values

RESERVED_SUBSITES_FOLDER_NAME

private static final String RESERVED_SUBSITES_FOLDER_NAME
See Also:
Constant Field Values

RESERVED_MEDIATYPE_FOLDER_NAME

private static final String RESERVED_MEDIATYPE_FOLDER_NAME
See Also:
Constant Field Values

RESERVED_LANGUAGE_FOLDER_NAME

private static final String RESERVED_LANGUAGE_FOLDER_NAME
See Also:
Constant Field Values

RESERVED_COUNTRY_FOLDER_NAME

private static final String RESERVED_COUNTRY_FOLDER_NAME
See Also:
Constant Field Values
Constructor Detail

FolderImpl

public FolderImpl(String path,
                  org.apache.jetspeed.om.folder.FolderMetaData metadata,
                  org.apache.jetspeed.page.document.DocumentHandlerFactory handlerFactory,
                  org.apache.jetspeed.page.document.FolderHandler folderHandler)

FolderImpl

public FolderImpl(String path,
                  org.apache.jetspeed.page.document.DocumentHandlerFactory handlerFactory,
                  org.apache.jetspeed.page.document.FolderHandler folderHandler)

FolderImpl

public FolderImpl()
Method Detail

getDefaultPage

public String getDefaultPage(boolean allowDefaulting)
Specified by:
getDefaultPage in interface org.apache.jetspeed.om.folder.Folder

setDefaultPage

public void setDefaultPage(String defaultPage)
Specified by:
setDefaultPage in interface org.apache.jetspeed.om.folder.Folder

getDefaultTheme

public String getDefaultTheme()
Specified by:
getDefaultTheme in interface org.apache.jetspeed.om.folder.Folder

setDefaultTheme

public void setDefaultTheme(String defaultTheme)
Specified by:
setDefaultTheme in interface org.apache.jetspeed.om.folder.Folder

getFolders

public org.apache.jetspeed.page.document.NodeSet getFolders(boolean checkAccess)
                                                     throws org.apache.jetspeed.om.folder.FolderNotFoundException,
                                                            org.apache.jetspeed.page.document.DocumentException

getFolders

Parameters:
checkAccess - flag
Returns:
folders node set
Throws:
org.apache.jetspeed.om.folder.FolderNotFoundException
org.apache.jetspeed.page.document.DocumentException

getFolders

public org.apache.jetspeed.page.document.NodeSet getFolders()
                                                     throws org.apache.jetspeed.om.folder.FolderNotFoundException,
                                                            org.apache.jetspeed.page.document.DocumentException
Specified by:
getFolders in interface org.apache.jetspeed.om.folder.Folder
Throws:
org.apache.jetspeed.om.folder.FolderNotFoundException
org.apache.jetspeed.page.document.DocumentException

getFolder

public org.apache.jetspeed.om.folder.Folder getFolder(String name,
                                                      boolean checkAccess)
                                               throws org.apache.jetspeed.om.folder.FolderNotFoundException,
                                                      org.apache.jetspeed.page.document.DocumentException

getFolder

Parameters:
name -
checkAccess - flag
Returns:
folder
Throws:
org.apache.jetspeed.om.folder.FolderNotFoundException
org.apache.jetspeed.page.document.DocumentException

getFolder

public org.apache.jetspeed.om.folder.Folder getFolder(String name)
                                               throws org.apache.jetspeed.om.folder.FolderNotFoundException,
                                                      org.apache.jetspeed.page.document.DocumentException
Specified by:
getFolder in interface org.apache.jetspeed.om.folder.Folder
Throws:
org.apache.jetspeed.om.folder.FolderNotFoundException
org.apache.jetspeed.page.document.DocumentException

getPages

public org.apache.jetspeed.page.document.NodeSet getPages(boolean checkAccess)
                                                   throws org.apache.jetspeed.page.document.NodeException

getPages

Parameters:
checkAccess - flag
Returns:
pages node set
Throws:
org.apache.jetspeed.page.document.NodeException

getPages

public org.apache.jetspeed.page.document.NodeSet getPages()
                                                   throws org.apache.jetspeed.page.document.NodeException
Specified by:
getPages in interface org.apache.jetspeed.om.folder.Folder
Throws:
org.apache.jetspeed.page.document.NodeException

getPage

public org.apache.jetspeed.om.page.Page getPage(String name,
                                                boolean checkAccess)
                                         throws org.apache.jetspeed.page.PageNotFoundException,
                                                org.apache.jetspeed.page.document.NodeException

getPage

Parameters:
name -
checkAccess - flag
Returns:
page
Throws:
org.apache.jetspeed.page.PageNotFoundException
org.apache.jetspeed.page.document.NodeException

getPage

public org.apache.jetspeed.om.page.Page getPage(String name)
                                         throws org.apache.jetspeed.page.PageNotFoundException,
                                                org.apache.jetspeed.page.document.NodeException
Specified by:
getPage in interface org.apache.jetspeed.om.folder.Folder
Throws:
org.apache.jetspeed.page.PageNotFoundException
org.apache.jetspeed.page.document.NodeException

getLinks

public org.apache.jetspeed.page.document.NodeSet getLinks(boolean checkAccess)
                                                   throws org.apache.jetspeed.page.document.NodeException

getLinks

Parameters:
checkAccess - flag
Returns:
links node set
Throws:
org.apache.jetspeed.page.document.NodeException

getLinks

public org.apache.jetspeed.page.document.NodeSet getLinks()
                                                   throws org.apache.jetspeed.page.document.NodeException
Specified by:
getLinks in interface org.apache.jetspeed.om.folder.Folder
Throws:
org.apache.jetspeed.page.document.NodeException

getLink

public org.apache.jetspeed.om.page.Link getLink(String name,
                                                boolean checkAccess)
                                         throws org.apache.jetspeed.page.document.DocumentNotFoundException,
                                                org.apache.jetspeed.page.document.NodeException

getLink

Parameters:
name -
checkAccess - flag
Returns:
link
Throws:
org.apache.jetspeed.page.document.DocumentNotFoundException
org.apache.jetspeed.page.document.NodeException

getLink

public org.apache.jetspeed.om.page.Link getLink(String name)
                                         throws org.apache.jetspeed.page.document.DocumentNotFoundException,
                                                org.apache.jetspeed.page.document.NodeException
Specified by:
getLink in interface org.apache.jetspeed.om.folder.Folder
Throws:
org.apache.jetspeed.page.document.DocumentNotFoundException
org.apache.jetspeed.page.document.NodeException

getPageSecurity

public org.apache.jetspeed.om.page.PageSecurity getPageSecurity(boolean checkAccess)
                                                         throws org.apache.jetspeed.page.document.DocumentNotFoundException,
                                                                org.apache.jetspeed.page.document.NodeException

getPageSecurity

Parameters:
checkAccess - flag
Returns:
page security
Throws:
org.apache.jetspeed.page.document.DocumentNotFoundException
org.apache.jetspeed.page.document.NodeException

getPageSecurity

public org.apache.jetspeed.om.page.PageSecurity getPageSecurity()
                                                         throws org.apache.jetspeed.page.document.DocumentNotFoundException,
                                                                org.apache.jetspeed.page.document.NodeException
Specified by:
getPageSecurity in interface org.apache.jetspeed.om.folder.Folder
Throws:
org.apache.jetspeed.page.document.DocumentNotFoundException
org.apache.jetspeed.page.document.NodeException

getAll

public org.apache.jetspeed.page.document.NodeSet getAll()
                                                 throws org.apache.jetspeed.om.folder.FolderNotFoundException,
                                                        org.apache.jetspeed.page.document.DocumentException
Specified by:
getAll in interface org.apache.jetspeed.om.folder.Folder
Throws:
org.apache.jetspeed.om.folder.FolderNotFoundException
org.apache.jetspeed.page.document.DocumentException

getAllNodes

public org.apache.jetspeed.page.document.NodeSet getAllNodes()
                                                      throws org.apache.jetspeed.om.folder.FolderNotFoundException,
                                                             org.apache.jetspeed.page.document.DocumentException

getAllNodes

Returns:
all nodes immediatley under this
Throws:
org.apache.jetspeed.page.document.DocumentException
org.apache.jetspeed.om.folder.FolderNotFoundException

getFolderMetaData

public org.apache.jetspeed.om.folder.FolderMetaData getFolderMetaData()

getFolderMetaData

Specified by:
getFolderMetaData in interface org.apache.jetspeed.om.folder.Folder
Returns:
See Also:
Folder.getFolderMetaData()

setFolderHandler

public void setFolderHandler(org.apache.jetspeed.page.document.FolderHandler handler)

setFolderHandler

Parameters:
handler - folder handler

getMetadata

public org.apache.jetspeed.om.common.GenericMetadata getMetadata()

getMetadata

Specified by:
getMetadata in interface org.apache.jetspeed.page.document.Node
Overrides:
getMetadata in class AbstractNode
Returns:
See Also:
AbstractNode.getMetadata()

getSecurityConstraints

public org.apache.jetspeed.om.common.SecurityConstraints getSecurityConstraints()

getSecurityConstraints

Specified by:
getSecurityConstraints in interface org.apache.jetspeed.om.common.SecuredResource
Overrides:
getSecurityConstraints in class AbstractBaseElement
Returns:
See Also:
org.apache.jetspeed.om.common.SecureResource#getSecurityConstraints()

setSecurityConstraints

public void setSecurityConstraints(org.apache.jetspeed.om.common.SecurityConstraints constraints)

setSecurityConstraints

Specified by:
setSecurityConstraints in interface org.apache.jetspeed.om.common.SecuredResource
Overrides:
setSecurityConstraints in class AbstractBaseElement
Parameters:
constraints -
See Also:
org.apache.jetspeed.om.common.SecureResource#setSecurityConstraints(org.apache.jetspeed.om.common.SecurityConstraints)

checkPermissions

public void checkPermissions(String path,
                             String actions,
                             boolean checkNodeOnly,
                             boolean checkParentsOnly)
                      throws SecurityException

checkPermissions

Overrides:
checkPermissions in class AbstractNode
Parameters:
path -
actions -
checkNodeOnly -
checkParentsOnly -
Throws:
SecurityException

getTitle

public String getTitle(Locale locale)

getTitle

Specified by:
getTitle in interface org.apache.jetspeed.page.document.Node
Overrides:
getTitle in class AbstractNode
Parameters:
locale -
Returns:
See Also:
Node.getTitle(java.util.Locale)

getTitle

public String getTitle()

getTitle

Specified by:
getTitle in interface org.apache.jetspeed.om.page.BaseElement
Overrides:
getTitle in class AbstractBaseElement
Returns:
See Also:
BaseElement.getTitle()

setTitle

public void setTitle(String title)

setTitle

Specified by:
setTitle in interface org.apache.jetspeed.om.page.BaseElement
Overrides:
setTitle in class AbstractBaseElement
Parameters:
title -
See Also:
BaseElement.setTitle(java.lang.String)

getShortTitle

public String getShortTitle(Locale locale)

getShortTitle

Specified by:
getShortTitle in interface org.apache.jetspeed.page.document.Node
Overrides:
getShortTitle in class AbstractNode
Parameters:
locale -
Returns:
See Also:
Node.getShortTitle(java.util.Locale)

getShortTitle

public String getShortTitle()

getShortTitle

Specified by:
getShortTitle in interface org.apache.jetspeed.om.page.BaseElement
Overrides:
getShortTitle in class AbstractBaseElement
Returns:
See Also:
BaseElement.getShortTitle()

setShortTitle

public void setShortTitle(String title)

setShortTitle

Specified by:
setShortTitle in interface org.apache.jetspeed.om.page.BaseElement
Overrides:
setShortTitle in class AbstractBaseElement
Parameters:
title -
See Also:
BaseElement.setShortTitle(java.lang.String)

getType

public String getType()

getType

Specified by:
getType in interface org.apache.jetspeed.page.document.Node
Returns:
See Also:
Node.getType()

isHidden

public boolean isHidden()

isHidden

Specified by:
isHidden in interface org.apache.jetspeed.page.document.Node
Overrides:
isHidden in class AbstractNode
Returns:
See Also:
Node.isHidden()

setHidden

public void setHidden(boolean hidden)

setHidden

Overrides:
setHidden in class AbstractNode
Parameters:
hidden -
See Also:
AbstractNode.setHidden(boolean)

reset

public void reset()
Specified by:
reset in interface org.apache.jetspeed.om.folder.Reset

getMenuDefinitions

public List getMenuDefinitions()
getMenuDefinitions - get list of menu definitions

Specified by:
getMenuDefinitions in interface org.apache.jetspeed.om.folder.Folder
Returns:
definition list

setMenuDefinitions

public void setMenuDefinitions(List definitions)
setMenuDefinitions - set list of menu definitions

Specified by:
setMenuDefinitions in interface org.apache.jetspeed.om.folder.Folder
Parameters:
definitions - definition list

unmarshalled

public void unmarshalled()
unmarshalled - notification that this instance has been loaded from the persistent store

Overrides:
unmarshalled in class AbstractNode

isReserved

public boolean isReserved()
Specified by:
isReserved in interface org.apache.jetspeed.om.folder.Folder

getReservedType

public int getReservedType()
Specified by:
getReservedType in interface org.apache.jetspeed.om.folder.Folder

setReservedType

private void setReservedType()


Copyright © 1999-2005 Apache Software Foundation. All Rights Reserved.