org.nuxeo.core.resources.model
Interface ISite

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IContainer, ISiteFolder, ISiteResource
All Known Implementing Classes:
Site

public interface ISite
extends ISiteFolder

A site manage a tree of resources and is the tree resource root Resources are managed through the site controller. Site controller are registered for each type of site

Author:
Bogdan Stefanescu

Field Summary
 
Fields inherited from interface org.nuxeo.core.resources.model.ISiteResource
FILE, FOLDER, SITE
 
Fields inherited from interface org.nuxeo.core.resources.model.IContainer
EMPTY_CHILDREN
 
Method Summary
 java.lang.String getAuthority()
          Get the authority part from the site URI
 ISiteController getController()
          Get the controller that is managing this site * Site controllers are registered on site schemas.
 java.lang.String getPath(java.lang.String uri)
          Get the absolute path in this site for the given URI
 java.lang.String getScheme()
          Get the site scheme.
 
Methods inherited from interface org.nuxeo.core.resources.model.ISiteFolder
getFile, getFolder
 
Methods inherited from interface org.nuxeo.core.resources.model.ISiteResource
accept, create, delete, edit, exists, getContents, getMetadata, getName, getParent, getPath, getSite, getType, getURI, modify
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface org.nuxeo.core.resources.model.IContainer
children, findChild
 

Method Detail

getController

ISiteController getController()
Get the controller that is managing this site * Site controllers are registered on site schemas.

Returns:
the controller. If no controller is asscoiated to this type of sites the NullSiteController is returned

getScheme

java.lang.String getScheme()
Get the site scheme. The site scheme is defining the site type.
The site scheme (i.e. type) is used to bound the site to a controller.

Returns:
the site scheme

getAuthority

java.lang.String getAuthority()
Get the authority part from the site URI

Returns:
the host part

getPath

java.lang.String getPath(java.lang.String uri)
Get the absolute path in this site for the given URI

Parameters:
uri - the URI. the given URI should be in a normalized form (should not contains "../" or "./").
Returns:
the path in this site of the given URI or null if this URI is not under this site