A B C D E F G H I K L M N O P R S T U V W

A

accept(T) - Method in interface org.gatein.api.common.Filter

The accept method used to filter an element

AccessToken - Interface in org.gatein.api.oauth

Access token object, which encapsulates all important informations about OAuth1 or OAuth2 access token

addChild(String) - Method in interface org.gatein.api.navigation.Node

Adds a child to this navigation node.

addChild(int, String) - Method in interface org.gatein.api.navigation.Node

Inserts a child to this navigation node at the specified index.

addMembership(Membership) - Method in class org.gatein.api.security.Permission

Creates a new permission that includes all memberships of this permission and the specified membership

ALL - Static variable in class org.gatein.api.navigation.Nodes

anonymous() - Static method in class org.gatein.api.security.User

Creates a anonymous user

ANY - Static variable in class org.gatein.api.security.Membership

any(String...) - Static method in class org.gatein.api.security.Membership

Creates a new membership for any membership type in the specified group

any(String...) - Static method in class org.gatein.api.security.Permission

Returns a permission where users with any membership type in the specified group can access the resource

ApiException - Exception in org.gatein.api

Base api exception

ApiException(String) - Constructor for exception org.gatein.api.ApiException

ApiException(String, Throwable) - Constructor for exception org.gatein.api.ApiException

append(String...) - Method in class org.gatein.api.navigation.NodePath

Adds the specified elements to the end of this path

append(NodePath) - Method in class org.gatein.api.navigation.NodePath

Adds the specified path to the end of this path

asArray() - Method in class org.gatein.api.navigation.NodePath

Returns the path as an array of strings

ascending() - Method in class org.gatein.api.site.SiteQuery.Builder

Sets the order of the sorting object of this builder to Sorting.Order.ascending

asList() - Method in class org.gatein.api.navigation.NodePath

Returns the path as an unmodifiable list of strings.

asList(Node) - Static method in class org.gatein.api.navigation.Nodes

Returns an unmodifiable list with the children of the specified node

Attributes - Class in org.gatein.api.common

Implements Map and adds convinience methods to retrieve a String property converted into a specific type.

Attributes() - Constructor for class org.gatein.api.common.Attributes

Creates a new attributes instance with no attributes

Attributes(Map<String, String>) - Constructor for class org.gatein.api.common.Attributes

Creates a new attributes instance and adds all attributes from the specified map

Attributes.Key<T> - Class in org.gatein.api.common

B

between(Date, Date) - Static method in class org.gatein.api.navigation.PublicationDate

Creates a new publication date that starts on the specified start date and ends on the specified end date

build() - Method in class org.gatein.api.page.PageQuery.Builder

Creates a new PageQuery object represented by the state of this builder

build() - Method in class org.gatein.api.site.SiteQuery.Builder

Creates a new SiteQuery object represented by the state this builder

C

compareTo(NodePath) - Method in class org.gatein.api.navigation.NodePath

createPage(PageId) - Method in interface org.gatein.api.Portal

Creates a page for a site given the PageId.

createSite(SiteId) - Method in interface org.gatein.api.Portal

Creates a a site given the SiteId.

createSite(SiteId, String) - Method in interface org.gatein.api.Portal

Creates a a site given the SiteId.

D

DEFAULT_LIMIT - Static variable in class org.gatein.api.page.PageQuery.Builder

DEFAULT_LIMIT - Static variable in class org.gatein.api.site.SiteQuery.Builder

The default limit used for pagination

DEFAULT_PAGINATION - Static variable in class org.gatein.api.page.PageQuery.Builder

The default pagination used for PageQuery's with a limit set to PageQuery.Builder.DEFAULT_LIMIT

DEFAULT_PAGINATION - Static variable in class org.gatein.api.site.SiteQuery.Builder

The default pagination used for SiteQuery's with a limit set to SiteQuery.Builder.DEFAULT_LIMIT

DEFAULT_SITE_TYPE - Static variable in class org.gatein.api.site.SiteQuery.Builder

Default site type used to build SiteQuery's if one is not defined.

descending() - Method in class org.gatein.api.site.SiteQuery.Builder

Sets the order of the sorting object of this builder to Sorting.Order.descending

Describable - Interface in org.gatein.api.common

Provides a description

Displayable - Interface in org.gatein.api.common

Provides a UI friendly name

E

endingOn(Date) - Static method in class org.gatein.api.navigation.PublicationDate

Creates a new publication date that ends on the specified date

EntityAlreadyExistsException - Exception in org.gatein.api

Exception thrown when entity already exists and cannot be created.

EntityAlreadyExistsException(String) - Constructor for exception org.gatein.api.EntityAlreadyExistsException

EntityAlreadyExistsException(String, Throwable) - Constructor for exception org.gatein.api.EntityAlreadyExistsException

EntityNotFoundException - Exception in org.gatein.api

Exception thrown when entity cannot be found.

EntityNotFoundException(String) - Constructor for exception org.gatein.api.EntityNotFoundException

EntityNotFoundException(String, Throwable) - Constructor for exception org.gatein.api.EntityNotFoundException

equals(Object) - Method in class org.gatein.api.common.Attributes.Key

equals(Object) - Method in class org.gatein.api.common.i18n.Localized

equals(Object) - Method in class org.gatein.api.common.i18n.Localized.Value

equals(Object) - Method in class org.gatein.api.common.Pagination

equals(Object) - Method in class org.gatein.api.navigation.NodePath

equals(Object) - Method in class org.gatein.api.navigation.PublicationDate

equals(Object) - Method in class org.gatein.api.navigation.Visibility

equals(Object) - Method in class org.gatein.api.page.PageId

equals(Object) - Method in class org.gatein.api.site.SiteId

everyone() - Static method in class org.gatein.api.security.Permission

Returns a permission where everyone can access the resource (public)

F

FACEBOOK - Static variable in interface org.gatein.api.oauth.OAuthProvider

Key under which Facebook OAuth provider is registered

Filter<T> - Interface in org.gatein.api.common

A filter to be used to "filter" a collection of elements

filter() - Method in interface org.gatein.api.navigation.Node

Will return a filtered view of this navigation node.

FilteredNode - Interface in org.gatein.api.navigation

A filtered node is obtained from Node.filter() and provides a mechanism for only showing specified nodes.

findPages(PageQuery) - Method in interface org.gatein.api.Portal

Finds pages given the PageQuery

findSites(SiteQuery) - Method in interface org.gatein.api.Portal

Finds sites given the SiteQuery

formatTo(Formatter, int, int, int) - Method in class org.gatein.api.page.PageId

formatTo(Formatter, int, int, int) - Method in class org.gatein.api.site.SiteId

forName(String) - Static method in enum org.gatein.api.site.SiteType

from(PageQuery) - Method in class org.gatein.api.page.PageQuery.Builder

Creates a new builder from an existing PageQuery.

from(SiteQuery) - Method in class org.gatein.api.site.SiteQuery.Builder

Creates a new builder from an existing SiteQuery.

fromString(String) - Static method in class org.gatein.api.navigation.NodePath

Creates a node path with a value represented by the specified path (for example '/home/node1')

fromString(String) - Static method in class org.gatein.api.page.PageId

fromString(String) - Static method in class org.gatein.api.security.Membership

fromString(String) - Static method in class org.gatein.api.site.SiteId

G

get(Attributes.Key<T>) - Method in class org.gatein.api.common.Attributes

Returns the value to the which the specified key name is mapped.

getAccessPermission() - Method in interface org.gatein.api.page.Page

The permissions that represents what users are allowed to access the page

getAccessPermission() - Method in interface org.gatein.api.site.Site

The permissions that represents what users are allowed to access the site

getAccessToken() - Method in interface org.gatein.api.oauth.AccessToken

Return string representation of this access token.

getAttributes() - Method in interface org.gatein.api.site.Site

Returns the attributes (properties) associated with the site

getAuthorizedSocialApiObject(AccessToken, Class<T>) - Method in interface org.gatein.api.oauth.OAuthProvider

Return "accessor" object, which can be used to call some operations on Social network

getAvailableScopes() - Method in interface org.gatein.api.oauth.AccessToken

Return list of all available scopes in single String.

getChild(String) - Method in interface org.gatein.api.navigation.Node

Returns the child node.

getChild(int) - Method in interface org.gatein.api.navigation.Node

Returns the child node of the given index.

getChildCount() - Method in interface org.gatein.api.navigation.Node

Returns the number of child nodes.

getComparator() - Method in class org.gatein.api.common.Sorting

The comparator used to sort.

getDescription() - Method in interface org.gatein.api.common.Describable

Returns the description

getDisplayName() - Method in interface org.gatein.api.common.Displayable

Returns the display name

getDisplayName() - Method in class org.gatein.api.page.PageQuery

getDisplayNames() - Method in interface org.gatein.api.common.LocalizedDisplayable

Returns a localized string that can represent a single non localized name or many values each mapping to a specific Locale

getEditPermission() - Method in interface org.gatein.api.page.Page

The permissions that represents what users are allowed to modify the page

getEditPermission() - Method in interface org.gatein.api.site.Site

The permissions that represents what users are allowed to modify the site

getEnd() - Method in class org.gatein.api.navigation.PublicationDate

Returns the end date or null if no end date is set

getExceptionCode() - Method in exception org.gatein.api.oauth.exception.OAuthApiException

Return exception code, which specifies which OAuth error actually happened

getFilter() - Method in class org.gatein.api.page.PageQuery

getFilter() - Method in class org.gatein.api.site.SiteQuery

getFriendlyName() - Method in interface org.gatein.api.oauth.OAuthProvider

Return friendly name of this OAuth provider.

getGroup() - Method in class org.gatein.api.security.Membership

Returns the group

getIconName() - Method in interface org.gatein.api.navigation.Node

Name of the icon for this navigation node.

getIconName() - Method in interface org.gatein.api.navigation.NodeVisitor.NodeDetails

The icon name of the node being visited.

getId() - Method in interface org.gatein.api.page.Page

The id of the page

getId() - Method in class org.gatein.api.security.Group

Returns the id of the group.

getId() - Method in class org.gatein.api.security.User

Returns the user id

getId() - Method in interface org.gatein.api.site.Site

Returns the id of the site

getInstance() - Static method in class org.gatein.api.PortalRequest

Obtain the current instance of a PortalRequest

getKey() - Method in interface org.gatein.api.oauth.OAuthProvider

