1 /*
2 * #%L
3 * wcm.io
4 * %%
5 * Copyright (C) 2017 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.handler.url;
21
22 import org.apache.sling.api.resource.Resource;
23 import org.jetbrains.annotations.Nullable;
24 import org.osgi.annotation.versioning.ProviderType;
25
26 /**
27 * Detects the site root based on Context-Aware configuration context paths.
28 */
29 @ProviderType
30 public interface SiteRootDetector {
31
32 /**
33 * Returns the absolute path level where the root page of the site is located.
34 * This is the context path of the "inner-most" context-aware configuration context.
35 * @param contextResource Context resource that is assumed to be inside the site context.
36 * @return Root level or -1 if it could not be detected
37 */
38 int getSiteRootLevel(@Nullable Resource contextResource);
39
40 }