Skip to content

Commit

Permalink
#30 Change project name to Jakarta Interceptors
Browse files Browse the repository at this point in the history
Signed-off-by: arjantijms <arjan.tijms@gmail.com>
  • Loading branch information
arjantijms committed Jul 12, 2019
1 parent 5ad60bd commit c89b4c1
Show file tree
Hide file tree
Showing 13 changed files with 64 additions and 24 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Jakarta Interceptors

This repository contains the code for Jakarta Interceptors.

[Online JavaDoc](https://javadoc.io/doc/jakarta.interceptor/jakarta.interceptor-api/)

Building
--------

Jakarta Interceptors can be built by executing the following from the project root:

``mvn clean package``

The API jar can then be found in /api/target.

Making Changes
--------------

To make changes, fork this repository, make your changes, and submit a pull request.

About Jakarta Interceptors
-------------

Jakarta Interceptors defines a means of interposing on business method invocations
and specific events—such as lifecycle events and timeout events—that occur on instances
of Jakarta EE components and other managed classes.
19 changes: 14 additions & 5 deletions api/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,12 @@
<groupId>jakarta.interceptor</groupId>
<artifactId>jakarta.interceptor-api</artifactId>

<name>${extension.name} API</name>
<description>Eclipse Interceptors</description>

<name>Jakarta Interceptors</name>
<description>
Jakarta Interceptors defines a means of interposing on business method invocations
and specific events—such as lifecycle events and timeout events—that occur on instances
of Jakarta EE components and other managed classes.
</description>
<url>https://github.com/eclipse-ee4j/interceptor-api</url>

<properties>
Expand Down Expand Up @@ -115,6 +118,7 @@
</resources>

<plugins>
<!-- Restricts the Java version to 1.8 -->
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.0</version>
Expand All @@ -125,6 +129,7 @@
</configuration>
</plugin>

<!-- First sets properties for the maven-bundle-plugin and later checks if they are indeed used. -->
<plugin>
<groupId>org.glassfish.build</groupId>
<artifactId>spec-version-maven-plugin</artifactId>
Expand All @@ -149,6 +154,7 @@
</executions>
</plugin>

<!-- Creates the OSGi MANIFEST.MF file -->
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
Expand All @@ -164,7 +170,7 @@
<Implementation-Version>${spec.implementation.version}</Implementation-Version>
<Specification-Version>${spec.specification.version}</Specification-Version>
<Bundle-Description>
Java(TM) Interceptor ${spec.version} API Design Specification
Jakarta Interceptors ${spec.version} Specification
</Bundle-Description>
<Specification-Vendor>Oracle Corporation</Specification-Vendor>
<Implementation-Vendor>${project.organization.name}</Implementation-Vendor>
Expand All @@ -182,6 +188,7 @@
</executions>
</plugin>

<!-- Adds the manifest file created by the org.apache.felix:maven-bundle-plugin -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
Expand All @@ -196,6 +203,7 @@
</configuration>
</plugin>

<!-- Creates the source jar -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
Expand All @@ -213,6 +221,7 @@
</executions>
</plugin>

<!-- Creates the javadoc jar -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
Expand Down Expand Up @@ -242,7 +251,7 @@
<configuration>
<groups>
<group>
<title>Interceptor API Documentation</title>
<title>Jakarta Interceptors API Documentation</title>
<packages>javax.interceptor</packages>
</group>
</groups>
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/javax/interceptor/AroundConstruct.java
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
* which they are interposing.
* </p>
*
* @since Interceptors 1.2
* @since Jakarta Interceptors 1.2
*/
@Target(METHOD)
@Retention(RUNTIME)
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/javax/interceptor/AroundInvoke.java
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
* {@link javax.interceptor.InvocationContext#proceed()}.
* </p>
*
* @since Interceptors 1.0
* @since Jakarta Interceptors 1.0
*/
@Target(METHOD)
@Retention(RUNTIME)
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/javax/interceptor/AroundTimeout.java
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
* {@link javax.interceptor.InvocationContext#proceed()}.
* </p>
*
* @since Interceptors 1.1
* @since Jakarta Interceptors 1.1
*/
@Target(METHOD)
@Retention(RUNTIME)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
*
* @see javax.interceptor.ExcludeDefaultInterceptors
*
* @since Interceptors 1.0
* @since Jakarta Interceptors 1.0
*/
@Target({ METHOD, CONSTRUCTOR })
@Retention(RUNTIME)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
* public void updateOrder(Order order) { ... }
* </pre>
*
* @since Interceptors 1.0
* @since Jakarta Interceptors 1.0
*/
@Target({ TYPE, METHOD, CONSTRUCTOR })
@Retention(RUNTIME)
Expand Down
7 changes: 4 additions & 3 deletions api/src/main/java/javax/interceptor/Interceptor.java
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@
* <p>
* Use of this annotation is required when declaring an interceptor using interceptor binding annotations. It is ignored
* during the processing of classes bound using the {@link javax.interceptor.Interceptors Interceptors} annotation (or
* when the EJB deployment descriptor is used to associate the interceptor with the target class).
* when the Jakarta Enterprise Beans deployment descriptor is used to associate the interceptor with the target class).
* </p>
*
* @see javax.interceptor.Interceptors
*
* @since Interceptors 1.1
* @since Jakarta Interceptors 1.1
*/
@Retention(RUNTIME)
@Target(TYPE)
Expand Down Expand Up @@ -96,7 +96,8 @@
* interceptors bound to a target using the {@link javax.interceptor.Interceptors Interceptors} annotation.
*
* @see javax.annotation.Priority
* @since Interceptors 1.2
*
* @since Jakarta Interceptors 1.2
*/
public static class Priority {
private Priority() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
*
* @see javax.interceptor.Interceptor
*
* @since Interceptors 1.1
* @since Jakarta Interceptors 1.1
*/
@Target(ANNOTATION_TYPE)
@Retention(RUNTIME)
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/javax/interceptor/Interceptors.java
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
* @see javax.interceptor.ExcludeClassInterceptors
* @see javax.interceptor.ExcludeDefaultInterceptors
*
* @since Interceptors 1.0
* @since Jakarta Interceptors 1.0
*/
@Target({ TYPE, METHOD, CONSTRUCTOR })
@Retention(RUNTIME)
Expand Down
8 changes: 4 additions & 4 deletions api/src/main/java/javax/interceptor/InvocationContext.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
*
* </pre>
*
* @since Interceptors 1.0
* @since Jakarta Interceptors 1.0
*/
public interface InvocationContext {

Expand All @@ -59,12 +59,12 @@ public interface InvocationContext {

/**
* Returns the timer object associated with a timeout method invocation on the target class, or a null value for
* interceptor method types other than {@link AroundTimeout}. For example, when associated with an EJB component
* timeout, this method returns {@link javax.ejb.Timer}.
* interceptor method types other than {@link AroundTimeout}. For example, when associated with an Jakarta Enterprise
* Beans component timeout, this method returns {@link javax.ejb.Timer}.
*
* @return the timer object or a null value
*
* @since Interceptors 1.1
* @since Jakarta Interceptors 1.1
*/
Object getTimer();

Expand Down
6 changes: 3 additions & 3 deletions api/src/main/java/javax/interceptor/package.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ <h3>Interceptor methods</h3>
<p> An {@link javax.interceptor.AroundConstruct} interceptor method may
be defined only in an interceptor class or superclass of an interceptor class.</p>

<p> The Interceptors specification defines the interceptor method types listed
below. Extension specifications may define additional interceptor method types.</p>
<p> The Jakarta Interceptors specification defines the interceptor method types listed
below. Extension specifications may define additional interceptor method types.</p>

<ul>
<li> {@link javax.interceptor.AroundInvoke} interceptor methods,
Expand Down Expand Up @@ -143,7 +143,7 @@ <h3>Interceptor lifecycle</h3>

<p>An interceptor class shares the enterprise naming context of its associated target
class. Annotations and/or XML deployment descriptor elements for dependency injection or
for direct JNDI lookup refer to this shared naming context.</p>
for direct Naming and Directory Interface lookup refer to this shared naming context.</p>

<p>An interceptor instance may hold state. An interceptor instance may be the target
of dependency injection. Dependency injection is performed when the interceptor instance
Expand Down
8 changes: 6 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,12 @@
<version>1.2.4-SNAPSHOT</version>
<packaging>pom</packaging>

<name>${extension.name} API - Parent</name>
<description>Eclipse Interceptors</description>
<name>Jakarta Interceptors - Parent</name>
<description>
Jakarta Interceptors defines a means of interposing on business method invocations
and specific events—such as lifecycle events and timeout events—that occur on instances
of Jakarta EE components and other managed classes.
</description>
<url>https://github.com/eclipse-ee4j/interceptor-api</url>

<scm>
Expand Down

0 comments on commit c89b4c1

Please sign in to comment.