Return key of this OAuth provider.

getLastSegment() - Method in class org.gatein.api.navigation.NodePath

Returns the last part of the path

getLimit() - Method in class org.gatein.api.common.Pagination

The limit for this pagination object.

getLocale() - Method in class org.gatein.api.common.i18n.Localized.Value

Returns the locale associated with this value.

getLocale() - Method in class org.gatein.api.PortalRequest

The Locale of the request.

getLocale() - Method in interface org.gatein.api.site.Site

Returns the default locale associated with the site

getLocalizedValue(Locale) - Method in class org.gatein.api.common.i18n.Localized

Gets the value mapped to the specific locale.

getLocalizedValues() - Method in class org.gatein.api.common.i18n.Localized

Returns a collection of values representing the mapping of Locale to type T

getMemberships() - Method in class org.gatein.api.security.Permission

Returns all memberships with permissions to access the resource

getMembershipType() - Method in class org.gatein.api.security.Membership

Returns the membership type

getMessage() - Method in exception org.gatein.api.oauth.exception.OAuthApiException

getName() - Method in class org.gatein.api.common.Attributes.Key

getName() - Method in interface org.gatein.api.navigation.Node

The name of the node.

getName() - Method in interface org.gatein.api.page.Page

The name of the page

getName() - Method in interface org.gatein.api.site.Site

Returns the name of the site

getName() - Method in class org.gatein.api.site.SiteId

The name of the site.

getName() - Method in enum org.gatein.api.site.SiteType

getNavigation(SiteId) - Method in interface org.gatein.api.Portal

Returns the navigation of a site given the SiteId.

getNavigation() - Method in class org.gatein.api.PortalRequest

The navigation of the current portal request.

getNext() - Method in class org.gatein.api.common.Pagination

Creates a new pagination object representing the next page

getNode(String...) - Method in interface org.gatein.api.navigation.Navigation

Returns a node represented by the node path or null if the node was not found.

getNode(NodePath) - Method in interface org.gatein.api.navigation.Navigation

Returns a node represented by the node path or null if the node was not found.

getNode(NodePath, NodeVisitor) - Method in interface org.gatein.api.navigation.Navigation

Returns a node represented by the node path or null if the node was not found.

getNode(String...) - Method in interface org.gatein.api.navigation.Node

Returns the node specified by the node path, relative to this node.

getNode(NodePath) - Method in interface org.gatein.api.navigation.Node

Returns the node specified by the node path, relative to this node.

getNodePath() - Method in interface org.gatein.api.navigation.Node

The path of the node.

getNodePath() - Method in interface org.gatein.api.navigation.NodeVisitor.NodeDetails

The NodePath of the node being visited.

getNodePath() - Method in class org.gatein.api.PortalRequest

The NodePath of the request.

getOAuthProvider(String) - Method in interface org.gatein.api.Portal

Return OAuthProvider for given key.

getOffset() - Method in class org.gatein.api.common.Pagination

The offset for this pagination object.

getOrder() - Method in class org.gatein.api.common.Sorting

The order to sort, i.e.

getPage(PageId) - Method in interface org.gatein.api.Portal

Returns the page of a site given the PageId.

getPage() - Method in class org.gatein.api.PortalRequest

The page currently being accessed by the current portal request.

getPageId() - Method in interface org.gatein.api.navigation.Node

The PageId of the page this node points to.

getPageId() - Method in interface org.gatein.api.navigation.NodeVisitor.NodeDetails

The PageId of the node being visited.

getPageName() - Method in class org.gatein.api.page.PageId

Returns the name of the page

getPageNumber() - Method in class org.gatein.api.common.Pagination

The current page number this pagination object represents

getPagination() - Method in class org.gatein.api.page.PageQuery

getPagination() - Method in class org.gatein.api.site.SiteQuery

getParent() - Method in interface org.gatein.api.navigation.Node

Returns the parent of the node, or null if the node is the root node.

getPortal() - Method in class org.gatein.api.PortalRequest

Access to the portal interface

getPrevious() - Method in class org.gatein.api.common.Pagination

Creates a new pagination object representing the previous page

getPriority() - Method in interface org.gatein.api.navigation.Navigation

The priority of the navigation.

getPublicationDate() - Method in class org.gatein.api.navigation.Visibility

Returns the publication date or null if the status is not Visibility.Status.PUBLICATION

getRootNode(NodeVisitor) - Method in interface org.gatein.api.navigation.Navigation

Returns the root node of the navigation with nodes loaded dependent on the NodeVisitor

getSegment(int) - Method in class org.gatein.api.navigation.NodePath

Returns the part of the path at the specified index

getSite(SiteId) - Method in interface org.gatein.api.Portal

Returns a site given the SiteId.

getSite() - Method in class org.gatein.api.PortalRequest

The site represented by the SiteId of the request.

getSiteId() - Method in interface org.gatein.api.navigation.Navigation

The SiteId of the navigation

getSiteId() - Method in interface org.gatein.api.page.Page

The id of the site the page belongs to

getSiteId() - Method in class org.gatein.api.page.PageId

Returns the id of the site

getSiteId() - Method in class org.gatein.api.PortalRequest

The SiteId of the request.

getSiteName() - Method in class org.gatein.api.page.PageQuery

