You are viewing a plain text version of this content. The canonical link for it is here.
Posted to scm@geronimo.apache.org by st...@apache.org on 2017/05/29 16:14:46 UTC
svn commit: r1796659 - in
/geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control:
./ ActivateRequestContext.java RequestContextController.java
Author: struberg
Date: Mon May 29 16:14:46 2017
New Revision: 1796659
URL: http://svn.apache.org/viewvc?rev=1796659&view=rev
Log:
GERONIMO-6553 add ReqeustContext Control
Contributed by John Ament (johndament) - txs for the patch!
Added:
geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/
geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/ActivateRequestContext.java (with props)
geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/RequestContextController.java (with props)
Added: geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/ActivateRequestContext.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/ActivateRequestContext.java?rev=1796659&view=auto
==============================================================================
--- geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/ActivateRequestContext.java (added)
+++ geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/ActivateRequestContext.java Mon May 29 16:14:46 2017
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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 javax.enterprise.context.control;
+
+
+import javax.interceptor.InterceptorBinding;
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+/**
+ * The container provides a built in interceptor that may be used to annotate classes and methods to indicate
+ * that a request context should be activated when this method is invoked.
+ *
+ * The request context will be activated before the method is called, and deactivated when the method invocation is
+ * complete (regardless of any exceptions being thrown). If the context is already active, it is ignored, neither
+ * activated nor deactivated.
+ *
+ */
+@InterceptorBinding
+@Target({METHOD, TYPE})
+@Retention(RUNTIME)
+@Documented
+public @interface ActivateRequestContext
+{
+}
\ No newline at end of file
Propchange: geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/ActivateRequestContext.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/RequestContextController.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/RequestContextController.java?rev=1796659&view=auto
==============================================================================
--- geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/RequestContextController.java (added)
+++ geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/RequestContextController.java Mon May 29 16:14:46 2017
@@ -0,0 +1,66 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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 javax.enterprise.context.control;
+
+import javax.enterprise.context.ContextNotActiveException;
+
+/**
+ * The CDI container provides a built in instance of RequestContextController that is dependent scoped for the purposes
+ * of activating and deactivating. For example:
+ *
+ * <pre>
+ * @Inject
+ * private RequestContextController requestContextController;
+ *
+ * public void doRequest(String body) {
+ * // activate request context
+ * requestContextController.activate();
+ *
+ * // do work in a request context.
+ *
+ * // deactivate the request context
+ * requestContextController.deactivate();
+ * }
+ * </pre>
+ *
+ * Once the request context has been deactivated, you may activate it once again, creating a brand new request context.
+ * The activated request context is bound to the current thread, any injection points targeting a request scoped bean
+ * will be satisfied with the same request scoped objects.
+ *
+ */
+public interface RequestContextController
+{
+ /**
+ * Activates a RequestContext for the current thread if one is not already active.
+ * @return true if the context was activated by this invocation, false if not.
+ */
+ boolean activate();
+
+ /**
+ * Deactivates the current Request Context if it was activated by this context controller. If the context is active
+ * but was not activated by this controller, then it may not be deactivated by this controller,
+ * meaning this method will do nothing.
+ *
+ * If the context is not active, a {@see ContextNotActiveException} is thrown.
+ *
+ * @throws ContextNotActiveException if the context is not active
+ */
+ void deactivate() throws ContextNotActiveException;
+}
\ No newline at end of file
Propchange: geronimo/specs/trunk/geronimo-jcdi_2.0_spec/src/main/java/javax/enterprise/context/control/RequestContextController.java
------------------------------------------------------------------------------
svn:eol-style = native