org.gatein.api:gatein-api

Parent POM for GateIn components project.

License	GNU Lesser General Public License (LGPL)
GroupId	org.gatein.api
ArtifactId	gatein-api
Last Version	1.1.0.Final
Release Date	Mar 28, 2014
Type	jar
Description	Parent POM for GateIn components project.
Project Organization	JBoss by Red Hat
Source Code Management	https://github.com/gatein/gatein-api-java.git

Download gatein-api

Filename	Size
gatein-api-1.1.0.Final.pom
gatein-api-1.1.0.Final.jar	55 KB
gatein-api-1.1.0.Final-sources.jar	57 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.gatein.api/gatein-api/ -->
<dependency>
    <groupId>org.gatein.api</groupId>
    <artifactId>gatein-api</artifactId>
    <version>1.1.0.Final</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.gatein.api/gatein-api/
implementation 'org.gatein.api:gatein-api:1.1.0.Final'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.gatein.api/gatein-api/
implementation ("org.gatein.api:gatein-api:1.1.0.Final")

Apache Buildr

'org.gatein.api:gatein-api:jar:1.1.0.Final'

Apache Ivy

<dependency org="org.gatein.api" name="gatein-api" rev="1.1.0.Final">
  <artifact name="gatein-api" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.gatein.api', module='gatein-api', version='1.1.0.Final')
)

Scala SBT

libraryDependencies += "org.gatein.api" % "gatein-api" % "1.1.0.Final"

Leiningen

[org.gatein.api/gatein-api "1.1.0.Final"]

Dependencies

provided (1)

Group / Artifact	Type	Version
javax.enterprise : cdi-api	jar	1.0-SP4

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.8.2

Project Modules

There are no modules declared in this project.

GateIn API

The GateIn Public API is to be used within GateIn Portal to provide a standard and consistent way to obtain and modify portal entities.

Getting Started

To build with maven

mvn clean install

and include as a dependency in your pom.xml

<groupId>org.gatein.api</groupId>
<artifactId>gatein-api</artifactId>
<version>1.0.0.Alpha01</version>

Usage

To obtain the PortalRequest object from within GateIn simply do the following:

PortalRequest request = PortalRequest.getInstance();

The PortalRequest object contains information about the current request, for example to retrieve the current navigation node of the request:

Navigation navigation = request.getNavigation();
Node node = navigaiton.getNode(request.getNodePath());

The Portal interface allows you to do more advanced things create sites, create pages, or check permisisons. For example to check to see if the current user has access to a certain page:

Portal portal = request.getPortal();
User user = request.getUser();
Page homepage = portal.getPage(new PageId("homepage"));
boolean access = portal.hasPermission(user, homepage.getAccessPermission());

GateIn

Versions

Version
1.1.0.Final Mar 28, 2014
1.0.1.Final Jul 30, 2013
1.0.0.Final Jun 17, 2013
1.0.0.CR3 May 8, 2013
1.0.0.CR2 May 7, 2013
1.0.0.CR1 Apr 22, 2013
1.0.0.Alpha01 Feb 7, 2013