getSiteType() - Method in class org.gatein.api.page.PageQuery

getSiteTypes() - Method in class org.gatein.api.site.SiteQuery

The site types used for this query.

getSkin() - Method in interface org.gatein.api.site.Site

Returns the skin associated with the site

getSorting() - Method in class org.gatein.api.site.SiteQuery

getStart() - Method in class org.gatein.api.navigation.PublicationDate

Returns the start date or null if no start date is set

getStatus() - Method in class org.gatein.api.navigation.Visibility

Returns the status

getType() - Method in class org.gatein.api.common.Attributes.Key

getType() - Method in interface org.gatein.api.site.Site

Returns the type of the site.

getType() - Method in class org.gatein.api.site.SiteId

The SiteType for this SiteId

getURI() - Method in interface org.gatein.api.navigation.Node

Resolves the URI given the current context.

getURIResolver() - Method in class org.gatein.api.PortalRequest

The resolver used to resolve the URI for Nodes.

getUser() - Method in class org.gatein.api.PortalRequest

The user of the request.

getValue(Locale) - Method in class org.gatein.api.common.i18n.Localized

Gets the T value mapped to the specific locale.

getValue() - Method in class org.gatein.api.common.i18n.Localized.Value

Returns the value object of type T.

getValue() - Method in class org.gatein.api.common.i18n.LocalizedString

This method returns the value for a non localized string.

getVisibility() - Method in interface org.gatein.api.navigation.Node

Returns the visibility object of this navigation node.

getVisibility() - Method in interface org.gatein.api.navigation.NodeVisitor.NodeDetails

The Visibility of the node being visited.

GOOGLE - Static variable in interface org.gatein.api.oauth.OAuthProvider

Key under which Google+ OAuth provider is registered

Group - Class in org.gatein.api.security

Represents a group.

Group(String...) - Constructor for class org.gatein.api.security.Group

Creates an new group instance with the specified hierarchy.

Group(String) - Constructor for class org.gatein.api.security.Group

Creates an new group instance with the specified id.

H

hasChild(String) - Method in interface org.gatein.api.navigation.Node

If this node has a child of the specified childName

hashCode() - Method in class org.gatein.api.common.Attributes.Key

hashCode() - Method in class org.gatein.api.common.i18n.Localized

hashCode() - Method in class org.gatein.api.common.i18n.Localized.Value

hashCode() - Method in class org.gatein.api.common.Pagination

hashCode() - Method in class org.gatein.api.navigation.NodePath

hashCode() - Method in class org.gatein.api.navigation.PublicationDate

hashCode() - Method in class org.gatein.api.navigation.Visibility

hashCode() - Method in class org.gatein.api.page.PageId

hashCode() - Method in class org.gatein.api.site.SiteId

hasPermission(User, Permission) - Method in interface org.gatein.api.Portal

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

I

includeEmptySites(boolean) - Method in class org.gatein.api.site.SiteQuery.Builder

indexOf(String) - Method in interface org.gatein.api.navigation.Node

The index of the child with the specified name.

isAccessibleToEveryone() - Method in class org.gatein.api.security.Permission

Returns true if everyone has permissions to access the item

isAnonymous() - Method in class org.gatein.api.security.User

Returns true if the user is anonymous

isChildrenLoaded() - Method in interface org.gatein.api.navigation.Node

If this node's children has been loaded.

isIncludeEmptySites() - Method in class org.gatein.api.site.SiteQuery

The flag indicates if the query should include/exclude sites that are empty.

isLocalized() - Method in class org.gatein.api.common.i18n.LocalizedString

Indicates if the string is localized or not.

isParent(NodePath) - Method in class org.gatein.api.navigation.NodePath

Returns true if this path is an ancestor of the specified path

isRoot() - Method in interface org.gatein.api.navigation.Node

If this node is the root node of the navigation.

isScopeAvailable(String) - Method in interface org.gatein.api.oauth.AccessToken

Return true if given scope is available in list of OAuth scopes of this access token

isVisible() - Method in interface org.gatein.api.navigation.Node

If the node is visible.

isVisible() - Method in class org.gatein.api.navigation.Visibility

Returns true if the status is Visibility.Status.VISIBLE or if the status is Visibility.Status.PUBLICATION and the publicationDate is within the current time.

iterator() - Method in class org.gatein.api.common.i18n.Localized

iterator() - Method in class org.gatein.api.navigation.NodePath

K

key(String, Class<T>) - Static method in class org.gatein.api.common.Attributes

Creates a key with the specified name and type.

L

loadAccessToken(String) - Method in interface org.gatein.api.oauth.OAuthProvider

Return access token for given user from portal identity storage (DB or LDAP).

Localized<T extends Serializable> - Class in org.gatein.api.common.i18n

Base class for localizing values of type T.

Localized(Localized<T>) - Constructor for class org.gatein.api.common.i18n.Localized

Localized(Locale, T) - Constructor for class org.gatein.api.common.i18n.Localized

Localized(Map<Locale, T>) - Constructor for class org.gatein.api.common.i18n.Localized

Localized.Value<T extends Serializable> - Class in org.gatein.api.common.i18n

Value object representing the mapping of a Locale to a value of type T.

LocalizedDisplayable - Interface in org.gatein.api.common

Provides a UI friendly that supports localization

