org.gatein.api

Interface Portal

public interface Portal

The main interface of the portal public API. This is available from the PortalRequest object which can be obtained from PortalRequest.getInstance().

Author:

Nick Scavelli, Stian Thorgersen

Method Summary

Methods

Modifier and Type	Method and Description
Page	createPage(PageId pageId) Creates a page for a site given the PageId.
Site	createSite(SiteId siteId) Creates a a site given the SiteId.
Site	createSite(SiteId siteId, String templateName) Creates a a site given the SiteId.
List<Page>	findPages(PageQuery query) Finds pages given the PageQuery
List<Site>	findSites(SiteQuery query) Finds sites given the SiteQuery
Navigation	getNavigation(SiteId siteId) Returns the navigation of a site given the SiteId.
OAuthProvider	getOAuthProvider(String oauthProviderKey) Return OAuthProvider for given key.
Page	getPage(PageId pageId) Returns the page of a site given the PageId.
Site	getSite(SiteId siteId) Returns a site given the SiteId.
boolean	hasPermission(User user, Permission permission) Returns true if the given user has the rights represented by the permission
boolean	removePage(PageId pageId) Removes a page
boolean	removeSite(SiteId siteId) Removes a site
void	savePage(Page page) Saves a page
void	saveSite(Site site) Saves a site

Method Detail

getSite

Site getSite(SiteId siteId)

Returns a site given the SiteId. Can return null if the site does not exist.

Parameters:

siteId - the siteId

Returns:

the site or null if the site does not exist

Throws:

IllegalArgumentException - if siteId is null

ApiException - if something prevented this operation to succeed

createSite

Site createSite(SiteId siteId)

Creates a a site given the SiteId. This site is not saved until saveSite(org.gatein.api.site.Site) is called. Will use the default site template configured by the portal.

Parameters:

siteId - the site id

Returns:

the new site which has not been saved yet.

Throws:

IllegalArgumentException - if siteId is null

EntityAlreadyExistsException - if the site already exists

ApiException - if something prevented this operation to succeed

createSite

Site createSite(SiteId siteId,
              String templateName)

Creates a a site given the SiteId. This site is not saved until saveSite(org.gatein.api.site.Site) is called.

Parameters:

siteId - the site id

templateName - the name of the template to use to create the site

Returns:

the new site which has not been saved yet.

Throws:

IllegalArgumentException - if siteId is null

EntityAlreadyExistsException - if the site already exists

ApiException - if something prevented this operation to succeed

findSites

List<Site> findSites(SiteQuery query)

Finds sites given the SiteQuery

Parameters:

query - the site query

Returns:

list of sites found. The list will be empty if no sites were found.

Throws:

IllegalArgumentException - if query is null

ApiException - if something prevented this operation to succeed

saveSite

void saveSite(Site site)

Saves a site

Parameters:

site - the site to save

Throws:

IllegalArgumentException - if site is null

ApiException - if an exception occurred trying to save the site

removeSite

boolean removeSite(SiteId siteId)

Removes a site

Parameters:

siteId - the id of the site to remove

Returns:

true if the site was removed, false otherwise

Throws:

IllegalArgumentException - if siteId is null

ApiException - if something prevented this operation to succeed

getNavigation

Navigation getNavigation(SiteId siteId)

Returns the navigation of a site given the SiteId. Can return null if the navigation does not exist.

Parameters:

siteId - the site id

Returns:

navigation for a site, or null if the navigation does not exist

Throws:

IllegalArgumentException - if siteId is null

ApiException - if something prevented this operation to succeed

getPage

Page getPage(PageId pageId)

Returns the page of a site given the PageId. Can return null if the page does not exist.

Parameters:

pageId - the page id

Returns:

the page or null if the page does not exist

Throws:

IllegalArgumentException - if pageId is null

ApiException - if something prevented this operation to succeed

createPage

Page createPage(PageId pageId)

Creates a page for a site given the PageId. This page is not saved until savePage(org.gatein.api.page.Page) is called.

Parameters:

pageId - the page id

Returns:

the new page which has not been saved yet.

Throws:

IllegalArgumentException - if pageId is null

EntityAlreadyExistsException - if the page already exists

EntityNotFoundException - if the site does not exist

ApiException - if something prevented this operation to succeed

findPages

List<Page> findPages(PageQuery query)

Finds pages given the PageQuery

Parameters:

query - the page query

Returns:

list of pages found. List is empty if no pages were found.

Throws:

IllegalArgumentException - if query is null

ApiException - if something prevented this operation to succeed

savePage

void savePage(Page page)

Saves a page

Parameters:

page - the page to save

Throws:

IllegalArgumentException - if page is null

ApiException - if something prevented this operation to succeed

removePage

boolean removePage(PageId pageId)

Removes a page

Parameters:

pageId - the id of the page to remove

Returns:

true if the page was removed, false otherwise

Throws:

IllegalArgumentException - if pageId is null

ApiException - if something prevented this operation to succeed

hasPermission

boolean hasPermission(User user,
                    Permission permission)

Returns true if the given user has the rights represented by the permission

Parameters:

user - the user

permission - the permission

Returns:

true if the user has rights represented by the permission

Throws:

ApiException - if something prevented this operation to succeed

getOAuthProvider

OAuthProvider getOAuthProvider(String oauthProviderKey)

Return OAuthProvider for given key. Key could be OAuthProvider.FACEBOOK, OAuthProvider.GOOGLE, OAuthProvider.TWITTER or other OAuth provider registered in Portal via OAuth SPI

Parameters:

oauthProviderKey - Key of OAuth provider

Returns:

OAuth provider or null if OAuth provider with given key was not found