1 /* 2 * #%L 3 * wcm.io 4 * %% 5 * Copyright (C) 2014 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.suffix; 21 22 import java.util.List; 23 24 import org.apache.sling.api.SlingHttpServletRequest; 25 import org.jetbrains.annotations.NotNull; 26 import org.osgi.annotation.versioning.ConsumerType; 27 28 /** 29 * Interface for strategies that decide which parts from the current request's suffix should be kept when constructing 30 * new links with the {@link SuffixBuilder} 31 */ 32 @ConsumerType 33 public interface SuffixStateKeepingStrategy { 34 35 /** 36 * Implement this method to return those suffix parts that should be kept at the beginning of the suffix to construct 37 * to keep the page's state 38 * @param request Current request 39 * @return a list of suffix parts 40 */ 41 @NotNull 42 List<String> getSuffixPartsToKeep(@NotNull SlingHttpServletRequest request); 43 44 }