LocalizedString - Class in org.gatein.api.common.i18n

A LocalizedString can represent a single value (non localized) or many values each mapping to a specific Locale

LocalizedString(LocalizedString) - Constructor for class org.gatein.api.common.i18n.LocalizedString

LocalizedString(String) - Constructor for class org.gatein.api.common.i18n.LocalizedString

Constructor to create a non localized string.

LocalizedString(Locale, String) - Constructor for class org.gatein.api.common.i18n.LocalizedString

Constructor to create a localized string.

LocalizedString(Map<Locale, String>) - Constructor for class org.gatein.api.common.i18n.LocalizedString

Constructor to create a localized string with multiple values.

M

Membership - Class in org.gatein.api.security

Represents a membership in a group

Membership(String, Group) - Constructor for class org.gatein.api.security.Membership

Creates a new membership for users with the specified membership type in the specified group

Membership(User) - Constructor for class org.gatein.api.security.Membership

Creates a new membership for the specified user

moveTo(int) - Method in interface org.gatein.api.navigation.Node

Moves the node to the specified index.

moveTo(Node) - Method in interface org.gatein.api.navigation.Node

Moves this node to another parent.

moveTo(int, Node) - Method in interface org.gatein.api.navigation.Node

Moves this node to another parent inserting it at the specified index.

N

Navigation - Interface in org.gatein.api.navigation

Navigation for a site responsible for the retrieval, saving, and removal of navigation nodes.

nextPage() - Method in class org.gatein.api.page.PageQuery

Convenience method for creating a new PageQuery with pagination set to the next page represented by by Pagination.getNext()

nextPage() - Method in class org.gatein.api.site.SiteQuery

Convenience method for creating a new SiteQuery with pagination set to the next page represented by by Pagination.getNext()

Node - Interface in org.gatein.api.navigation

A node object which represents the current state of a node retrieved from the portal.

NodePath - Class in org.gatein.api.navigation

Nodes - Class in org.gatein.api.navigation

NodeVisitor - Interface in org.gatein.api.navigation

A node visitor is used to walk the node tree.

NodeVisitor.NodeDetails - Interface in org.gatein.api.navigation

O

OAuthApiException - Exception in org.gatein.api.oauth.exception

ApiException when calling some OAuth operation

OAuthApiException(OAuthApiExceptionCode, String) - Constructor for exception org.gatein.api.oauth.exception.OAuthApiException

OAuthApiException(OAuthApiExceptionCode, String, Throwable) - Constructor for exception org.gatein.api.oauth.exception.OAuthApiException

OAuthApiExceptionCode - Enum in org.gatein.api.oauth.exception

Exception code of OAuth error

OAuthProvider - Interface in org.gatein.api.oauth

Object, which represents single OAuth provider (Social network).

org.gatein.api - package org.gatein.api

The Portal Public API classes

org.gatein.api.cdi.context - package org.gatein.api.cdi.context

org.gatein.api.common - package org.gatein.api.common

org.gatein.api.common.i18n - package org.gatein.api.common.i18n

org.gatein.api.navigation - package org.gatein.api.navigation

org.gatein.api.oauth - package org.gatein.api.oauth

org.gatein.api.oauth.exception - package org.gatein.api.oauth.exception

org.gatein.api.page - package org.gatein.api.page

org.gatein.api.security - package org.gatein.api.security

org.gatein.api.site - package org.gatein.api.site

P

Page - Interface in org.gatein.api.page

Represents a portal page.

page(String) - Method in class org.gatein.api.site.SiteId

Creates a new PageId from this SiteId

PageId - Class in org.gatein.api.page

The id of a page

PageId(String, String) - Constructor for class org.gatein.api.page.PageId

Creates a new page id with the specified site name and page name

PageId(Group, String) - Constructor for class org.gatein.api.page.PageId

Creates new page id for a page with the specified group (space) and page name

PageId(User, String) - Constructor for class org.gatein.api.page.PageId

Creates a new page id for a page with the specified user (dashboard) and page name

PageId(SiteId, String) - Constructor for class org.gatein.api.page.PageId

Creates a new page id for a page with the specified site id and page name

PageQuery - Class in org.gatein.api.page

An immutable PageQuery object that can be used to query pages.

PageQuery.Builder - Class in org.gatein.api.page

The builder responsible for creating PageQuery objects.

PageQuery.Builder() - Constructor for class org.gatein.api.page.PageQuery.Builder

Pagination - Class in org.gatein.api.common

A pagination object to be used to describe pagination (offset, limit) which can be used in queries.

Pagination(int, int) - Constructor for class org.gatein.api.common.Pagination

parent() - Method in class org.gatein.api.navigation.NodePath

Returns the path to the parent

path(String...) - Static method in class org.gatein.api.navigation.NodePath

Creates a node path with the value of the specified elements

Permission - Class in org.gatein.api.security

Represents the permissions for a resource

Permission() - Constructor for class org.gatein.api.security.Permission

Creates a permission where everyone can access the resource (public)

Permission(String, Group) - Constructor for class org.gatein.api.security.Permission

Creates a permission where users with the specified member type in the specified group can access the resource

Permission(User) - Constructor for class org.gatein.api.security.Permission

Creates a permission where the the specified user can access the resource

