Repository: deltaspike Updated Branches: refs/heads/master 25b2b8cc0 -> f1c440447
DELTASPIKE-885 Static DeltaSpike configuration should be easy to find in code base Project: http://git-wip-us.apache.org/repos/asf/deltaspike/repo Commit: http://git-wip-us.apache.org/repos/asf/deltaspike/commit/f1c44044 Tree: http://git-wip-us.apache.org/repos/asf/deltaspike/tree/f1c44044 Diff: http://git-wip-us.apache.org/repos/asf/deltaspike/diff/f1c44044 Branch: refs/heads/master Commit: f1c4404476d4cbfbd76c962d41a39f5187f04211 Parents: 25b2b8c Author: Ron Smeral <[email protected]> Authored: Tue May 5 14:19:52 2015 +0200 Committer: Ron Smeral <[email protected]> Committed: Tue May 5 14:41:25 2015 +0200 ---------------------------------------------------------------------- .../core/api/config/DeltaSpikeConfig.java | 21 ++++++++----- .../core/api/config/base/CoreBaseConfig.java | 2 +- .../api/config/base/DeltaSpikeBaseConfig.java | 33 ++++++++++++++++++++ .../jsf/api/config/base/JsfBaseConfig.java | 3 +- .../scheduler/impl/SchedulerBaseConfig.java | 3 +- .../testcontrol/api/junit/TestBaseConfig.java | 3 +- .../impl/jsf/MyFacesTestBaseConfig.java | 3 +- 7 files changed, 56 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/deltaspike/blob/f1c44044/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/DeltaSpikeConfig.java ---------------------------------------------------------------------- diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/DeltaSpikeConfig.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/DeltaSpikeConfig.java index 3b51992..6909ebd 100644 --- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/DeltaSpikeConfig.java +++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/DeltaSpikeConfig.java @@ -21,17 +21,24 @@ package org.apache.deltaspike.core.api.config; import java.io.Serializable; /** - * Marker interface for all classes used for configuration of DeltaSpike itself. + * Marker interface for all classes used for dynamic configuration of DeltaSpike itself. The term <i>Dynamic + * configuration</i> refers to values which can be determined and changed during runtime and shouldn't be accessed + * during container boot time. * * <p> - * All DeltaSpike configuration objects implement this interface so they can be found more easily. There is no other - * functionality implied with this interface.</p> + * All DeltaSpike dynamic configuration objects implement this interface so they can be found more easily. There is no + * other functionality implied with this interface.</p> * * <p> - * DeltaSpike uses a <i>type-safe configuration</i> approach. Instead of writing a properties file or XML, you just - * implement one of the configuration interfaces which will then be picked up as a CDI bean. If there is already a - * default configuration for some functionality in DeltaSpike, you can use @Specializes or @Alternative to - * change those.</p> + * DeltaSpike uses a <i>type-safe configuration</i> approach for most internal configuration. Instead of writing a + * properties file or XML, you just implement one of the configuration interfaces which will then be picked up as a + * CDI bean. If* there is already a default configuration for some functionality in DeltaSpike, you can use @ + * Specializes or @Alternative to change those.</p> + * + * <p> + * See {@link org.apache.deltaspike.core.api.config.base.DeltaSpikeBaseConfig} for static DeltaSpike configuration + * based on properties.</p> + * */ public interface DeltaSpikeConfig extends Serializable { http://git-wip-us.apache.org/repos/asf/deltaspike/blob/f1c44044/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/base/CoreBaseConfig.java ---------------------------------------------------------------------- diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/base/CoreBaseConfig.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/base/CoreBaseConfig.java index ff0600d..1074679 100644 --- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/base/CoreBaseConfig.java +++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/base/CoreBaseConfig.java @@ -20,7 +20,7 @@ package org.apache.deltaspike.core.api.config.base; import org.apache.deltaspike.core.api.config.ConfigResolver; -public interface CoreBaseConfig +public interface CoreBaseConfig extends DeltaSpikeBaseConfig { interface BeanManagerDelegation { http://git-wip-us.apache.org/repos/asf/deltaspike/blob/f1c44044/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/base/DeltaSpikeBaseConfig.java ---------------------------------------------------------------------- diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/base/DeltaSpikeBaseConfig.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/base/DeltaSpikeBaseConfig.java new file mode 100644 index 0000000..bc1b674 --- /dev/null +++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/config/base/DeltaSpikeBaseConfig.java @@ -0,0 +1,33 @@ +/* + * 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 org.apache.deltaspike.core.api.config.base; + +/** + * Marker interface for all classes used for static configuration of DeltaSpike itself. The term <i>Static + * configuration</i> refers to values which are set using DeltaSpike's configuration mechanism (e.g. in {@code + * META-INF/apache-deltaspike.properties}) and remain fixed during runtime and can be accessed even during container + * boot time. + * + * <p> + * All DeltaSpike static configuration objects implement this interface so they can be found more easily. There is no + * other functionality implied with this interface.</p> + */ +public interface DeltaSpikeBaseConfig +{ +} http://git-wip-us.apache.org/repos/asf/deltaspike/blob/f1c44044/deltaspike/modules/jsf/api/src/main/java/org/apache/deltaspike/jsf/api/config/base/JsfBaseConfig.java ---------------------------------------------------------------------- diff --git a/deltaspike/modules/jsf/api/src/main/java/org/apache/deltaspike/jsf/api/config/base/JsfBaseConfig.java b/deltaspike/modules/jsf/api/src/main/java/org/apache/deltaspike/jsf/api/config/base/JsfBaseConfig.java index 7c10391..deb23c3 100644 --- a/deltaspike/modules/jsf/api/src/main/java/org/apache/deltaspike/jsf/api/config/base/JsfBaseConfig.java +++ b/deltaspike/modules/jsf/api/src/main/java/org/apache/deltaspike/jsf/api/config/base/JsfBaseConfig.java @@ -19,11 +19,12 @@ package org.apache.deltaspike.jsf.api.config.base; import org.apache.deltaspike.core.api.config.ConfigResolver; +import org.apache.deltaspike.core.api.config.base.DeltaSpikeBaseConfig; import org.apache.deltaspike.core.api.config.base.CoreBaseConfig; import org.apache.deltaspike.jsf.api.config.view.Folder; import org.apache.deltaspike.jsf.api.config.view.View; -public interface JsfBaseConfig +public interface JsfBaseConfig extends DeltaSpikeBaseConfig { interface ViewConfig { http://git-wip-us.apache.org/repos/asf/deltaspike/blob/f1c44044/deltaspike/modules/scheduler/impl/src/main/java/org/apache/deltaspike/scheduler/impl/SchedulerBaseConfig.java ---------------------------------------------------------------------- diff --git a/deltaspike/modules/scheduler/impl/src/main/java/org/apache/deltaspike/scheduler/impl/SchedulerBaseConfig.java b/deltaspike/modules/scheduler/impl/src/main/java/org/apache/deltaspike/scheduler/impl/SchedulerBaseConfig.java index c406ae9..0dbc7a0 100644 --- a/deltaspike/modules/scheduler/impl/src/main/java/org/apache/deltaspike/scheduler/impl/SchedulerBaseConfig.java +++ b/deltaspike/modules/scheduler/impl/src/main/java/org/apache/deltaspike/scheduler/impl/SchedulerBaseConfig.java @@ -19,9 +19,10 @@ package org.apache.deltaspike.scheduler.impl; import org.apache.deltaspike.core.api.config.ConfigResolver; +import org.apache.deltaspike.core.api.config.base.DeltaSpikeBaseConfig; //keep it in the impl. module for now, because it's mainly quartz specific config -public interface SchedulerBaseConfig +public interface SchedulerBaseConfig extends DeltaSpikeBaseConfig { interface JobCustomization { http://git-wip-us.apache.org/repos/asf/deltaspike/blob/f1c44044/deltaspike/modules/test-control/api/src/main/java/org/apache/deltaspike/testcontrol/api/junit/TestBaseConfig.java ---------------------------------------------------------------------- diff --git a/deltaspike/modules/test-control/api/src/main/java/org/apache/deltaspike/testcontrol/api/junit/TestBaseConfig.java b/deltaspike/modules/test-control/api/src/main/java/org/apache/deltaspike/testcontrol/api/junit/TestBaseConfig.java index 217649d..7c1c70f 100644 --- a/deltaspike/modules/test-control/api/src/main/java/org/apache/deltaspike/testcontrol/api/junit/TestBaseConfig.java +++ b/deltaspike/modules/test-control/api/src/main/java/org/apache/deltaspike/testcontrol/api/junit/TestBaseConfig.java @@ -19,8 +19,9 @@ package org.apache.deltaspike.testcontrol.api.junit; import org.apache.deltaspike.core.api.config.ConfigResolver; +import org.apache.deltaspike.core.api.config.base.DeltaSpikeBaseConfig; -public interface TestBaseConfig +public interface TestBaseConfig extends DeltaSpikeBaseConfig { interface ContainerIntegration { http://git-wip-us.apache.org/repos/asf/deltaspike/blob/f1c44044/deltaspike/modules/test-control/impl/src/main/java/org/apache/deltaspike/testcontrol/impl/jsf/MyFacesTestBaseConfig.java ---------------------------------------------------------------------- diff --git a/deltaspike/modules/test-control/impl/src/main/java/org/apache/deltaspike/testcontrol/impl/jsf/MyFacesTestBaseConfig.java b/deltaspike/modules/test-control/impl/src/main/java/org/apache/deltaspike/testcontrol/impl/jsf/MyFacesTestBaseConfig.java index 94a06b5..92a6b19 100644 --- a/deltaspike/modules/test-control/impl/src/main/java/org/apache/deltaspike/testcontrol/impl/jsf/MyFacesTestBaseConfig.java +++ b/deltaspike/modules/test-control/impl/src/main/java/org/apache/deltaspike/testcontrol/impl/jsf/MyFacesTestBaseConfig.java @@ -19,8 +19,9 @@ package org.apache.deltaspike.testcontrol.impl.jsf; import org.apache.deltaspike.core.api.config.ConfigResolver; +import org.apache.deltaspike.core.api.config.base.DeltaSpikeBaseConfig; -public interface MyFacesTestBaseConfig +public interface MyFacesTestBaseConfig extends DeltaSpikeBaseConfig { String WEBAPP_RESOURCE_PATH = ConfigResolver.resolve("deltaspike.testcontrol.mf.test.webapp_resource_path") .as(String.class)
