View Javadoc

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.sandbox.mail;
17  
18  import org.hibernate.validator.constraints.NotBlank;
19  
20  import de.smartics.properties.api.core.annotations.PropertyExpression;
21  import de.smartics.properties.api.core.annotations.PropertySet;
22  import de.smartics.properties.api.core.annotations.PropertyValueSecured;
23  
24  /**
25   * Mail Server Properties.
26   */
27  @PropertySet("mail.server")
28  public interface MailServerProperties
29  {
30    /**
31     * The URL to the mail server.
32     *
33     * @return the mail server URL.
34     */
35    @NotBlank
36    String url();
37  
38    /**
39     * The password to authenticate on the mail server.
40     *
41     * @return the password to authenticate on the mail server.
42     */
43    @PropertyValueSecured
44    String password();
45  
46    /**
47     * The URL to the GUI of the mail server.
48     * <p>
49     * If not given, the URL will simply not be displayed to the user.
50     * </p>
51     *
52     * @return the URL to the GUI of the mail server.
53     */
54    @PropertyExpression("${mail.server.url}/index.html")
55    String gui();
56  }