Permission(Membership) - Constructor for class org.gatein.api.security.Permission

Creates a permission where users with the specified membership can access the resource

Permission(Set<Membership>) - Constructor for class org.gatein.api.security.Permission

Creates a permission where users with one or more of the specified memberships can access the resource

Portal - Interface in org.gatein.api

The main interface of the portal public API.

PortalRequest - Class in org.gatein.api

The PortalRequest object represents the current request of the portal.

PortalRequest() - Constructor for class org.gatein.api.PortalRequest

PortletLifecycleScoped - Annotation Type in org.gatein.api.cdi.context

Specifies that a bean is portlet lifecycle scoped.

PortletRedisplayScoped - Annotation Type in org.gatein.api.cdi.context

Specifies that a bean is portlet redisplay scoped.

previousPage() - Method in class org.gatein.api.page.PageQuery

Convenience method for creating a new PageQuery with pagination set to the previous page represented by by Pagination.getPrevious()

previousPage() - Method in class org.gatein.api.site.SiteQuery

Convenience method for creating a new SiteQuery with pagination set to the previous page represented by by Pagination.getPrevious()

PublicationDate - Class in org.gatein.api.navigation

Represents the dates a Node with the Visibility.getStatus() set to Visibility.Status.PUBLICATION is visible.

put(Attributes.Key<T>, T) - Method in class org.gatein.api.common.Attributes

Converts the value into a String using the toString method

R

refreshNode(Node) - Method in interface org.gatein.api.navigation.Navigation

Will refresh the node with latest from storage.

refreshNode(Node, NodeVisitor) - Method in interface org.gatein.api.navigation.Navigation

Will refresh the node with latest from storage.

remove(Attributes.Key<T>) - Method in class org.gatein.api.common.Attributes

Removes the attribute that is mapped to the specified key name

removeAccessToken(String) - Method in interface org.gatein.api.oauth.OAuthProvider

Remove access token of given user from portal identity storage (DB or LDAP)

removeChild(String) - Method in interface org.gatein.api.navigation.Node

Removes the child from this navigation node.

removeLocalizedValue(Locale) - Method in class org.gatein.api.common.i18n.Localized

Will remove the value mapped to the locale.

removeNode(NodePath) - Method in interface org.gatein.api.navigation.Navigation

Removes a node, represented by the node path

removePage(PageId) - Method in interface org.gatein.api.Portal

Removes a page

removeSite(SiteId) - Method in interface org.gatein.api.Portal

Removes a site

resolveURI(SiteId) - Method in interface org.gatein.api.common.URIResolver

Resolves the URI for the specified site

revokeToken(AccessToken) - Method in interface org.gatein.api.oauth.OAuthProvider

