Represents the root of a website. A "website" in this context is a product, its a customer facing side of some activity, such as Learning Management System or business website. Resources within a WebsiteRootFolder will often behave differently then if they were located under a OrganisationRootFolder, because the assumption is that websites are for customers, while aadministrators will accessing the organisation directly While WebsiteRootFolder is a view of a repository (or rather a branch within a repository) it also provides access to other repositories. Any repository within the containing organisation can be access by name from the root folder. For example, if an org has this structure: myOrg - milton.io - maven ... then requests to http://milton.io/maven will show the maven repository
Extends: BranchFolder
Implements: WebsiteBranchResource, RootFolder, CommonCollectionResource, GetableResource, PropFindableResource, WebsiteResource, RepositoryResource
Properties
| Name | Returns | Notes |
|---|---|---|
| adminDomainName | String | Get the admin domain name for current website |
| allGroupFolders | List<GroupFolder> | |
| allGroups | List<Group> | Return all groups defined by the organisation |
| attributes | Map<String,Object> | |
| comments | List<CommentBean> | |
| domainName | String | |
| emailAddress | String | |
| externalUrl | String | |
| id | String | |
| languages | List<Language> | |
| modifiedDate | Date | |
| name | String | |
| newComment | String | This is just here to make newComment a bean property |
| numComments | int | |
| orgData | OrgData | Get the OrgData for the organisation that owns this website. This can be used to get a list of members within the organisation |
| orgTypes | List<OrgType> | Returns all organisation types defined by the organisation holding this website |
| readonly | boolean | |
| requiresHttps | boolean | |
| settings | WebsiteSettings | |
| themeName | String | |
| usersFolder | UsersFolder | |
| versioned | boolean | True if this website was resolved on a versioned host address |
| website | Website | |
| websiteName | String |
Methods
| Signature | Returns | Notes |
|---|---|---|
externalUrl(String path) | String | Build a fully qualified URL for an (optional) path to this website |
returnWithCurrent(Function<RootFolder,Object> c) | Object | Execute the given function, returning the return value |
doWithCurrent(Consumer<RootFolder> c) | void |