[java-identity-provider] branch master updated: IDP-999 Deprecate methods

[Rod Widdowson]

This is an automated email from the git hooks/post-receive script.

rdw pushed a commit to branch master
in repository java-identity-provider.

View the commit online:
http://git.shibboleth.net/view/?p=java-identity-provider.git;a=commit;h=ef8f345e074b00bfcc8ce447593d1f502b7f4005

The following commit(s) were added to refs/heads/master by this push:
       new  ef8f345   IDP-999 Deprecate methods
ef8f345 is described below

commit ef8f345e074b00bfcc8ce447593d1f502b7f4005
Author: Rod Widdowson <rdw at steadingsoftware.com>
AuthorDate: Thu Sep 6 13:45:17 2018 +0100

    IDP-999 Deprecate methods
    
    https://issues.shibboleth.net/jira/browse/IDP-999
    
    No replacement are available in this release since the code cannot
    handle both options.
---
 .../spring/IdPPropertiesApplicationContextInitializer.java  | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/idp-core/src/main/java/net/shibboleth/idp/spring/IdPPropertiesApplicationContextInitializer.java b/idp-core/src/main/java/net/shibboleth/idp/spring/IdPPropertiesApplicationContextInitializer.java
index 21b1e00..6ca88cf 100644
--- a/idp-core/src/main/java/net/shibboleth/idp/spring/IdPPropertiesApplicationContextInitializer.java
+++ b/idp-core/src/main/java/net/shibboleth/idp/spring/IdPPropertiesApplicationContextInitializer.java
@@ -69,8 +69,11 @@ public class IdPPropertiesApplicationContextInitializer
     /** Target resource to be searched for. */
     @Nonnull public static final String IDP_PROPERTIES = "/conf/idp.properties";
 
+    /** Well known search location. */
+    @Nonnull public static final String SEARCH_LOCATION = "/opt/shibboleth-idp";
+
     /** Well known search locations. */
-    @Nonnull public static final String[] SEARCH_LOCATIONS = {"/opt/shibboleth-idp",};
+    @Nonnull @Deprecated public static final String[] SEARCH_LOCATIONS = {SEARCH_LOCATION,};
     
     /** Property controlling whether to fail fast. */
     @Nonnull public static final String FAILFAST_PROPERTY = "idp.initializer.failFast";
@@ -152,9 +155,10 @@ public class IdPPropertiesApplicationContextInitializer
     /**
      * Get the well known search locations. Defaults to {@link #SEARCH_LOCATIONS}.
      * 
+     * @deprecated In a future version a similar method will return one value
      * @return the well known search locations
      */
-    @Nonnull public String[] getSearchLocations() {
+    @Nonnull @Deprecated public String[] getSearchLocations() {
         return SEARCH_LOCATIONS;
     }
 
@@ -163,12 +167,15 @@ public class IdPPropertiesApplicationContextInitializer
      * {@link #IDP_HOME_PROPERTY} in the application context. Defaults to the well-known search locations returned from
      * {@link #getSearchLocations()}.
      * 
+     * @deprecated in future versions there will only be one location returned.  This method is not available yet since
+     * the code cannot coexist with the legacy.  See IDP-999 and IDP-991
      * @param applicationContext the application context
      * @return the search locations used to search for the target
      * @throws ConstraintViolationException if the user-defined search location is empty or ends with '/' and
      *             {@link #isFailFast(ConfigurableApplicationContext)} is true
      */
-    @Nonnull public String[] selectSearchLocations(@Nonnull final ConfigurableApplicationContext applicationContext) {
+    @Nonnull @Deprecated public String[] selectSearchLocations(@Nonnull final ConfigurableApplicationContext applicationContext) {
+
         Constraint.isNotNull(applicationContext, "Application context cannot be null");
         final String homeProperty = applicationContext.getEnvironment().getProperty(IDP_HOME_PROPERTY);
         if (homeProperty != null && isFailFast(applicationContext)) {

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.