Revoke current access token on OAuth provider side, so access token won't be valid anymore and portal application can't be seen in list of available applications of OAuth provider (For example: https://www.facebook.com/settings?tab=applications in case of Facebook)

root() - Static method in class org.gatein.api.navigation.NodePath

Returns the path to the root node

S

saveAccessToken(String, AccessToken) - Method in interface org.gatein.api.oauth.OAuthProvider

Save access token for given user to portal identity storage (DB or LDAP)

saveNode(Node) - Method in interface org.gatein.api.navigation.Navigation

Saves a node.

savePage(Page) - Method in interface org.gatein.api.Portal

Saves a page

saveSite(Site) - Method in interface org.gatein.api.Portal

Saves a site

SESSION_BEHAVIOR - Static variable in class org.gatein.api.site.Site.AttributeKeys

The site attribute that sets if a session is kept alive or not.

setAccessPermission(Permission) - Method in interface org.gatein.api.page.Page

Sets the access permission

setAccessPermission(Permission) - Method in interface org.gatein.api.site.Site

Changes the access permission for the site

setDescription(String) - Method in interface org.gatein.api.common.Describable

Set the description to the specified value

setDisplayName(String) - Method in interface org.gatein.api.common.Displayable

Sets the display name

setDisplayNames(LocalizedString) - Method in interface org.gatein.api.common.LocalizedDisplayable

Sets the display name

setEditPermission(Permission) - Method in interface org.gatein.api.page.Page

Sets the edit permission

setEditPermission(Permission) - Method in interface org.gatein.api.site.Site

Changes the edit permission for the site

setIconName(String) - Method in interface org.gatein.api.navigation.Node

Sets the name of the icon name for this navigation node.

setInstance(PortalRequest) - Static method in class org.gatein.api.PortalRequest

setLocale(Locale) - Method in interface org.gatein.api.site.Site

Changes the default locale associated with the site

setLocalizedValue(Locale, T) - Method in class org.gatein.api.common.i18n.Localized

Sets the value for the specified locale.

setLocalizedValue(Locale, String) - Method in class org.gatein.api.common.i18n.LocalizedString

This method will first remove the non localized value if one exists then sets the value for the specified locale.

setName(String) - Method in interface org.gatein.api.navigation.Node

Sets the name of the node.

setPageId(PageId) - Method in interface org.gatein.api.navigation.Node

Sets the PageId of the page this node should point to.

setPriority(int) - Method in interface org.gatein.api.navigation.Navigation

Saves the priority for this navigation.

setSkin(String) - Method in interface org.gatein.api.site.Site

Changes the skin associated with the site

setValue(String) - Method in class org.gatein.api.common.i18n.LocalizedString

This will clear any localized values, and convert the string to a non localized string.

setVisibility(Visibility) - Method in interface org.gatein.api.navigation.Node

Sets the visibility for this navigation node.

setVisibility(boolean) - Method in interface org.gatein.api.navigation.Node

Sets the visibility of this navigation node either Visibility.Status.VISIBLE or Visibility.Status.HIDDEN.

setVisibility(PublicationDate) - Method in interface org.gatein.api.navigation.Node

Sets the visibility of this navigation node to be Visibility.Status.PUBLICATION, in which the dates of the PublicationDate are used to calculate the visibility.

show(Filter<Node>) - Method in interface org.gatein.api.navigation.FilteredNode

Adds a the specified filter to this node

SHOW_PORTLET_INFO_BAR - Static variable in class org.gatein.api.site.Site.AttributeKeys

The site attribute that sets if the info bar is shown by default when adding applications to pages, default 'false'

showAll() - Method in interface org.gatein.api.navigation.FilteredNode

Shows all nodes

showDefault() - Method in interface org.gatein.api.navigation.FilteredNode

Adds a filter to this node that accepts default nodes (equivalent to showVisible().showHasAccess(PortalRequest.getInstance().getUser())).

showHasAccess(User) - Method in interface org.gatein.api.navigation.FilteredNode

Adds a filter to this node that accepts nodes the specified user has permissions to access

showHasEdit(User) - Method in interface org.gatein.api.navigation.FilteredNode

Adds a filter to this node that accepts nodes the specified user has permissions to edit

showVisible() - Method in interface org.gatein.api.navigation.FilteredNode

Adds a filter to this node that accepts visible nodes

Site - Interface in org.gatein.api.site

Represents a portal site.

Site.AttributeKeys - Class in org.gatein.api.site

Contains attribute keys for default site attributes

SiteId - Class in org.gatein.api.site

The id of site

SiteId(String) - Constructor for class org.gatein.api.site.SiteId

Creates a new site id for a site with the specific name

SiteId(Group) - Constructor for class org.gatein.api.site.SiteId

Creates a new site id for a group space (site associated with a group)

SiteId(User) - Constructor for class org.gatein.api.site.SiteId

Creates a new site id for a users dashboard (site associated with a user)

SiteId(SiteType, String) - Constructor for class org.gatein.api.site.SiteId

Creates a new site id for a site with the specified type and name

SiteQuery - Class in org.gatein.api.site

An immutable SiteQuery object that can be used to query sites.

SiteQuery.Builder - Class in org.gatein.api.site

The builder class responsible for building SiteQuery objects.

SiteQuery.Builder() - Constructor for class org.gatein.api.site.SiteQuery.Builder

SiteType - Enum in org.gatein.api.site

The type of a site.

size() - Method in class org.gatein.api.navigation.NodePath

Returns the size of the path

sort(Comparator<Node>) - Method in interface org.gatein.api.navigation.Node

Will sort the children of this node per the comparator.

Sorting<T> - Class in org.gatein.api.common

A sorting object defining order (ASC, DESC) or a custom comparator, but not both.

Sorting(Sorting.Order) - Constructor for class org.gatein.api.common.Sorting

A sorting object with an order, i.e.

Sorting(Comparator<T>) - Constructor for class org.gatein.api.common.Sorting

A sorting object which will use a Comparator to sort.

Sorting.Order - Enum in org.gatein.api.common

startingOn(Date) - Static method in class org.gatein.api.navigation.PublicationDate

Creates a new publication date that starts on the specified date

startOAuthWorkflow(String) - Method in interface org.gatein.api.oauth.OAuthProvider

Start OAuth or OAuth2 workflow, which means redirection to OAuth provider (Social network) login screen and authorization screen and obtaining of access token for current portal user.

subPath(int) - Method in class org.gatein.api.navigation.NodePath

Returns the sub-path starting at fromIndex

subPath(int, int) - Method in class org.gatein.api.navigation.NodePath

Returns the sub-path starting at fromIndex and ending at toIndex

T

toString() - Method in class org.gatein.api.common.Attributes.Key

toString() - Method in class org.gatein.api.common.i18n.Localized

toString() - Method in class org.gatein.api.common.i18n.Localized.Value

toString() - Method in class org.gatein.api.common.Pagination

toString() - Method in class org.gatein.api.common.Sorting

toString() - Method in class org.gatein.api.navigation.NodePath

toString() - Method in class org.gatein.api.navigation.PublicationDate

toString() - Method in class org.gatein.api.navigation.Visibility

toString() - Method in class org.gatein.api.page.PageId

toString() - Method in class org.gatein.api.page.PageQuery

toString() - Method in class org.gatein.api.security.Group

toString() - Method in class org.gatein.api.security.Membership

toString() - Method in class org.gatein.api.security.Permission

toString() - Method in class org.gatein.api.site.SiteId

TWITTER - Static variable in interface org.gatein.api.oauth.OAuthProvider

Key under which Twitter OAuth provider is registered

U

URIResolver - Interface in org.gatein.api.common

A resolver that can resolve the URI for resources

User - Class in org.gatein.api.security

Represents a user

User(String) - Constructor for class org.gatein.api.security.User

Creates a new user with the specified id.

V

validateTokenAndUpdateScopes(AccessToken) - Method in interface org.gatein.api.oauth.OAuthProvider

Check if given access token is valid and possibly update some info (like scopes or access token itself if it was refreshed) In case that access token has been refreshed (updated) you may call OAuthProvider.saveAccessToken(String, AccessToken) to update it in DB (it's not done by Portal itself during call of this method)

valueOf(String) - Static method in enum org.gatein.api.common.Sorting.Order

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.gatein.api.navigation.Visibility.Status

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.gatein.api.oauth.exception.OAuthApiExceptionCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.gatein.api.site.SiteType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.gatein.api.common.Sorting.Order

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.gatein.api.navigation.Visibility.Status

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.gatein.api.oauth.exception.OAuthApiExceptionCode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.gatein.api.site.SiteType

Returns an array containing the constants of this enum type, in the order they are declared.

Visibility - Class in org.gatein.api.navigation

Represents the visiblity of a Node

Visibility() - Constructor for class org.gatein.api.navigation.Visibility

Creates a new instance with the status set to Visibility.Status.VISIBLE

Visibility(Visibility.Status) - Constructor for class org.gatein.api.navigation.Visibility

Creates a new instance with the specified status

Visibility(PublicationDate) - Constructor for class org.gatein.api.navigation.Visibility

Creates a new instance with the status set to Visibility.Status.PUBLICATION which is visible at the time specified by the publication date

Visibility.Status - Enum in org.gatein.api.navigation

visit(int, String, NodeVisitor.NodeDetails) - Method in interface org.gatein.api.navigation.NodeVisitor

Determines if more nodes should be visited.

visitAll() - Static method in class org.gatein.api.navigation.Nodes

A visitor that will visit all nodes.

visitChildren() - Static method in class org.gatein.api.navigation.Nodes

A visitor that will visit only children nodes.

visitNodes(int) - Static method in class org.gatein.api.navigation.Nodes

Creates a NodeVisitor which will visit nodes up to the specified depth.

visitNodes(NodePath) - Static method in class org.gatein.api.navigation.Nodes

Creates a NodeVisitor which will visit nodes matching the path.

visitNodes(NodePath, NodeVisitor) - Static method in class org.gatein.api.navigation.Nodes

Creates a NodeVisitor which will visit nodes matching the path.

visitNone() - Static method in class org.gatein.api.navigation.Nodes

A visitor that will not visit any nodes.

W

withAllSiteTypes() - Method in class org.gatein.api.site.SiteQuery.Builder

Sets the site type's of this builder to include all SiteType's

withDisplayName(String) - Method in class org.gatein.api.page.PageQuery.Builder

Sets the display name for this builder to be used to query all sites that have the displayName.

withFilter(Filter<Page>) - Method in class org.gatein.api.page.PageQuery.Builder

Sets the filter for this builder

withFilter(Filter<Site>) - Method in class org.gatein.api.site.SiteQuery.Builder

Sets the filter for this builder

within(Date) - Method in class org.gatein.api.navigation.PublicationDate

Returns true if the publication date is within the specified date

within(long) - Method in class org.gatein.api.navigation.PublicationDate

Returns true if the publication date is within the specified date

withNextPage() - Method in class org.gatein.api.page.PageQuery.Builder

Sets the pagination of this builder to pagination.getNext() if it's not null.

withNextPage() - Method in class org.gatein.api.site.SiteQuery.Builder

Sets the pagination of this builder to pagination.getNext() if it's not null.

withPagination(int, int) - Method in class org.gatein.api.page.PageQuery.Builder

Sets the pagination object of this builder to use the specified offset and limit.

withPagination(Pagination) - Method in class org.gatein.api.page.PageQuery.Builder

Sets the pagination object of this builder

withPagination(int, int) - Method in class org.gatein.api.site.SiteQuery.Builder

Sets the pagination object of this builder to use the specified offset and limit.

withPagination(Pagination) - Method in class org.gatein.api.site.SiteQuery.Builder

Sets the pagination object of this builder

withPreviousPage() - Method in class org.gatein.api.page.PageQuery.Builder

Sets the pagination of this builder to pagination.getPrevious() if it's not null.

withPreviousPage() - Method in class org.gatein.api.site.SiteQuery.Builder

Sets the pagination of this builder to pagination.getPrevious() if it's not null.

withSiteId(SiteId) - Method in class org.gatein.api.page.PageQuery.Builder

Convenience method for setting both the site type and site name.

withSiteName(String) - Method in class org.gatein.api.page.PageQuery.Builder

Sets the siteName for this builder to be used to query all sites that have the name.

withSiteType(SiteType) - Method in class org.gatein.api.page.PageQuery.Builder

Sets the siteType for this builder to be used to query all sites that have the SiteType.

withSiteTypes(SiteType, SiteType...) - Method in class org.gatein.api.site.SiteQuery.Builder

Sets the site types of this builder

withSiteTypes(EnumSet<SiteType>) - Method in class org.gatein.api.site.SiteQuery.Builder

Sets the site types of this builder.

withSorting(Sorting<Site>) - Method in class org.gatein.api.site.SiteQuery.Builder

Sets the sorting object for this builder

A B C D E F G H I K L M N O P R S T U V W