-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
cdi-decorator and cdi-interceptors quickstarts added #472
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
cdi-decorator: Demostrates CDI Decorator | ||
====================================================== | ||
Author: Ievgen Shulga | ||
Level: Intermediate | ||
Technologies: CDI | ||
Summary: Demonstrates the use of CDI Decorator where the bean is can be decorated. | ||
Target Product: EAP | ||
Source: <https://github.com/jboss-jdf/jboss-as-quickstart/> | ||
|
||
What is it? | ||
----------- | ||
This example demonstrates the use of CDI Decorator. | ||
It represents a common decorator design pattern. We take a class and we wrap decorator class around it. | ||
When we call the class, we always pass through the surrounding decorator class before we reach the inner class. | ||
In this example, the decorator class simply changes bonus(from 100 to 200) and position(from Java Developer to Team Lead) of 'Staff' and logs a message to the server console. | ||
By default, all decorators are disabled, so application will run without using decorator. We need to enable our decorator in the 'beans.xml' descriptor to make it work. | ||
|
||
|
||
System requirements | ||
------------------- | ||
|
||
All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better. | ||
|
||
The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7. | ||
|
||
|
||
Configure Maven | ||
--------------- | ||
|
||
If you have not yet done so, you must [Configure Maven](../README.md#mavenconfiguration) before testing the quickstarts. | ||
|
||
|
||
Start JBoss Enterprise Application Platform 6 or JBoss AS 7 | ||
------------------------- | ||
|
||
1. Open a command line and navigate to the root of the JBoss server directory. | ||
2. The following shows the command line to start the server with the web profile: | ||
|
||
For Linux: JBOSS_HOME/bin/standalone.sh | ||
For Windows: JBOSS_HOME\bin\standalone.bat | ||
|
||
|
||
Build and Deploy the Quickstart | ||
------------------------- | ||
|
||
_NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See [Build and Deploy the Quickstarts](../README.md#buildanddeploy) for complete instructions and additional options._ | ||
|
||
1. Make sure you have started the JBoss Server as described above. | ||
2. Open a command line and navigate to the root directory of this quickstart. | ||
3. Type this command to build and deploy the archive: | ||
|
||
mvn clean package jboss-as:deploy | ||
|
||
4. This will deploy `target/cdi-decorator.war` to the running instance of the server. | ||
|
||
|
||
Access the application | ||
--------------------- | ||
|
||
The application will be running at the following URL <http://localhost:8080/jboss-as-cdi-decorator>. | ||
|
||
You can specify decorator of the bean in the WEB-INF/beans.xml file by doing one of the following: | ||
|
||
1. You can add a decorators tag and specify a decorator class. | ||
2. You can specify a different decorator class name in the decorators tag. | ||
|
||
For this example, uncomment the <decorators> tag in the WEB-INF/beans.xml file and redeploy the application. | ||
When you access the application, you will see changed information from web-browser and following in the server log: `CDI decorator method was called!` | ||
|
||
In order to switch back to the default implementation, | ||
comment the 'decorators' block in the WEB-INF/beans.xml file and redeploy the quickstart. | ||
|
||
Undeploy the Archive | ||
-------------------- | ||
|
||
1. Make sure you have started the JBoss Server as described above. | ||
2. Open a command line and navigate to the root directory of this quickstart. | ||
3. When you are finished testing, type this command to undeploy the archive: | ||
|
||
mvn jboss-as:undeploy | ||
|
||
|
||
Run the Quickstart in JBoss Developer Studio or Eclipse | ||
------------------------------------- | ||
You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.md#useeclipse) | ||
|
||
Debug the Application | ||
------------------------------------ | ||
|
||
If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them. | ||
|
||
mvn dependency:sources | ||
mvn dependency:resolve -Dclassifier=javadoc | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,152 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<!-- JBoss, Home of Professional Open Source | ||
Copyright 2013, Red Hat, Inc. and/or its affiliates, and individual | ||
contributors by the @authors tag. See the copyright.txt in the | ||
distribution for a full listing of individual contributors. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License.--> | ||
<!-- Marker file indicating CDI should be enabled --> | ||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> | ||
|
||
<!-- The pom builds the web WAR artifact. --> | ||
|
||
<modelVersion>4.0.0</modelVersion> | ||
|
||
<groupId>org.jboss.as.quickstarts</groupId> | ||
<artifactId>jboss-as-cdi-decorator</artifactId> | ||
<version>7.1.2-SNAPSHOT</version> | ||
<packaging>war</packaging> | ||
<name>JBoss AS Quickstarts: CDI Decorator</name> | ||
<description>JBoss AS Quickstarts: CDI Decorator</description> | ||
|
||
<url>http://jboss.org/jbossas</url> | ||
<licenses> | ||
<license> | ||
<name>Apache License, Version 2.0</name> | ||
<distribution>repo</distribution> | ||
<url>http://www.apache.org/licenses/LICENSE-2.0.html</url> | ||
</license> | ||
</licenses> | ||
|
||
<properties> | ||
<!-- Explicitly declaring the source encoding eliminates the following | ||
message: --> | ||
<!-- [WARNING] Using platform encoding (UTF-8 actually) to copy filtered | ||
resources, i.e. build is platform dependent! --> | ||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> | ||
|
||
<!-- JBoss dependency versions --> | ||
|
||
<version.jboss.maven.plugin>7.3.Final</version.jboss.maven.plugin> | ||
|
||
<version.jboss.spec.javaee.6.0>3.0.2.Final</version.jboss.spec.javaee.6.0> | ||
<!-- Alternatively, comment out the above line, and un-comment the line | ||
below to use version 3.0.2.Final-redhat-1 which is a release certified to | ||
work with JBoss EAP 6. It requires you have access to the JBoss EAP 6 maven | ||
repository. --> | ||
<!-- <version.jboss.spec.javaee.6.0>3.0.2.Final-redhat-1</version.jboss.spec.javaee.6.0> --> | ||
|
||
<!-- other plugin versions --> | ||
<version.compiler.plugin>2.3.1</version.compiler.plugin> | ||
<version.war.plugin>2.1.1</version.war.plugin> | ||
|
||
<!-- maven-compiler-plugin --> | ||
<maven.compiler.target>1.6</maven.compiler.target> | ||
<maven.compiler.source>1.6</maven.compiler.source> | ||
</properties> | ||
|
||
<dependencyManagement> | ||
<dependencies> | ||
<!-- Define the version of JBoss' Java EE 6 APIs we want to import. Any | ||
dependencies from org.jboss.spec will have their version defined by this | ||
BOM --> | ||
<!-- JBoss distributes a complete set of Java EE 6 APIs including a Bill | ||
of Materials (BOM). A BOM specifies the versions of a "stack" (or a collection) | ||
of artifacts. We use this here so that we always get the correct versions | ||
of artifacts. Here we use the jboss-javaee-6.0 stack (you can read this as | ||
the JBoss stack of the Java EE 6 APIs). You can actually use this stack with | ||
any version of JBoss AS that implements Java EE 6, not just JBoss AS 7! --> | ||
<dependency> | ||
<groupId>org.jboss.spec</groupId> | ||
<artifactId>jboss-javaee-6.0</artifactId> | ||
<version>${version.jboss.spec.javaee.6.0}</version> | ||
<type>pom</type> | ||
<scope>import</scope> | ||
</dependency> | ||
</dependencies> | ||
</dependencyManagement> | ||
|
||
|
||
<dependencies> | ||
|
||
<!-- Import the CDI API, we use provided scope as the API is included in | ||
JBoss AS 7 --> | ||
<dependency> | ||
<groupId>javax.enterprise</groupId> | ||
<artifactId>cdi-api</artifactId> | ||
<scope>provided</scope> | ||
</dependency> | ||
|
||
|
||
<!-- Import the Common Annotations API (JSR-250), we use provided scope | ||
as the API is included in JBoss AS 7 --> | ||
<dependency> | ||
<groupId>org.jboss.spec.javax.annotation</groupId> | ||
<artifactId>jboss-annotations-api_1.1_spec</artifactId> | ||
<scope>provided</scope> | ||
</dependency> | ||
|
||
|
||
<!-- Import the Servlet API, we use provided scope as the API is included | ||
in JBoss AS 7 --> | ||
<dependency> | ||
<groupId>org.jboss.spec.javax.servlet</groupId> | ||
<artifactId>jboss-servlet-api_3.0_spec</artifactId> | ||
<scope>provided</scope> | ||
</dependency> | ||
</dependencies> | ||
|
||
|
||
<build> | ||
<!-- Set the name of the war, used as the context root when the app is | ||
deployed --> | ||
<finalName>${project.artifactId}</finalName> | ||
<plugins> | ||
<plugin> | ||
<artifactId>maven-war-plugin</artifactId> | ||
<version>${version.war.plugin}</version> | ||
<configuration> | ||
<!-- Java EE 6 doesn't require web.xml, Maven needs to catch up! --> | ||
<failOnMissingWebXml>false</failOnMissingWebXml> | ||
</configuration> | ||
</plugin> | ||
<!-- JBoss AS plugin to deploy war --> | ||
<plugin> | ||
<groupId>org.jboss.as.plugins</groupId> | ||
<artifactId>jboss-as-maven-plugin</artifactId> | ||
<version>${version.jboss.maven.plugin}</version> | ||
</plugin> | ||
<!-- Compiler plugin enforces Java 1.6 compatibility and activates annotation | ||
processors --> | ||
<plugin> | ||
<artifactId>maven-compiler-plugin</artifactId> | ||
<version>${version.compiler.plugin}</version> | ||
<configuration> | ||
<source>${maven.compiler.source}</source> | ||
<target>${maven.compiler.target}</target> | ||
</configuration> | ||
</plugin> | ||
</plugins> | ||
</build> | ||
|
||
</project> | ||
|
44 changes: 44 additions & 0 deletions
44
cdi-decorator/src/main/java/org/jboss/as/quickstarts/cdi/decorator/Staff.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
/* | ||
* JBoss, Home of Professional Open Source | ||
* Copyright 2012, Red Hat, Inc. and/or its affiliates, and individual | ||
* contributors by the @authors tag. See the copyright.txt in the | ||
* distribution for a full listing of individual contributors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package org.jboss.as.quickstarts.cdi.decorator; | ||
|
||
/** | ||
* Simple POJO, that can be used by decorator. | ||
* | ||
* @author Ievgen Shulga | ||
*/ | ||
public class Staff { | ||
private String position; | ||
private Integer bonus; | ||
|
||
public String getPosition() { | ||
return position; | ||
} | ||
|
||
public void setPosition(String position) { | ||
this.position = position; | ||
} | ||
|
||
public Integer getBonus() { | ||
return bonus; | ||
} | ||
|
||
public void setBonus(Integer bonus) { | ||
this.bonus = bonus; | ||
} | ||
|
||
} |
44 changes: 44 additions & 0 deletions
44
cdi-decorator/src/main/java/org/jboss/as/quickstarts/cdi/decorator/StaffController.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
/* | ||
* JBoss, Home of Professional Open Source | ||
* Copyright 2012, Red Hat, Inc. and/or its affiliates, and individual | ||
* contributors by the @authors tag. See the copyright.txt in the | ||
* distribution for a full listing of individual contributors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package org.jboss.as.quickstarts.cdi.decorator; | ||
|
||
import javax.inject.Inject; | ||
import javax.inject.Named; | ||
|
||
/** | ||
* Simple JSF backing bean, demonstrating CDI injection. | ||
* | ||
* Bean name overridden to "staff" to be accessible from view with this name. | ||
* | ||
* The {@link Inject} says that it is CDI bean and should be injected. | ||
* | ||
* @author Ievgen Shulga | ||
*/ | ||
@Named(value = "staff") | ||
public class StaffController { | ||
|
||
@Inject | ||
private StaffService staffService; | ||
|
||
public String getPosition() { | ||
return staffService.getStaff().getPosition(); | ||
} | ||
|
||
public Integer getBonus() { | ||
return staffService.getStaff().getBonus(); | ||
} | ||
} |
25 changes: 25 additions & 0 deletions
25
cdi-decorator/src/main/java/org/jboss/as/quickstarts/cdi/decorator/StaffService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
/* | ||
* JBoss, Home of Professional Open Source | ||
* Copyright 2012, Red Hat, Inc. and/or its affiliates, and individual | ||
* contributors by the @authors tag. See the copyright.txt in the | ||
* distribution for a full listing of individual contributors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package org.jboss.as.quickstarts.cdi.decorator; | ||
|
||
public interface StaffService { | ||
|
||
Staff getStaff(); | ||
|
||
void deleteStaff(Staff staff); | ||
|
||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For this example, uncomment the
<decorators>
tag in theWEB-INF/beans.xml
file and redeploy the application. When you access the application, you will see the following in the server log: