1 /*
2 * Copyright (c) 2002-2022, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.workflow.service.provider;
35
36 import fr.paris.lutece.plugins.workflowcore.service.provider.AbstractProviderManager;
37 import org.apache.commons.lang3.StringUtils;
38
39 import fr.paris.lutece.portal.service.spring.SpringContextService;
40 import fr.paris.lutece.portal.service.util.AppLogService;
41
42 /**
43 * This class provides utility methods for {@link AbstractProviderManager} objects
44 *
45 */
46 public final class ProviderManagerUtil
47 {
48 private static final String SEPARATOR = ".@.";
49
50 /**
51 * Private constructor
52 */
53 private ProviderManagerUtil( )
54 {
55
56 }
57
58 /**
59 * Retrieves the {@link AbstractProviderManager} from its id
60 *
61 * @param strProviderManagerId
62 * the id of the {@code AbstractProviderManager}
63 * @return the {@code AbstractProviderManager} object corresponding to the specified id, or {@code null} if no {@code AbstractProviderManager} can be found.
64 */
65 public static AbstractProviderManager fetchProviderManager( String strProviderManagerId )
66 {
67 AbstractProviderManager result = null;
68
69 try
70 {
71 result = SpringContextService.getBean( strProviderManagerId );
72 }
73 catch( Exception e )
74 {
75 AppLogService.error( "Unable to retrieve the provider manager '" + strProviderManagerId + "'" );
76 }
77
78 return result;
79 }
80
81 /**
82 * <p>
83 * Builds the complete id of a provider.
84 * </p>
85 * <p>
86 * The complete id is built from the specified {@code AbstractProviderManager} id and {@code IProvider} id
87 * </p>
88 *
89 * @param strProviderManagerId
90 * the {@code AbstractProviderManager} id
91 * @param strProviderId
92 * the {@code IProvider} id
93 * @return the complete id
94 */
95 public static String buildCompleteProviderId( String strProviderManagerId, String strProviderId )
96 {
97 return strProviderManagerId + SEPARATOR + strProviderId;
98 }
99
100 /**
101 * Retrieves the {@code AbstractProviderManager} id from the complete id of a provider
102 *
103 * @param strCompleteProviderId
104 * the complete id of a provider
105 * @return the {@code AbstractProviderManager} id
106 */
107 public static String fetchProviderManagerId( String strCompleteProviderId )
108 {
109 if ( !StringUtils.isBlank( strCompleteProviderId ) )
110 {
111 return strCompleteProviderId.split( SEPARATOR ) [0];
112 }
113
114 return null;
115 }
116
117 /**
118 * Retrieves the {@code IProvider} id from the complete id of a provider
119 *
120 * @param strCompleteProviderId
121 * the complete id of a provider
122 * @return the {@code IProvider} id
123 */
124 public static String fetchProviderId( String strCompleteProviderId )
125 {
126 String strResult = null;
127
128 if ( !StringUtils.isBlank( strCompleteProviderId ) )
129 {
130 String [ ] listIds = strCompleteProviderId.split( SEPARATOR );
131
132 if ( listIds.length > 1 )
133 {
134 strResult = listIds [1];
135 }
136 }
137
138 return strResult;
139 }
140 }