View Javadoc
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.caconfig.annotation.Configuration;
23  import org.apache.sling.caconfig.annotation.Property;
24  
25  /**
26   * Context-Aware URL Handler Site configuration.
27   */
28  @Configuration(label = "wcm.io Handler Site URLs",
29      description = "Defines Site URLs for Author and Publish environments.")
30  public @interface SiteConfig {
31  
32    /**
33     * Gets the site URL.
34     * @return Site URL
35     */
36    @Property(label = "Site URL",
37        description = "Public website URL for non-secure access. Add placeholder '<auto>' to enable auto-detection from request.")
38    String siteUrl();
39  
40    /**
41     * Gets the secure site URL.
42     * @return Site URL Secure
43     */
44    @Property(label = "Site URL Secure",
45        description = "Public website URL for secure access. Add placeholder '<auto>' to enable auto-detection from request.")
46    String siteUrlSecure();
47  
48    /**
49     * Gets the author URL.
50     * @return Author URL
51     */
52    @Property(label = "Author URL",
53        description = "URL for author instance. Add placeholder '<auto>' to enable auto-detection from request.")
54    String siteUrlAuthor();
55  
56  }