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.integrator;
21
22 import org.jetbrains.annotations.NotNull;
23 import org.osgi.annotation.versioning.ProviderType;
24
25 /**
26 * How an integrator template sohuld behave when externalizing URLs.
27 */
28 @ProviderType
29 public interface IntegratorMode {
30
31 /**
32 * @return Integrator mode ID (is stored as identifier in repository)
33 */
34 @NotNull
35 String getId();
36
37 /**
38 * @return true if placeholders should be used for externalizing URLs instead of site urls
39 */
40 boolean isUseUrlPlaceholders();
41
42 /**
43 * @return true if the prototcol to be used for externalizing URLs in integrator mode is detected automatically
44 * or defined in the integrator page itself.
45 */
46 boolean isDetectProtocol();
47
48 }