1 /*
2 * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package de.smartics.properties.tutorial.property;
17
18 import java.net.URL;
19
20 import de.smartics.properties.api.core.annotations.PropertySet;
21 import de.smartics.properties.api.core.domain.PropertyDescriptor;
22
23 /**
24 * A sample property set for the {@link PropertyTutorial}.
25 */
26 @PropertySet(value = "tutorial.property")
27 public interface ApplicationProperties
28 {
29 /**
30 * Returns the name of the host. This name is used to construct URLs by adding
31 * a protocol, an optional port and request path. It is allowed to set an IP
32 * address as specified in <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC
33 * 2396</a>.
34 *
35 * @return the name of the host.
36 */
37 String host();
38
39 /**
40 * Returns the property descriptor for the {@link host #host()} property.
41 *
42 * @return the property descriptor for the {@link host #host()} property.
43 */
44 PropertyDescriptor hostPropertyDescriptor();
45
46 /**
47 * Returns a server URL.
48 *
49 * @return a server URL.
50 */
51 URL serverUrl();
52 }