1 /*
2 * #%L
3 * wcm.io
4 * %%
5 * Copyright (C) 2019 wcm.io
6 * %%
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * #L%
19 */
20 package io.wcm.wcm.ui.granite.util;
21
22 import org.apache.sling.api.SlingHttpServletRequest;
23 import org.jetbrains.annotations.NotNull;
24 import org.jetbrains.annotations.Nullable;
25 import org.osgi.annotation.versioning.ConsumerType;
26
27 import com.adobe.granite.ui.components.ComponentHelper;
28
29 /**
30 * Interface that can be implemented to provide custom logic to detect a root path
31 * from current context if there was no explicit root path configured for the GraniteUI component.
32 */
33 @ConsumerType
34 public interface RootPathDetector {
35
36 /**
37 * Detect root path from context of GraniteUI component.
38 * @param cmp Granite UI Component Helper
39 * @param request Request
40 * @return Root path or null
41 */
42 @Nullable
43 String detectRootPath(@NotNull ComponentHelper cmp, @NotNull SlingHttpServletRequest request);
44
45 }